multi-auth-project-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73adfbae8c46203f3325a8b1e4e635c86dbce96c6051cc11c5fe7cc6da411b68
+  data.tar.gz: 8a3bf977e8cd7f26461b29decccfe400715e975323a87dd41e7a29edfeebe449
+SHA512:
+  metadata.gz: 20342014477da699b5fd336c3030f65263eab1fe20dbe9abcff39658f2f536a7eaa10d0a91d173bea5c71dd032f2716e7721017c597bf2ac542dc8d0fe2cc7f5
+  data.tar.gz: 99ebfa93f0ef07fa8854c9cdacef30179008efc64adeecf5f3c70919509d2a79a2bf70743f8c30a7661b68c52479856120e488fc2739f07eab899e8d58a46c5b

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2024 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,139 @@
+
+# Getting Started with MultiAuth-Sample
+
+## Introduction
+
+API for Markdown Notes app.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```ruby
+gem install multi-auth-project-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'multi-auth-project-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the multi-auth-project-sdk gem](https://rubygems.org/gems/multi-auth-project-sdk/versions/1.0.0).
+
+## Test the SDK
+
+To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
+
+```
+rake
+```
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| `access_token` | `String` |  |
+| `port` | `String` | *Default*: `'80'` |
+| `suites` | `SuiteCodeEnum` | *Default*: `SuiteCodeEnum::HEARTS` |
+| `environment` | Environment | The API environment. <br> **Default: `Environment.TESTING`** |
+| `connection` | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| `adapter` | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| `timeout` | `Float` | The value to use for connection timeout. <br> **Default: 60** |
+| `max_retries` | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| `retry_interval` | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| `backoff_factor` | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| `http_callback` | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/basic-authentication.md) | The credential object for Basic Authentication |
+| `api_key_credentials` | [`ApiKeyCredentials`](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/custom-query-parameter.md) | The credential object for Custom Query Parameter |
+| `api_header_credentials` | [`ApiHeaderCredentials`](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/custom-header-signature.md) | The credential object for Custom Header Signature |
+| `o_auth_ccg_credentials` | [`OAuthCCGCredentials`](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| `o_auth_acg_credentials` | [`OAuthACGCredentials`](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/oauth-2-authorization-code-grant.md) | The credential object for OAuth 2 Authorization Code Grant |
+| `o_auth_ropcg_credentials` | [`OAuthROPCGCredentials`](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/oauth-2-resource-owner-credentials-grant.md) | The credential object for OAuth 2 Resource Owner Credentials Grant |
+| `o_auth_bearer_token_credentials` | [`OAuthBearerTokenCredentials`](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
+
+The API client can be initialized as follows:
+
+```ruby
+client = MultiAuthSample::Client.new(
+  access_token: 'accessToken',
+  basic_auth_credentials: BasicAuthCredentials.new(
+    username: 'Username',
+    password: 'Password'
+  ),
+  api_key_credentials: ApiKeyCredentials.new(
+    token: 'token',
+    api_key: 'api-key'
+  ),
+  api_header_credentials: ApiHeaderCredentials.new(
+    token: 'token',
+    api_key: 'api-key'
+  ),
+  o_auth_ccg_credentials: OAuthCCGCredentials.new(
+    o_auth_client_id: 'OAuthClientId',
+    o_auth_client_secret: 'OAuthClientSecret'
+  ),
+  o_auth_acg_credentials: OAuthACGCredentials.new(
+    o_auth_client_id: 'OAuthClientId',
+    o_auth_client_secret: 'OAuthClientSecret',
+    o_auth_redirect_uri: 'OAuthRedirectUri',
+    o_auth_scopes: [
+      OAuthScopeOAuthACGEnum::READ_SCOPE
+    ]
+  ),
+  o_auth_ropcg_credentials: OAuthROPCGCredentials.new(
+    o_auth_client_id: 'OAuthClientId',
+    o_auth_client_secret: 'OAuthClientSecret',
+    o_auth_username: 'OAuthUsername',
+    o_auth_password: 'OAuthPassword'
+  ),
+  o_auth_bearer_token_credentials: OAuthBearerTokenCredentials.new(
+    access_token: 'AccessToken'
+  ),
+  environment: Environment::TESTING,
+  port: '80',
+  suites: SuiteCodeEnum::HEARTS
+)
+```
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| production | - |
+| testing | **Default** |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`basicAuth (Basic Authentication)`](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/basic-authentication.md)
+* [`apiKey (Custom Query Parameter)`](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/custom-query-parameter.md)
+* [`apiHeader (Custom Header Signature)`](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/custom-header-signature.md)
+* [`OAuthCCG (OAuth 2 Client Credentials Grant)`](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/oauth-2-client-credentials-grant.md)
+* [`OAuthACG (OAuth 2 Authorization Code Grant)`](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/oauth-2-authorization-code-grant.md)
+* [`OAuthROPCG (OAuth 2 Resource Owner Credentials Grant)`](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/oauth-2-resource-owner-credentials-grant.md)
+* [`OAuthBearerToken (OAuth 2 Bearer token)`](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/oauth-2-bearer-token.md)
+* `CustomAuth (Custom Authentication)`
+
+## List of APIs
+
+* [O Auth Authorization](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/controllers/o-auth-authorization.md)
+* [Authentication](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/controllers/authentication.md)
+
+## Classes Documentation
+
+* [Utility Classes](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/Syed-Subtain/multi-auth-project-ruby-sdk/tree/1.0.0/doc/http-request.md)
+

data/lib/multi_auth_sample/api_helper.rb

@@ -0,0 +1,10 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/multi_auth_sample/client.rb

@@ -0,0 +1,105 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  #  multi_auth_sample client class.
+  class Client
+    attr_reader :config, :auth_managers
+
+    # Returns the configured authentication OAuthCCG instance.
+    def o_auth_ccg
+      @auth_managers['OAuthCCG']
+    end
+
+    # Returns the configured authentication OAuthACG instance.
+    def o_auth_acg
+      @auth_managers['OAuthACG']
+    end
+
+    # Returns the configured authentication OAuthROPCG instance.
+    def o_auth_ropcg
+      @auth_managers['OAuthROPCG']
+    end
+
+    # Access to authentication controller.
+    # @return [AuthenticationController] Returns the controller instance.
+    def authentication
+      @authentication ||= AuthenticationController.new @global_configuration
+    end
+
+    # Access to o_auth_authorization controller.
+    # @return [OAuthAuthorizationController] Returns the controller instance.
+    def o_auth_authorization
+      @o_auth_authorization ||= OAuthAuthorizationController.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil,
+      environment: Environment::TESTING, port: '80',
+      suites: SuiteCodeEnum::HEARTS, basic_auth_credentials: nil,
+      api_key_credentials: nil, api_header_credentials: nil,
+      o_auth_ccg_credentials: nil, o_auth_acg_credentials: nil,
+      o_auth_ropcg_credentials: nil, o_auth_bearer_token_credentials: nil,
+      custom_auth_credentials: nil, access_token: '', config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    environment: environment, port: port, suites: suites,
+                    basic_auth_credentials: basic_auth_credentials,
+                    api_key_credentials: api_key_credentials,
+                    api_header_credentials: api_header_credentials,
+                    o_auth_ccg_credentials: o_auth_ccg_credentials,
+                    o_auth_acg_credentials: o_auth_acg_credentials,
+                    o_auth_ropcg_credentials: o_auth_ropcg_credentials,
+                    o_auth_bearer_token_credentials: o_auth_bearer_token_credentials,
+                    custom_auth_credentials: custom_auth_credentials,
+                    access_token: access_token
+                  )
+                else
+                  config
+                end
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseController::GLOBAL_ERRORS)
+                                                 .user_agent(BaseController.user_agent)
+                                                 .global_header('accessToken', @config.access_token)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[basicAuth apiKey apiHeader OAuthCCG OAuthACG OAuthROPCG OAuthBearerToken CustomAuth].each do |auth|
+        @auth_managers[auth] = nil
+      end
+      @auth_managers['basicAuth'] = BasicAuth.new(http_client_config.basic_auth_credentials)
+      @auth_managers['apiKey'] = ApiKey.new(http_client_config.api_key_credentials)
+      @auth_managers['apiHeader'] = ApiHeader.new(http_client_config.api_header_credentials)
+      @auth_managers['OAuthCCG'] = OAuthCCG.new(http_client_config.o_auth_ccg_credentials,
+                                                global_config)
+      @auth_managers['OAuthACG'] = OAuthACG.new(http_client_config.o_auth_acg_credentials,
+                                                global_config)
+      @auth_managers['OAuthROPCG'] = OAuthROPCG.new(http_client_config.o_auth_ropcg_credentials,
+                                                    global_config)
+      @auth_managers['OAuthBearerToken'] = OAuthBearerToken.new(
+        http_client_config.o_auth_bearer_token_credentials
+      )
+      @auth_managers['CustomAuth'] = CustomAuth.new(http_client_config)
+    end
+  end
+end

data/lib/multi_auth_sample/configuration.rb

@@ -0,0 +1,170 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze,
+      TESTING = 'testing'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze,
+      AUTH = 'auth'.freeze
+    ].freeze
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :port, :suites, :basic_auth_credentials, :api_key_credentials,
+                :api_header_credentials, :o_auth_ccg_credentials, :o_auth_acg_credentials,
+                :o_auth_ropcg_credentials, :o_auth_bearer_token_credentials,
+                :custom_auth_credentials, :access_token
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil,
+      environment: Environment::TESTING, port: '80',
+      suites: SuiteCodeEnum::HEARTS, basic_auth_credentials: nil,
+      api_key_credentials: nil, api_header_credentials: nil,
+      o_auth_ccg_credentials: nil, o_auth_acg_credentials: nil,
+      o_auth_ropcg_credentials: nil, o_auth_bearer_token_credentials: nil,
+      custom_auth_credentials: nil, access_token: ''
+    )
+
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback
+
+      # Current API environment
+      @environment = String(environment)
+
+      # port value
+      @port = port
+
+      # suites value
+      @suites = suites
+
+      # The object holding Basic Authentication credentials
+      @basic_auth_credentials = basic_auth_credentials
+
+      # The object holding Custom Query Parameter credentials
+      @api_key_credentials = api_key_credentials
+
+      # The object holding Custom Header Signature credentials
+      @api_header_credentials = api_header_credentials
+
+      # The object holding OAuth 2 Client Credentials Grant credentials
+      @o_auth_ccg_credentials = o_auth_ccg_credentials
+
+      # The object holding OAuth 2 Authorization Code Grant credentials
+      @o_auth_acg_credentials = o_auth_acg_credentials
+
+      # The object holding OAuth 2 Resource Owner Credentials Grant credentials
+      @o_auth_ropcg_credentials = o_auth_ropcg_credentials
+
+      # The object holding OAuth 2 Bearer token credentials
+      @o_auth_bearer_token_credentials = o_auth_bearer_token_credentials
+
+      # The object holding Custom Authentication credentials
+      @custom_auth_credentials = custom_auth_credentials
+
+      # TODO: Replace
+      @access_token = access_token
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   environment: nil, port: nil, suites: nil,
+                   basic_auth_credentials: nil, api_key_credentials: nil,
+                   api_header_credentials: nil, o_auth_ccg_credentials: nil,
+                   o_auth_acg_credentials: nil, o_auth_ropcg_credentials: nil,
+                   o_auth_bearer_token_credentials: nil,
+                   custom_auth_credentials: nil, access_token: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      environment ||= self.environment
+      port ||= self.port
+      suites ||= self.suites
+      basic_auth_credentials ||= self.basic_auth_credentials
+      api_key_credentials ||= self.api_key_credentials
+      api_header_credentials ||= self.api_header_credentials
+      o_auth_ccg_credentials ||= self.o_auth_ccg_credentials
+      o_auth_acg_credentials ||= self.o_auth_acg_credentials
+      o_auth_ropcg_credentials ||= self.o_auth_ropcg_credentials
+      o_auth_bearer_token_credentials ||= self.o_auth_bearer_token_credentials
+      custom_auth_credentials ||= self.custom_auth_credentials
+      access_token ||= self.access_token
+
+      Configuration.new(
+        connection: connection, adapter: adapter, timeout: timeout,
+        max_retries: max_retries, retry_interval: retry_interval,
+        backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+        retry_methods: retry_methods, http_callback: http_callback,
+        environment: environment, port: port, suites: suites,
+        basic_auth_credentials: basic_auth_credentials,
+        api_key_credentials: api_key_credentials,
+        api_header_credentials: api_header_credentials,
+        o_auth_ccg_credentials: o_auth_ccg_credentials,
+        o_auth_acg_credentials: o_auth_acg_credentials,
+        o_auth_ropcg_credentials: o_auth_ropcg_credentials,
+        o_auth_bearer_token_credentials: o_auth_bearer_token_credentials,
+        custom_auth_credentials: custom_auth_credentials,
+        access_token: access_token
+      )
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'http://apimatic.hopto.org:{suites}',
+        Server::AUTH => 'http://apimaticauth.hopto.org:3000'
+      },
+      Environment::TESTING => {
+        Server::DEFAULT => 'http://localhost:3000',
+        Server::AUTH => 'http://localhost:3000/oauth2/auth-server'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      parameters = {
+        'port' => { 'value' => port, 'encode' => false },
+        'suites' => { 'value' => suites, 'encode' => false }
+      }
+      APIHelper.append_url_with_template_parameters(
+        ENVIRONMENTS[environment][server], parameters
+      )
+    end
+  end
+end

data/lib/multi_auth_sample/controllers/authentication_controller.rb

@@ -0,0 +1,151 @@
+# multi_auth_sample
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MultiAuthSample
+  # AuthenticationController
+  class AuthenticationController < BaseController
+    # TODO: type endpoint description here
+    # @return [String] response from the API call
+    def o_auth_bearer_token
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/auth/oauth2',
+                                     Server::DEFAULT)
+                   .auth(Single.new('OAuthBearerToken')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:deserialize_primitive_types))
+                   .deserialize_into(proc do |response| response.to_s end)
+                   .is_primitive_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @return [String] response from the API call
+    def custom_authentication
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/auth/customAuthentication',
+                                     Server::DEFAULT)
+                   .auth(Single.new('CustomAuth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:deserialize_primitive_types))
+                   .deserialize_into(proc do |response| response.to_s end)
+                   .is_primitive_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @return [String] response from the API call
+    def custom_query_or_header_authentication
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/auth/customQueryOrHeaderParam',
+                                     Server::DEFAULT)
+                   .auth(Or.new('apiKey', 'apiHeader')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:deserialize_primitive_types))
+                   .deserialize_into(proc do |response| response.to_s end)
+                   .is_primitive_response(true))
+        .execute
+    end
+
+    # This endpoint tests or combinations of OAuth types
+    # @return [String] response from the API call
+    def o_auth_grant_types_or_combinations
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/oauth2/oauthOrCombination',
+                                     Server::DEFAULT)
+                   .auth(Or.new('OAuthCCG', 'OAuthBearerToken')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:deserialize_primitive_types))
+                   .deserialize_into(proc do |response| response.to_s end)
+                   .is_primitive_response(true))
+        .execute
+    end
+
+    # This endpoint does not use auth.
+    # @return [String] response from the API call
+    def no_auth
+      warn 'Endpoint no_auth in AuthenticationController is deprecated since v'\
+           'ersion 0.0.1-alpha.    You should not use this method as it requir'\
+           'es no auth and can bring security issues to the server and api cal'\
+           'l itself!!'
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/auth/noAuth',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(true, key: 'array')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:deserialize_primitive_types))
+                   .deserialize_into(proc do |response| response.to_s end)
+                   .is_primitive_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @return [ServiceStatus] response from the API call
+    def o_auth_client_credentials_grant
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/oauth2/non-auth-server/status',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('OAuthCCG')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ServiceStatus.method(:from_hash)))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @return [String] response from the API call
+    def basic_auth_and_api_header_auth
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/auth/basicAndApiKeyAndApiHeader',
+                                     Server::DEFAULT)
+                   .auth(And.new('basicAuth', 'apiKey', 'apiHeader')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:deserialize_primitive_types))
+                   .deserialize_into(proc do |response| response.to_s end)
+                   .is_primitive_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @return [User] response from the API call
+    def o_auth_authorization_grant
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/oauth2/non-auth-server/user',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(And.new('OAuthACG', 'OAuthROPCG')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(User.method(:from_hash)))
+        .execute
+    end
+
+    # This endpoint uses globally applied auth which is a hypothetical scneraio
+    # but covers the worst case.
+    # @return [String] response from the API call
+    def multiple_auth_combination
+      warn 'Endpoint multiple_auth_combination in AuthenticationController is '\
+           'deprecated'
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/auth/multipleAuthCombination',
+                                     Server::DEFAULT)
+                   .auth(Or.new('CustomAuth', 'OAuthBearerToken', And.new('basicAuth', 'apiKey', 'apiHeader'))))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:deserialize_primitive_types))
+                   .deserialize_into(proc do |response| response.to_s end)
+                   .is_primitive_response(true))
+        .execute
+    end
+  end
+end