feratel-check-api-client 1.0.0

data/docs/HistoryItem.md

@@ -0,0 +1,24 @@
+# FeratelCheckApiClient::HistoryItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identification** | [**Identification**](Identification.md) |  | [optional] |
+| **service_type** | [**ServiceType**](ServiceType.md) |  | [optional] |
+| **state** | [**HistoryItemState**](HistoryItemState.md) |  | [optional] |
+| **transaction_date** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::HistoryItem.new(
+  identification: null,
+  service_type: null,
+  state: null,
+  transaction_date: 2022-03-10T12:15:50
+)
+```
+

data/docs/HistoryItemState.md

@@ -0,0 +1,26 @@
+# FeratelCheckApiClient::HistoryItemState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **double_use** | **Boolean** |  | [optional] |
+| **entry** | **Boolean** |  | [optional] |
+| **exit** | **Boolean** |  | [optional] |
+| **misuse** | **Boolean** |  | [optional] |
+| **offline** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::HistoryItemState.new(
+  double_use: null,
+  entry: null,
+  exit: null,
+  misuse: null,
+  offline: null
+)
+```
+

data/docs/Identification.md

@@ -0,0 +1,36 @@
+# FeratelCheckApiClient::Identification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **customer** | [**Customer**](Customer.md) |  | [optional] |
+| **external_id** | **String** |  | [optional] |
+| **external_id2** | **String** |  | [optional] |
+| **from_date** | **Date** |  | [optional] |
+| **id_code** | **String** |  | [optional] |
+| **id_number** | **Integer** |  | [optional] |
+| **status** | [**IdentificationStatus**](IdentificationStatus.md) |  | [optional] |
+| **to_date** | **Date** |  | [optional] |
+| **type** | [**IdentificationType**](IdentificationType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::Identification.new(
+  id: null,
+  customer: null,
+  external_id: null,
+  external_id2: null,
+  from_date: Thu Mar 10 01:00:00 CET 2022,
+  id_code: null,
+  id_number: null,
+  status: null,
+  to_date: Thu Mar 10 01:00:00 CET 2022,
+  type: null
+)
+```
+

data/docs/IdentificationStatus.md

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

data/docs/IdentificationType.md

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

data/docs/IdentificationUsage.md

@@ -0,0 +1,26 @@
+# FeratelCheckApiClient::IdentificationUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count_n** | **Integer** |  | [optional] |
+| **count_m** | **Integer** |  | [optional] |
+| **from_date** | **String** |  | [optional] |
+| **to_date** | **String** |  | [optional] |
+| **type** | [**IdentificationUsageType**](IdentificationUsageType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::IdentificationUsage.new(
+  count_n: null,
+  count_m: null,
+  from_date: 2022-03-10T12:15:50,
+  to_date: 2022-03-10T12:15:50,
+  type: null
+)
+```
+

data/docs/IdentificationUsageType.md

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

data/docs/Identifier.md

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

data/docs/IdentifierType.md

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

data/docs/ServiceProvider.md

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

data/docs/ServiceType.md

@@ -0,0 +1,28 @@
+# FeratelCheckApiClient::ServiceType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **allow_list** | **Boolean** |  | [optional] |
+| **code** | **String** |  | [optional] |
+| **provider** | [**ServiceProvider**](ServiceProvider.md) |  | [optional] |
+| **translations** | [**Array<ServiceTypeTranslation>**](ServiceTypeTranslation.md) |  | [optional] |
+| **usage** | [**ServiceUsage**](ServiceUsage.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::ServiceType.new(
+  id: null,
+  allow_list: null,
+  code: null,
+  provider: null,
+  translations: null,
+  usage: null
+)
+```
+

data/docs/ServiceTypeAssignment.md

@@ -0,0 +1,22 @@
+# FeratelCheckApiClient::ServiceTypeAssignment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **order** | **Integer** |  | [optional] |
+| **type** | [**ServiceType**](ServiceType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::ServiceTypeAssignment.new(
+  id: null,
+  order: null,
+  type: null
+)
+```
+

data/docs/ServiceTypeTranslation.md

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

data/docs/ServiceUsage.md

@@ -0,0 +1,36 @@
+# FeratelCheckApiClient::ServiceUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_exit** | **String** |  | [optional] |
+| **auto_exit_interval** | **Integer** |  | [optional] |
+| **count_n** | **Integer** |  | [optional] |
+| **count_m** | **Integer** |  | [optional] |
+| **double_use_timeout** | **Integer** |  | [optional] |
+| **from_date** | **String** |  | [optional] |
+| **not_usable_on_first_or_last_day** | **Boolean** |  | [optional] |
+| **to_date** | **String** |  | [optional] |
+| **type** | [**ServiceUsageType**](ServiceUsageType.md) |  | [optional] |
+| **week** | [**Week**](Week.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::ServiceUsage.new(
+  auto_exit: 2022-03-10T12:15:50,
+  auto_exit_interval: null,
+  count_n: null,
+  count_m: null,
+  double_use_timeout: null,
+  from_date: 2022-03-10T12:15:50,
+  not_usable_on_first_or_last_day: null,
+  to_date: 2022-03-10T12:15:50,
+  type: null,
+  week: null
+)
+```
+

data/docs/ServiceUsageType.md

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

data/docs/SystemResourcesApi.md

@@ -0,0 +1,147 @@
+# FeratelCheckApiClient::SystemResourcesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_tenant_id_secure_system_checkpoint_errors_get**](SystemResourcesApi.md#v1_tenant_id_secure_system_checkpoint_errors_get) | **GET** /v1/{tenantId}/secure/system/checkpointErrors | provides all errors related to the CheckAPI |
+| [**v1_tenant_id_secure_system_transact_errors_get**](SystemResourcesApi.md#v1_tenant_id_secure_system_transact_errors_get) | **GET** /v1/{tenantId}/secure/system/transactErrors | provides all transactErrors related to the CheckAPI |
+
+
+## v1_tenant_id_secure_system_checkpoint_errors_get
+
+> <Array<CheckpointError>> v1_tenant_id_secure_system_checkpoint_errors_get(tenant_id)
+
+provides all errors related to the CheckAPI
+
+Get all possible checkErrors.(checkstate,valid or not and all translations).
+
+### 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::SystemResourcesApi.new
+tenant_id = 'tenant_id_example' # String | 
+
+begin
+  # provides all errors related to the CheckAPI
+  result = api_instance.v1_tenant_id_secure_system_checkpoint_errors_get(tenant_id)
+  p result
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling SystemResourcesApi->v1_tenant_id_secure_system_checkpoint_errors_get: #{e}"
+end
+```
+
+#### Using the v1_tenant_id_secure_system_checkpoint_errors_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<CheckpointError>>, Integer, Hash)> v1_tenant_id_secure_system_checkpoint_errors_get_with_http_info(tenant_id)
+
+```ruby
+begin
+  # provides all errors related to the CheckAPI
+  data, status_code, headers = api_instance.v1_tenant_id_secure_system_checkpoint_errors_get_with_http_info(tenant_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<CheckpointError>>
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling SystemResourcesApi->v1_tenant_id_secure_system_checkpoint_errors_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant_id** | **String** |  |  |
+
+### Return type
+
+[**Array&lt;CheckpointError&gt;**](CheckpointError.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_tenant_id_secure_system_transact_errors_get
+
+> <Array<TransactError>> v1_tenant_id_secure_system_transact_errors_get(tenant_id)
+
+provides all transactErrors related to the CheckAPI
+
+Get all possible transactErrors.(transactState,translations and valid).
+
+### 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::SystemResourcesApi.new
+tenant_id = 'tenant_id_example' # String | 
+
+begin
+  # provides all transactErrors related to the CheckAPI
+  result = api_instance.v1_tenant_id_secure_system_transact_errors_get(tenant_id)
+  p result
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling SystemResourcesApi->v1_tenant_id_secure_system_transact_errors_get: #{e}"
+end
+```
+
+#### Using the v1_tenant_id_secure_system_transact_errors_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<TransactError>>, Integer, Hash)> v1_tenant_id_secure_system_transact_errors_get_with_http_info(tenant_id)
+
+```ruby
+begin
+  # provides all transactErrors related to the CheckAPI
+  data, status_code, headers = api_instance.v1_tenant_id_secure_system_transact_errors_get_with_http_info(tenant_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<TransactError>>
+rescue FeratelCheckApiClient::ApiError => e
+  puts "Error when calling SystemResourcesApi->v1_tenant_id_secure_system_transact_errors_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant_id** | **String** |  |  |
+
+### Return type
+
+[**Array&lt;TransactError&gt;**](TransactError.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TransactError.md

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

data/docs/TransactResult.md

@@ -0,0 +1,34 @@
+# FeratelCheckApiClient::TransactResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_point** | [**CheckPoint**](CheckPoint.md) |  | [optional] |
+| **check_state** | [**CheckState**](CheckState.md) |  | [optional] |
+| **identification** | [**Identification**](Identification.md) |  | [optional] |
+| **transact_date** | **String** |  | [optional] |
+| **transact_date_last** | **String** |  | [optional] |
+| **transact_id** | **String** |  | [optional] |
+| **transact_state** | [**TransactState**](TransactState.md) |  | [optional] |
+| **valid_transaction_info** | [**ValidTransactionInfo**](ValidTransactionInfo.md) |  | [optional] |
+| **valid** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::TransactResult.new(
+  check_point: null,
+  check_state: null,
+  identification: null,
+  transact_date: 2022-03-10T12:15:50,
+  transact_date_last: 2022-03-10T12:15:50,
+  transact_id: null,
+  transact_state: null,
+  valid_transaction_info: null,
+  valid: null
+)
+```
+

data/docs/TransactState.md

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

data/docs/TransactStateEnum.md

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

data/docs/TransactStateTranslation.md

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

data/docs/ValidTransactionInfo.md

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

data/docs/Week.md

@@ -0,0 +1,30 @@
+# FeratelCheckApiClient::Week
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **monday** | **Boolean** |  | [optional] |
+| **tuesday** | **Boolean** |  | [optional] |
+| **wednesday** | **Boolean** |  | [optional] |
+| **thursday** | **Boolean** |  | [optional] |
+| **friday** | **Boolean** |  | [optional] |
+| **saturday** | **Boolean** |  | [optional] |
+| **sunday** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::Week.new(
+  monday: null,
+  tuesday: null,
+  wednesday: null,
+  thursday: null,
+  friday: null,
+  saturday: null,
+  sunday: null
+)
+```
+