ev-recharge-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b91582bc1739f9e24f85bc8815b4904c3c3aa4887dc4e4d986cb79508f3afeea
+  data.tar.gz: 291214a251e8dc918b7f727336bb253e33129bf0c45252db46c47fa95770c1e1
+SHA512:
+  metadata.gz: a4f42064d469f193a69b9fabc12b4e8b75dd00ce17130371fd240c15504b73f076b78d1f744c73049c0f32d82b21432eb0c29e8192cad8f57509ab1558b41e5a
+  data.tar.gz: e82d3a275a00e2e7239eefe970d53a4693bbe51af74619592dfdfd275aec9a508492fee569f7314eaf3a8c7e9729d1be8a94f94744fc6ff6fe46323f210c2113

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,92 @@
+
+# Getting Started with Shell EV
+
+## Introduction
+
+This API Product provides the option to manage charging at all public Shell Recharge locations. The end points provides control to start, stop and get status of the charging session.
+
+Supported Function
+
+* Start a charging session
+* Stop a charging session
+* Retrieve the status of a charging session
+* Retrieve the list of all active sessions for a card   termsOfService: 'https://developer.shell.com/terms-of-use'
+
+Go to the Shell Developer Portal: [https://developer.shell.com](https://developer.shell.com)
+
+## Install the Package
+
+Install the gem from the command line:
+
+```ruby
+gem install ev-recharge-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'ev-recharge-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the ev-recharge-sdk gem](https://rubygems.org/gems/ev-recharge-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/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| `env` | `EnvEnum` | This variable specifies the type of environment. Environments:<br><br>* `api` - Production<br>* `api-test` - UAT<br>*Default*: `EnvEnum::ENUM_APITESTSHELLCOM` |
+| `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| `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. |
+| `client_credentials_auth_credentials` | [`ClientCredentialsAuthCredentials`](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+
+The API client can be initialized as follows:
+
+```ruby
+client = ShellEv::Client.new(
+  client_credentials_auth_credentials: ClientCredentialsAuthCredentials.new(
+    o_auth_client_id: 'OAuthClientId',
+    o_auth_client_secret: 'OAuthClientSecret'
+  ),
+  environment: Environment::PRODUCTION,
+  env: EnvEnum::ENUM_APITESTSHELLCOM
+)
+```
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`BearerAuth (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/oauth-2-client-credentials-grant.md)
+
+## List of APIs
+
+* [O Auth Authorization](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/controllers/o-auth-authorization.md)
+* [Charging](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/controllers/charging.md)
+* [Locations](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/controllers/locations.md)
+
+## Classes Documentation
+
+* [Utility Classes](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/ev-recharge-ruby-sdk/tree/1.0.0/doc/http-request.md)
+

data/lib/shell_ev/api_helper.rb

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

data/lib/shell_ev/client.rb

@@ -0,0 +1,77 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  #  shell_ev client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    # Returns the configured authentication BearerAuth instance.
+    def bearer_auth
+      @auth_managers['BearerAuth']
+    end
+
+    # Access to charging controller.
+    # @return [ChargingController] Returns the controller instance.
+    def charging
+      @charging ||= ChargingController.new @global_configuration
+    end
+
+    # Access to locations controller.
+    # @return [LocationsController] Returns the controller instance.
+    def locations
+      @locations ||= LocationsController.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::PRODUCTION, env: EnvEnum::ENUM_APITESTSHELLCOM,
+      client_credentials_auth_credentials: nil, 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, env: env,
+                    client_credentials_auth_credentials: client_credentials_auth_credentials
+                  )
+                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)
+
+      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[BearerAuth].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['BearerAuth'] = OAuth2.new(
+        http_client_config.client_credentials_auth_credentials, global_config
+      )
+    end
+  end
+end

data/lib/shell_ev/configuration.rb

