feratel-check-api-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71d93e3b6926a37740c482d9df4ad9f43a2df46bc9d435496812e46afbfa0abd
+  data.tar.gz: 118728de7307caecd6995f3e21da048590c145ae836ecbb0b99d574621a380b8
+SHA512:
+  metadata.gz: 3692d5649c7ebf93f4ee237430855047dc4eb3ff26e09b6246af94197bd0e4f33559992772f70df134bee15baa66faf1378de79ad3f740337d4f7be4d7015236
+  data.tar.gz: 2476dab29906f74d1efb41839c66418892d0cdb52e88ad206c6cd1b582a7026cdcc4ec06e0f8b8822fb1e2a478b15302b9e759e985f0eb1b6befdde525d1b22f

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,159 @@
+# feratel-check-api-client
+
+FeratelCheckApiClient - the Ruby gem for the CheckAPI Standard
+
+This documentation describes your available CheckAPI REST services: Get your checkpoints and their details, check the permission of a customer's ID, take a look at your checkpoint's history - everything a checkpoint needs can be found here in one place.
+
+Please look at the descriptions in each service below.
+
+<div id=\"authorize-information-wrap\"><h1>Authorize</h1><p>You can use this automated authentication to try out your activated methods - just click „Authorize“, enter CardAPI credentials and have a try! You received the CardAPI username and password via e-mail – credentials are different from your developer-portal credentials. Authentication is based on OAUTH2 (implicit grant flow) and needs to be implemented and called prior to using any API method.
+
+<b>CLIENT_ID</b><br>The client ID is pre-filled automatically according to the chosen application. You can find your available client IDs in the \"Applications\" - Area.
+
+<b>GRANT_TYPE</b><br>With grant_type=password you get an access-token and a refresh-token for your request. The received access token can be used for 10 minutes, there are two ways to renew it. Either you can send the same request again or you can use the grant_type=refresh_token. The refresh token needs to be used every 30 minutes and can provide new access tokens for 10 hours without using your credentials.</p></div>
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.17.0
+- Package version: 1.0.0
+- Generator version: 7.8.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build feratel-check-api-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./feratel-check-api-client-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./feratel-check-api-client-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'feratel-check-api-client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'feratel-check-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'feratel-check-api-client'
+
+# Setup authorization
+FeratelCheckApiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth
+  config.access_token = 'YOUR ACCESS TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
+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 "Exception when calling CheckResourcesApi->v1_tenant_id_secure_checkpoints_check_point_id_check_get: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*FeratelCheckApiClient::CheckResourcesApi* | [**v1_tenant_id_secure_checkpoints_check_point_id_check_get**](docs/CheckResourcesApi.md#v1_tenant_id_secure_checkpoints_check_point_id_check_get) | **GET** /v1/{tenantId}/secure/checkpoints/{checkPointId}/check | check
+*FeratelCheckApiClient::CheckResourcesApi* | [**v1_tenant_id_secure_checkpoints_check_point_id_check_post**](docs/CheckResourcesApi.md#v1_tenant_id_secure_checkpoints_check_point_id_check_post) | **POST** /v1/{tenantId}/secure/checkpoints/{checkPointId}/check | check and transaction
+*FeratelCheckApiClient::CheckResourcesApi* | [**v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get**](docs/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
+*FeratelCheckApiClient::CheckResourcesApi* | [**v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post**](docs/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
+*FeratelCheckApiClient::CheckResourcesApi* | [**v1_tenant_id_secure_checkpoints_check_point_id_get**](docs/CheckResourcesApi.md#v1_tenant_id_secure_checkpoints_check_point_id_get) | **GET** /v1/{tenantId}/secure/checkpoints/{checkPointId} | checkpoint details
+*FeratelCheckApiClient::CheckResourcesApi* | [**v1_tenant_id_secure_checkpoints_check_point_id_history_get**](docs/CheckResourcesApi.md#v1_tenant_id_secure_checkpoints_check_point_id_history_get) | **GET** /v1/{tenantId}/secure/checkpoints/{checkPointId}/history | transaction history
+*FeratelCheckApiClient::CheckResourcesApi* | [**v1_tenant_id_secure_checkpoints_get**](docs/CheckResourcesApi.md#v1_tenant_id_secure_checkpoints_get) | **GET** /v1/{tenantId}/secure/checkpoints | list of checkpoints
+*FeratelCheckApiClient::SystemResourcesApi* | [**v1_tenant_id_secure_system_checkpoint_errors_get**](docs/SystemResourcesApi.md#v1_tenant_id_secure_system_checkpoint_errors_get) | **GET** /v1/{tenantId}/secure/system/checkpointErrors | provides all errors related to the CheckAPI
+*FeratelCheckApiClient::SystemResourcesApi* | [**v1_tenant_id_secure_system_transact_errors_get**](docs/SystemResourcesApi.md#v1_tenant_id_secure_system_transact_errors_get) | **GET** /v1/{tenantId}/secure/system/transactErrors | provides all transactErrors related to the CheckAPI
+
+
+## Documentation for Models
+
+ - [FeratelCheckApiClient::AgeGroup](docs/AgeGroup.md)
+ - [FeratelCheckApiClient::AgeGroupTranslation](docs/AgeGroupTranslation.md)
+ - [FeratelCheckApiClient::CheckPoint](docs/CheckPoint.md)
+ - [FeratelCheckApiClient::CheckPointGroup](docs/CheckPointGroup.md)
+ - [FeratelCheckApiClient::CheckPointItem](docs/CheckPointItem.md)
+ - [FeratelCheckApiClient::CheckResult](docs/CheckResult.md)
+ - [FeratelCheckApiClient::CheckState](docs/CheckState.md)
+ - [FeratelCheckApiClient::CheckStateEnum](docs/CheckStateEnum.md)
+ - [FeratelCheckApiClient::CheckStateTranslation](docs/CheckStateTranslation.md)
+ - [FeratelCheckApiClient::CheckpointError](docs/CheckpointError.md)
+ - [FeratelCheckApiClient::Customer](docs/Customer.md)
+ - [FeratelCheckApiClient::History](docs/History.md)
+ - [FeratelCheckApiClient::HistoryItem](docs/HistoryItem.md)
+ - [FeratelCheckApiClient::HistoryItemState](docs/HistoryItemState.md)
+ - [FeratelCheckApiClient::Identification](docs/Identification.md)
+ - [FeratelCheckApiClient::IdentificationStatus](docs/IdentificationStatus.md)
+ - [FeratelCheckApiClient::IdentificationType](docs/IdentificationType.md)
+ - [FeratelCheckApiClient::IdentificationUsage](docs/IdentificationUsage.md)
+ - [FeratelCheckApiClient::IdentificationUsageType](docs/IdentificationUsageType.md)
+ - [FeratelCheckApiClient::Identifier](docs/Identifier.md)
+ - [FeratelCheckApiClient::IdentifierType](docs/IdentifierType.md)
+ - [FeratelCheckApiClient::ServiceProvider](docs/ServiceProvider.md)
+ - [FeratelCheckApiClient::ServiceType](docs/ServiceType.md)
+ - [FeratelCheckApiClient::ServiceTypeAssignment](docs/ServiceTypeAssignment.md)
+ - [FeratelCheckApiClient::ServiceTypeTranslation](docs/ServiceTypeTranslation.md)
+ - [FeratelCheckApiClient::ServiceUsage](docs/ServiceUsage.md)
+ - [FeratelCheckApiClient::ServiceUsageType](docs/ServiceUsageType.md)
+ - [FeratelCheckApiClient::TransactError](docs/TransactError.md)
+ - [FeratelCheckApiClient::TransactResult](docs/TransactResult.md)
+ - [FeratelCheckApiClient::TransactState](docs/TransactState.md)
+ - [FeratelCheckApiClient::TransactStateEnum](docs/TransactStateEnum.md)
+ - [FeratelCheckApiClient::TransactStateTranslation](docs/TransactStateTranslation.md)
+ - [FeratelCheckApiClient::ValidTransactionInfo](docs/ValidTransactionInfo.md)
+ - [FeratelCheckApiClient::Week](docs/Week.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### oauth
+
+
+- **Type**: OAuth
+- **Flow**: implicit
+- **Authorization URL**: https://idp.feratel.com/auth/realms/card-api/protocol/openid-connect/auth
+- **Scopes**: N/A
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AgeGroup.md

@@ -0,0 +1,22 @@
+# FeratelCheckApiClient::AgeGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **translations** | [**Array<AgeGroupTranslation>**](AgeGroupTranslation.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::AgeGroup.new(
+  id: null,
+  name: null,
+  translations: null
+)
+```
+

data/docs/AgeGroupTranslation.md

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

data/docs/CheckPoint.md

@@ -0,0 +1,38 @@
+# FeratelCheckApiClient::CheckPoint
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **active** | **Boolean** |  | [optional] |
+| **code** | **String** |  | [optional] |
+| **entry** | **Boolean** |  | [optional] |
+| **exit** | **Boolean** |  | [optional] |
+| **group** | [**CheckPointGroup**](CheckPointGroup.md) |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **number** | **Integer** |  | [optional] |
+| **open_permanently** | **Boolean** |  | [optional] |
+| **service_type_assignments** | [**Array<ServiceTypeAssignment>**](ServiceTypeAssignment.md) |  | [optional] |
+| **tenant** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'feratel-check-api-client'
+
+instance = FeratelCheckApiClient::CheckPoint.new(
+  id: null,
+  active: null,
+  code: null,
+  entry: null,
+  exit: null,
+  group: null,
+  name: null,
+  number: null,
+  open_permanently: null,
+  service_type_assignments: null,
+  tenant: null
+)
+```
+

data/docs/CheckPointGroup.md

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

data/docs/CheckPointItem.md

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