feratel-check-api-client 1.0.0

data/docs/CheckResourcesApi.md

@@ -0,0 +1,545 @@
+# FeratelCheckApiClient::CheckResourcesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_tenant_id_secure_checkpoints_check_point_id_check_get**](CheckResourcesApi.md#v1_tenant_id_secure_checkpoints_check_point_id_check_get) | **GET** /v1/{tenantId}/secure/checkpoints/{checkPointId}/check | check |
+| [**v1_tenant_id_secure_checkpoints_check_point_id_check_post**](CheckResourcesApi.md#v1_tenant_id_secure_checkpoints_check_point_id_check_post) | **POST** /v1/{tenantId}/secure/checkpoints/{checkPointId}/check | check and transaction |
+| [**v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get**](CheckResourcesApi.md#v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get) | **GET** /v1/{tenantId}/secure/checkpoints/{checkPointId}/check/{serviceTypeId} | check based on service |
+| [**v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post**](CheckResourcesApi.md#v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post) | **POST** /v1/{tenantId}/secure/checkpoints/{checkPointId}/check/{serviceTypeId} | check based on service and transaction |
+| [**v1_tenant_id_secure_checkpoints_check_point_id_get**](CheckResourcesApi.md#v1_tenant_id_secure_checkpoints_check_point_id_get) | **GET** /v1/{tenantId}/secure/checkpoints/{checkPointId} | checkpoint details |
+| [**v1_tenant_id_secure_checkpoints_check_point_id_history_get**](CheckResourcesApi.md#v1_tenant_id_secure_checkpoints_check_point_id_history_get) | **GET** /v1/{tenantId}/secure/checkpoints/{checkPointId}/history | transaction history |
+| [**v1_tenant_id_secure_checkpoints_get**](CheckResourcesApi.md#v1_tenant_id_secure_checkpoints_get) | **GET** /v1/{tenantId}/secure/checkpoints | list of checkpoints |
+
+
+## v1_tenant_id_secure_checkpoints_check_point_id_check_get
+
+> <CheckResult> v1_tenant_id_secure_checkpoints_check_point_id_check_get(tenant_id, check_point_id, opts)
+
+check
+
+Check, if an identification is permitted at the time of the request or not.<br>The HTTP method GET performs a check only - no transaction will be written.
+
+### Examples
+
+```ruby
+require 'time'
+require 'feratel-check-api-client'
+# setup authorization
+FeratelCheckApiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FeratelCheckApiClient::CheckResourcesApi.new
+tenant_id = 'tenant_id_example' # String | Code of target tenant
+check_point_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of CheckPoint
+opts = {
+  identifier: 'identifier_example' # String | The Identifier is part of the customer's QR-code / barcode.<br>After scanning this code, provide the complete code-content without trimming!
+}
+
+begin
+  # check
+  result = api_instance.v1_tenant_id_secure_checkpoints_check_point_id_check_get(tenant_id, check_point_id, opts)
+  p result
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_check_point_id_check_get: #{e}"
+end
+```
+
+#### Using the v1_tenant_id_secure_checkpoints_check_point_id_check_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckResult>, Integer, Hash)> v1_tenant_id_secure_checkpoints_check_point_id_check_get_with_http_info(tenant_id, check_point_id, opts)
+
+```ruby
+begin
+  # check
+  data, status_code, headers = api_instance.v1_tenant_id_secure_checkpoints_check_point_id_check_get_with_http_info(tenant_id, check_point_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckResult>
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_check_point_id_check_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant_id** | **String** | Code of target tenant |  |
+| **check_point_id** | **String** | ID of CheckPoint |  |
+| **identifier** | **String** | The Identifier is part of the customer&#39;s QR-code / barcode.&lt;br&gt;After scanning this code, provide the complete code-content without trimming! | [optional] |
+
+### Return type
+
+[**CheckResult**](CheckResult.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_tenant_id_secure_checkpoints_check_point_id_check_post
+
+> <TransactResult> v1_tenant_id_secure_checkpoints_check_point_id_check_post(tenant_id, check_point_id, opts)
+
+check and transaction
+
+Check, if an identification is permitted at the time of the request or not.<br>The HTTP method POST performs a check with a persistent transaction.
+
+### Examples
+
+```ruby
+require 'time'
+require 'feratel-check-api-client'
+# setup authorization
+FeratelCheckApiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FeratelCheckApiClient::CheckResourcesApi.new
+tenant_id = 'tenant_id_example' # String | Code of target tenant
+check_point_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of CheckPoint
+opts = {
+  identifier: 'identifier_example' # String | The Identifier is part of the customer's QR-code / barcode.<br>After scanning this code, provide the complete code-content without trimming!
+}
+
+begin
+  # check and transaction
+  result = api_instance.v1_tenant_id_secure_checkpoints_check_point_id_check_post(tenant_id, check_point_id, opts)
+  p result
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_check_point_id_check_post: #{e}"
+end
+```
+
+#### Using the v1_tenant_id_secure_checkpoints_check_point_id_check_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactResult>, Integer, Hash)> v1_tenant_id_secure_checkpoints_check_point_id_check_post_with_http_info(tenant_id, check_point_id, opts)
+
+```ruby
+begin
+  # check and transaction
+  data, status_code, headers = api_instance.v1_tenant_id_secure_checkpoints_check_point_id_check_post_with_http_info(tenant_id, check_point_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactResult>
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_check_point_id_check_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant_id** | **String** | Code of target tenant |  |
+| **check_point_id** | **String** | ID of CheckPoint |  |
+| **identifier** | **String** | The Identifier is part of the customer&#39;s QR-code / barcode.&lt;br&gt;After scanning this code, provide the complete code-content without trimming! | [optional] |
+
+### Return type
+
+[**TransactResult**](TransactResult.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get
+
+> <CheckResult> v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get(tenant_id, check_point_id, service_type_id, opts)
+
+check based on service
+
+Check, if an identification is permitted for a specific serviceType at the time of the request or not.<br>The HTTP method GET performs a check only - no transaction will be written.
+
+### Examples
+
+```ruby
+require 'time'
+require 'feratel-check-api-client'
+# setup authorization
+FeratelCheckApiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FeratelCheckApiClient::CheckResourcesApi.new
+tenant_id = 'tenant_id_example' # String | Code of target tenant
+check_point_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of CheckPoint
+service_type_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of Service
+opts = {
+  identifier: 'identifier_example' # String | The Identifier is part of the customer's QR-code / barcode.<br>After scanning this code, provide the complete code-content without trimming!
+}
+
+begin
+  # check based on service
+  result = api_instance.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get(tenant_id, check_point_id, service_type_id, opts)
+  p result
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get: #{e}"
+end
+```
+
+#### Using the v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckResult>, Integer, Hash)> v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get_with_http_info(tenant_id, check_point_id, service_type_id, opts)
+
+```ruby
+begin
+  # check based on service
+  data, status_code, headers = api_instance.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get_with_http_info(tenant_id, check_point_id, service_type_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckResult>
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant_id** | **String** | Code of target tenant |  |
+| **check_point_id** | **String** | ID of CheckPoint |  |
+| **service_type_id** | **String** | ID of Service |  |
+| **identifier** | **String** | The Identifier is part of the customer&#39;s QR-code / barcode.&lt;br&gt;After scanning this code, provide the complete code-content without trimming! | [optional] |
+
+### Return type
+
+[**CheckResult**](CheckResult.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post
+
+> <TransactResult> v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post(tenant_id, check_point_id, service_type_id, opts)
+
+check based on service and transaction
+
+Check, if an identification is permitted for a specific serviceType at the time of the request or not.<br>The HTTP method POST performs a check with a persistent transaction.
+
+### Examples
+
+```ruby
+require 'time'
+require 'feratel-check-api-client'
+# setup authorization
+FeratelCheckApiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FeratelCheckApiClient::CheckResourcesApi.new
+tenant_id = 'tenant_id_example' # String | Code of target tenant
+check_point_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+service_type_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  identifier: 'identifier_example' # String | The Identifier is part of the customer's QR-code / barcode.<br>After scanning this code, provide the complete code-content without trimming!
+}
+
+begin
+  # check based on service and transaction
+  result = api_instance.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post(tenant_id, check_point_id, service_type_id, opts)
+  p result
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post: #{e}"
+end
+```
+
+#### Using the v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactResult>, Integer, Hash)> v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post_with_http_info(tenant_id, check_point_id, service_type_id, opts)
+
+```ruby
+begin
+  # check based on service and transaction
+  data, status_code, headers = api_instance.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post_with_http_info(tenant_id, check_point_id, service_type_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactResult>
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant_id** | **String** | Code of target tenant |  |
+| **check_point_id** | **String** |  |  |
+| **service_type_id** | **String** |  |  |
+| **identifier** | **String** | The Identifier is part of the customer&#39;s QR-code / barcode.&lt;br&gt;After scanning this code, provide the complete code-content without trimming! | [optional] |
+
+### Return type
+
+[**TransactResult**](TransactResult.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_tenant_id_secure_checkpoints_check_point_id_get
+
+> <CheckPoint> v1_tenant_id_secure_checkpoints_check_point_id_get(tenant_id, check_point_id)
+
+checkpoint details
+
+Get all service and usage details of a specific checkpoint.<br>The ServiceTypeId (type:id) contained in the response is required to check an identification based on a service (method \"check/serviceTypeId\").
+
+### Examples
+
+```ruby
+require 'time'
+require 'feratel-check-api-client'
+# setup authorization
+FeratelCheckApiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FeratelCheckApiClient::CheckResourcesApi.new
+tenant_id = 'tenant_id_example' # String | Code of target tenant
+check_point_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of CheckPoint
+
+begin
+  # checkpoint details
+  result = api_instance.v1_tenant_id_secure_checkpoints_check_point_id_get(tenant_id, check_point_id)
+  p result
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_check_point_id_get: #{e}"
+end
+```
+
+#### Using the v1_tenant_id_secure_checkpoints_check_point_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckPoint>, Integer, Hash)> v1_tenant_id_secure_checkpoints_check_point_id_get_with_http_info(tenant_id, check_point_id)
+
+```ruby
+begin
+  # checkpoint details
+  data, status_code, headers = api_instance.v1_tenant_id_secure_checkpoints_check_point_id_get_with_http_info(tenant_id, check_point_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckPoint>
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_check_point_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant_id** | **String** | Code of target tenant |  |
+| **check_point_id** | **String** | ID of CheckPoint |  |
+
+### Return type
+
+[**CheckPoint**](CheckPoint.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_tenant_id_secure_checkpoints_check_point_id_history_get
+
+> <History> v1_tenant_id_secure_checkpoints_check_point_id_history_get(tenant_id, check_point_id, opts)
+
+transaction history
+
+Get the last 5 checks (transactions) of a specific checkpoint.
+
+### Examples
+
+```ruby
+require 'time'
+require 'feratel-check-api-client'
+# setup authorization
+FeratelCheckApiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FeratelCheckApiClient::CheckResourcesApi.new
+tenant_id = 'tenant_id_example' # String | Code of target tenant
+check_point_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of CheckPoint
+opts = {
+  page: 56, # Integer | start page index
+  service_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | ID of Service
+  size: 56 # Integer | max. delivered pages
+}
+
+begin
+  # transaction history
+  result = api_instance.v1_tenant_id_secure_checkpoints_check_point_id_history_get(tenant_id, check_point_id, opts)
+  p result
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_check_point_id_history_get: #{e}"
+end
+```
+
+#### Using the v1_tenant_id_secure_checkpoints_check_point_id_history_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<History>, Integer, Hash)> v1_tenant_id_secure_checkpoints_check_point_id_history_get_with_http_info(tenant_id, check_point_id, opts)
+
+```ruby
+begin
+  # transaction history
+  data, status_code, headers = api_instance.v1_tenant_id_secure_checkpoints_check_point_id_history_get_with_http_info(tenant_id, check_point_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <History>
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_check_point_id_history_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant_id** | **String** | Code of target tenant |  |
+| **check_point_id** | **String** | ID of CheckPoint |  |
+| **page** | **Integer** | start page index | [optional][default to 0] |
+| **service_id** | **String** | ID of Service | [optional] |
+| **size** | **Integer** | max. delivered pages | [optional][default to 5] |
+
+### Return type
+
+[**History**](History.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_tenant_id_secure_checkpoints_get
+
+> <Array<CheckPointItem>> v1_tenant_id_secure_checkpoints_get(tenant_id, opts)
+
+list of checkpoints
+
+Get all your user-assigned checkpoints in the selected card-project (tenant).<br>Use the corresponding checkpointid to \"check\" the permission of an identification (f.e. Card ID).
+
+### Examples
+
+```ruby
+require 'time'
+require 'feratel-check-api-client'
+# setup authorization
+FeratelCheckApiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FeratelCheckApiClient::CheckResourcesApi.new
+tenant_id = 'tenant_id_example' # String | Code of target tenant
+opts = {
+  active: true, # Boolean | If true only active checkpoints
+  page: 56, # Integer | Index of start page
+  size: 56 # Integer | Number of max delivered pages
+}
+
+begin
+  # list of checkpoints
+  result = api_instance.v1_tenant_id_secure_checkpoints_get(tenant_id, opts)
+  p result
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_get: #{e}"
+end
+```
+
+#### Using the v1_tenant_id_secure_checkpoints_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<CheckPointItem>>, Integer, Hash)> v1_tenant_id_secure_checkpoints_get_with_http_info(tenant_id, opts)
+
+```ruby
+begin
+  # list of checkpoints
+  data, status_code, headers = api_instance.v1_tenant_id_secure_checkpoints_get_with_http_info(tenant_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<CheckPointItem>>
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant_id** | **String** | Code of target tenant |  |
+| **active** | **Boolean** | If true only active checkpoints | [optional] |
+| **page** | **Integer** | Index of start page | [optional][default to 0] |
+| **size** | **Integer** | Number of max delivered pages | [optional][default to 100] |
+
+### Return type
+
+[**Array&lt;CheckPointItem&gt;**](CheckPointItem.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CheckResult.md

@@ -0,0 +1,26 @@
+# FeratelCheckApiClient::CheckResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_point** | [**CheckPoint**](CheckPoint.md) |  | [optional] |
+| **check_state** | [**CheckState**](CheckState.md) |  | [optional] |
+| **identification** | [**Identification**](Identification.md) |  | [optional] |
+| **valid_transaction_info** | [**ValidTransactionInfo**](ValidTransactionInfo.md) |  | [optional] |
+| **valid** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::CheckResult.new(
+  check_point: null,
+  check_state: null,
+  identification: null,
+  valid_transaction_info: null,
+  valid: null
+)
+```
+

data/docs/CheckState.md

@@ -0,0 +1,20 @@
+# FeratelCheckApiClient::CheckState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **state** | [**CheckStateEnum**](CheckStateEnum.md) |  | [optional] |
+| **translations** | [**Array<CheckStateTranslation>**](CheckStateTranslation.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::CheckState.new(
+  state: null,
+  translations: null
+)
+```
+

data/docs/CheckStateEnum.md

@@ -0,0 +1,15 @@
+# FeratelCheckApiClient::CheckStateEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::CheckStateEnum.new()
+```
+

data/docs/CheckStateTranslation.md

@@ -0,0 +1,20 @@
+# FeratelCheckApiClient::CheckStateTranslation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **language** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::CheckStateTranslation.new(
+  language: null,
+  name: null
+)
+```
+

data/docs/CheckpointError.md

@@ -0,0 +1,22 @@
+# FeratelCheckApiClient::CheckpointError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_state** | [**CheckStateEnum**](CheckStateEnum.md) |  | [optional] |
+| **valid** | **Boolean** |  | [optional] |
+| **translations** | [**Array<CheckStateTranslation>**](CheckStateTranslation.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::CheckpointError.new(
+  check_state: null,
+  valid: null,
+  translations: null
+)
+```
+

data/docs/Customer.md

@@ -0,0 +1,24 @@
+# FeratelCheckApiClient::Customer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **age_group** | [**AgeGroup**](AgeGroup.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::Customer.new(
+  id: null,
+  first_name: null,
+  last_name: null,
+  age_group: null
+)
+```
+

data/docs/History.md

@@ -0,0 +1,18 @@
+# FeratelCheckApiClient::History
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **history_items** | [**Array<HistoryItem>**](HistoryItem.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::History.new(
+  history_items: null
+)
+```
+