@@ -0,0 +1,110 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.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, :env, :client_credentials_auth_credentials
+
+    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::PRODUCTION, env: EnvEnum::ENUM_APITESTSHELLCOM,
+      client_credentials_auth_credentials: nil
+    )
+
+      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)
+
+      # This variable specifies the type of environment. Environments:   * `api` - Production   * `api-test` - UAT
+      @env = env
+
+      # The object holding OAuth 2 Client Credentials Grant credentials
+      @client_credentials_auth_credentials = client_credentials_auth_credentials
+
+      # Initializing OAuth 2 Client Credentials Grant credentials with the provided auth parameters
+     @client_credentials_auth_credentials = client_credentials_auth_credentials
+
+      # 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, env: nil,
+                   client_credentials_auth_credentials: 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
+      env ||= self.env
+      client_credentials_auth_credentials ||= client_credentials_auth_credentials
+
+      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, env: env,
+        client_credentials_auth_credentials: client_credentials_auth_credentials
+      )
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://{env}'
+      }
+    }.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 = {
+        'env' => { 'value' => env, 'encode' => false }
+      }
+      APIHelper.append_url_with_template_parameters(
+        ENVIRONMENTS[environment][server], parameters
+      )
+    end
+  end
+end

data/lib/shell_ev/controllers/base_controller.rb

@@ -0,0 +1,66 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # BaseController.
+  class BaseController
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'APIMATIC 3.0'
+    end
+
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new builder for the Api Call instance.
+    # @return [ApiCall] The instance of ApiCall.
+    def new_api_call_builder
+      @api_call.new_builder
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/shell_ev/controllers/charging_controller.rb

@@ -0,0 +1,216 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # ChargingController
+  class ChargingController < BaseController
+    # This API initiates to start a session on a EVSE (Electric Vehicle Supply
+    # Equipement). When the EV Charge Card number and the unique EVSE ID on the
+    # location is provided, the session is initiated.
+    # Please note that this is an asynchronous request, the request will be
+    # passed on to the operator/platform to be processed further.
+    # @param [UUID | String] request_id Required parameter: A unique request id
+    # in GUID format. The value is written to the Shell API Platform audit log
+    # for end to end traceability of a request.
+    # @param [ChargesessionStartBody] body Optional parameter: Example:
+    # @return [InlineResponse202] response from the API call
+    def start_charge_session(request_id,
+                             body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/ev/v1/charge-session/start',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(request_id, key: 'RequestId'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('BearerAuth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(InlineResponse202.method(:from_hash))
+                   .local_error('400',
+                                "Bad Request\n",
+                                M400ErrorResponseError1Exception)
+                   .local_error('401',
+                                'Unauthorized',
+                                HTTP401ErrorResponseException)
+                   .local_error('404',
+                                "Invalid charge token with given EmaId was not found.\n\nBackend'\
+                                 ' HTTP 410 should be transformed to 404.",
+                                M404ErrorResponseError1Exception)
+                   .local_error('405',
+                                'Method Not Allowed',
+                                M405ErrorResponseError1Exception)
+                   .local_error('429',
+                                'Too Many Requests',
+                                M429ErrorResponseError1Exception)
+                   .local_error('500',
+                                'Internal Server Error',
+                                M500ErrorResponseError1Exception)
+                   .local_error('503',
+                                'Returned when a connectivity failure is encountered like DB'\
+                                 ' connection failed, endpoint failed etc or when max number of'\
+                                 ' retries are completed',
+                                M503ErrorResponseError1Exception))
+        .execute
+    end
+
+    # This API stops a session by providing the session ID which was retrieved
+    # when starting the session. HTTP 202 response will be returned if the
+    # request is accepted. Once the session is stopped the response will contain
+    # the DateTime on which it is stopped.      operationId: Stop
+    # @param [UUID | String] request_id Required parameter: A unique request id
+    # in GUID format. The value is written to the Shell API Platform audit log
+    # for end to end traceability of a request.
+    # @param [UUID | String] uuid Required parameter: Unique session ID which
+    # was generated to activate a charging session.
+    # @param [StopChargeSessionRequestBodyJson] body Optional parameter:
+    # Example:
+    # @return [InlineResponse2021] response from the API call
+    def stop_charge_session(request_id,
+                            uuid,
+                            body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/ev/v1/charge-session/stop/{uuid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(request_id, key: 'RequestId'))
+                   .template_param(new_parameter(uuid, key: 'uuid')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('BearerAuth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(InlineResponse2021.method(:from_hash))
+                   .local_error('400',
+                                "Bad Request\n",
+                                M400ErrorResponseError1Exception)
+                   .local_error('401',
+                                'Unauthorized',
+                                M401ErrorResponseError1Exception)
+                   .local_error('404',
+                                'Session not found or Session has already been stopped. Map 410'\
+                                 ' Error message into 404.',
+                                M404ErrorResponseError1Exception)
+                   .local_error('405',
+                                'Method Not Allowed',
+                                M405ErrorResponseError1Exception)
+                   .local_error('429',
+                                'Too Many Requests',
+                                M429ErrorResponseError1Exception)
+                   .local_error('500',
+                                'Internal Server Error',
+                                M500ErrorResponseError1Exception)
+                   .local_error('503',
+                                "Returned when a connectivity failure is encountered like DB'\
+                                 ' connection failed, endpoint failed etc or when max number of'\
+                                 ' retries are completed\n",
+                                M503ErrorResponseError1Exception))
+        .execute
+    end
+
+    # This API retrieves the status and details of the session which was started
+    # by the user. The session ID generated earlier needs to be passed in this
+    # API in order to retrieve the status.
+    # @param [UUID | String] request_id Required parameter: A unique request id
+    # in GUID format. The value is written to the Shell API Platform audit log
+    # for end to end traceability of a request.
+    # @param [String] session_id Required parameter: Session Id is to be
+    # fetched
+    # @param [UUID | String] uuid Required parameter: Unique session ID which
+    # was generated to activate a charging session.
+    # @return [GetChargeSessionRetrieveResponse200Json] response from the API call
+    def get_charge_session_retrieve(request_id,
+                                    session_id,
+                                    uuid)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/ev/v1/charge-session/retrieve/{uuid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(request_id, key: 'RequestId'))
+                   .query_param(new_parameter(session_id, key: 'SessionId'))
+                   .template_param(new_parameter(uuid, key: 'uuid')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BearerAuth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(GetChargeSessionRetrieveResponse200Json.method(:from_hash))
+                   .local_error('400',
+                                'Bad Request',
+                                M400ErrorResponseError1Exception)
+                   .local_error('401',
+                                'Unauthorized',
+                                M401ErrorResponseError1Exception)
+                   .local_error('404',
+                                'Not Found',
+                                M404ErrorResponseError1Exception)
+                   .local_error('405',
+                                'Method Not Allowed',
+                                M405ErrorResponseError1Exception)
+                   .local_error('429',
+                                'Too Many Requests',
+                                M429ErrorResponseError1Exception)
+                   .local_error('500',
+                                'Internal Server Error',
+                                M500ErrorResponseError1Exception)
+                   .local_error('503',
+                                'Service Unavailable',
+                                M503ErrorResponseError1Exception))
+        .execute
+    end
+
+    # This API retrieves the list of active sessions for a given set of EMAIds
+    # @param [String] ema_id Required parameter: Emobility Account
+    # Identifier(Ema-ID)
+    # @param [UUID | String] request_id Required parameter: A unique request id
+    # in GUID format. The value is written to the Shell API Platform audit log
+    # for end to end traceability of a request.
+    # @return [ActiveResponse200Json] response from the API call
+    def active(ema_id,
+               request_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/ev/v1/charge-session/active',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(ema_id, key: 'EmaId'))
+                   .header_param(new_parameter(request_id, key: 'RequestId'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BearerAuth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ActiveResponse200Json.method(:from_hash))
+                   .local_error('400',
+                                "Bad Request\n",
+                                M400ErrorResponseError1Exception)
+                   .local_error('401',
+                                'Unauthorized',
+                                M401ErrorResponseError1Exception)
+                   .local_error('404',
+                                'Session not found or Session has already been stopped. Map 410'\
+                                 ' Error message into 404.',
+                                M404ErrorResponseError1Exception)
+                   .local_error('405',
+                                'Method Not Allowed',
+                                M405ErrorResponseError1Exception)
+                   .local_error('429',
+                                'Too Many Requests',
+                                M429ErrorResponseError1Exception)
+                   .local_error('500',
+                                'Internal Server Error',
+                                M500ErrorResponseError1Exception)
+                   .local_error('503',
+                                "Returned when a connectivity failure is encountered like DB'\
+                                 ' connection failed, endpoint failed etc or when max number of'\
+                                 ' retries are completed\n",
+                                M503ErrorResponseError1Exception))
+        .execute
+    end
+  end
+end