tangocard-raas 1.1.2 → 2.2.1

data/lib/raas/controllers/orders_controller.rb

@@ -1,96 +1,70 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module Raas
+  # OrdersController
   class OrdersController < BaseController
-    @@instance = OrdersController.new
-    # Singleton instance of the controller class
-    def self.instance
-      @@instance
-    end
+    @instance = OrdersController.new
 
-    # TODO: type endpoint description here
-    # @param [CreateOrderRequestModel] body Required parameter: Example: 
-    # @return OrderModel response from the API call
-    def create_order(body)
-      begin
-        @logger.info("create_order called.")
-  
-        # validate required parameters
-        @logger.info("Validating required parameters for create_order.")
-        validate_parameters({
-          'body' => body
-        })
-  
-        # prepare query url
-        @logger.info("Preparing query URL for create_order.")
-        _query_builder = Configuration.get_base_uri()
-        _query_builder << '/orders'
-        _query_url = APIHelper.clean_url _query_builder
-  
-        # prepare headers
-        @logger.info("Preparing headers for create_order.")
-        _headers = {
-          'accept' => 'application/json',
-          'content-type' => 'application/json; charset=utf-8'
-        }
-  
-        # prepare and execute HttpRequest
-        @logger.info('Preparing and executing HttpRequest for create_order.')
-        _request = @http_client.post _query_url, headers: _headers, parameters: body.to_json
-        BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'create_order')
-        validate_response(_context)
-  
-        # return appropriate response type
-        @logger.info("Returning response for create_order.")
-        decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        return OrderModel.from_hash(decoded)
+    class << self
+      attr_accessor :instance
+    end
 
-      rescue Exception => e
-        @logger.error(e)
-        raise e
-      end
+    def instance
+      self.class.instance
     end
 
-    # TODO: type endpoint description here
-    # @param [String] reference_order_id Required parameter: Reference Order ID
+    # Retrieves a single order
+    # @param [String] reference_order_id Required parameter: Reference Order
+    # ID
     # @return OrderModel response from the API call
     def get_order(reference_order_id)
       begin
         @logger.info("get_order called.")
-  
-        # validate required parameters
+        # Validate required parameters.
         @logger.info("Validating required parameters for get_order.")
-        validate_parameters({
+        validate_parameters(
           'reference_order_id' => reference_order_id
-        })
-  
-        # prepare query url
+        )
+        # Prepare query url.
         @logger.info("Preparing query URL for get_order.")
-        _query_builder = Configuration.get_base_uri()
+        _query_builder = Configuration.get_base_uri
         _query_builder << '/orders/{referenceOrderID}'
-        _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        _query_builder = APIHelper.append_url_with_template_parameters(
+          _query_builder,
           'referenceOrderID' => reference_order_id
-        }
+        )
         _query_url = APIHelper.clean_url _query_builder
   
-        # prepare headers
+        # Prepare headers.
         @logger.info("Preparing headers for get_order.")
         _headers = {
           'accept' => 'application/json'
         }
   
-        # prepare and execute HttpRequest
+        # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for get_order.')
-        _request = @http_client.get _query_url, headers: _headers
+        _request = @http_client.get(
+          _query_url,
+          headers: _headers
+        )
         BasicAuth.apply(_request)
         _context = execute_request(_request, name: 'get_order')
+  
+        # Validate response against endpoint and global error codes.
+        @logger.info("Validating response for get_order.")
+        unless _context.response.status_code.between?(200, 208)
+          raise RaasGenericException.new(
+            'API Error',
+            _context
+          )
+        end
         validate_response(_context)
   
-        # return appropriate response type
+        # Return appropriate response type.
         @logger.info("Returning response for get_order.")
         decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        return OrderModel.from_hash(decoded)
+        OrderModel.from_hash(decoded)
 
       rescue Exception => e
         @logger.error(e)
@@ -98,45 +72,57 @@ module Raas
       end
     end
 
-    # TODO: type endpoint description here
-    # @param [String] reference_order_id Required parameter: Example: 
+    # Resends an order
+    # @param [String] reference_order_id Required parameter: The order's
+    # reference order id
     # @return ResendOrderResponseModel response from the API call
     def create_resend_order(reference_order_id)
       begin
         @logger.info("create_resend_order called.")
-  
-        # validate required parameters
+        # Validate required parameters.
         @logger.info("Validating required parameters for create_resend_order.")
-        validate_parameters({
+        validate_parameters(
           'reference_order_id' => reference_order_id
-        })
-  
-        # prepare query url
+        )
+        # Prepare query url.
         @logger.info("Preparing query URL for create_resend_order.")
-        _query_builder = Configuration.get_base_uri()
+        _query_builder = Configuration.get_base_uri
         _query_builder << '/orders/{referenceOrderID}/resends'
-        _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
+        _query_builder = APIHelper.append_url_with_template_parameters(
+          _query_builder,
           'referenceOrderID' => reference_order_id
-        }
+        )
         _query_url = APIHelper.clean_url _query_builder
   
-        # prepare headers
+        # Prepare headers.
         @logger.info("Preparing headers for create_resend_order.")
         _headers = {
           'accept' => 'application/json'
         }
   
-        # prepare and execute HttpRequest
+        # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for create_resend_order.')
-        _request = @http_client.post _query_url, headers: _headers
+        _request = @http_client.post(
+          _query_url,
+          headers: _headers
+        )
         BasicAuth.apply(_request)
         _context = execute_request(_request, name: 'create_resend_order')
+  
+        # Validate response against endpoint and global error codes.
+        @logger.info("Validating response for create_resend_order.")
+        unless _context.response.status_code.between?(200, 208)
+          raise RaasGenericException.new(
+            'API Error',
+            _context
+          )
+        end
         validate_response(_context)
   
-        # return appropriate response type
+        # Return appropriate response type.
         @logger.info("Returning response for create_resend_order.")
         decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        return ResendOrderResponseModel.from_hash(decoded)
+        ResendOrderResponseModel.from_hash(decoded)
 
       rescue Exception => e
         @logger.error(e)
@@ -144,51 +130,126 @@ module Raas
       end
     end
 
-    # TODO: type endpoint description here
-    # @param [String] account_identifier Optional parameter: Example: 
-    # @param [String] customer_identifier Optional parameter: Example: 
-    # @param [String] external_ref_id Optional parameter: Example: 
-    # @param [DateTime] start_date Optional parameter: Example: 
-    # @param [DateTime] end_date Optional parameter: Example: 
-    # @param [Integer] elements_per_block Optional parameter: Example: 
-    # @param [Integer] page Optional parameter: Example: 
+    # Retrieves a list of orders under a platform
+    # @param [String] account_identifier Optional parameter: Account
+    # identifier
+    # @param [String] customer_identifier Optional parameter: Customer
+    # identifier
+    # @param [String] external_ref_id Optional parameter: External reference
+    # id
+    # @param [DateTime] start_date Optional parameter: The start date
+    # @param [DateTime] end_date Optional parameter: The end date
+    # @param [Integer] elements_per_block Optional parameter: The number of
+    # elements per page
+    # @param [Integer] page Optional parameter: The page number to return
     # @return GetOrdersResponseModel response from the API call
-    def get_orders(options = Hash.new)
+    def get_orders(options = {})
       begin
         @logger.info("get_orders called.")
-  
-        # prepare query url
+        # Prepare query url.
         @logger.info("Preparing query URL for get_orders.")
-        _query_builder = Configuration.get_base_uri()
+        _query_builder = Configuration.get_base_uri
         _query_builder << '/orders'
-        _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
-          'accountIdentifier' => options['account_identifier'],
-          'customerIdentifier' => options['customer_identifier'],
-          'externalRefID' => options['external_ref_id'],
-          'startDate' => options['start_date'],
-          'endDate' => options['end_date'],
-          'elementsPerBlock' => options['elements_per_block'],
-          'page' => options['page']
-        }, array_serialization: Configuration.array_serialization
+        _query_builder = APIHelper.append_url_with_query_parameters(
+          _query_builder,
+          {
+            'accountIdentifier' => options['account_identifier'],
+            'customerIdentifier' => options['customer_identifier'],
+            'externalRefID' => options['external_ref_id'],
+            'startDate' => options['start_date'],
+            'endDate' => options['end_date'],
+            'elementsPerBlock' => options['elements_per_block'],
+            'page' => options['page']
+          },
+          array_serialization: Configuration.array_serialization
+        )
         _query_url = APIHelper.clean_url _query_builder
   
-        # prepare headers
+        # Prepare headers.
         @logger.info("Preparing headers for get_orders.")
         _headers = {
           'accept' => 'application/json'
         }
   
-        # prepare and execute HttpRequest
+        # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for get_orders.')
-        _request = @http_client.get _query_url, headers: _headers
+        _request = @http_client.get(
+          _query_url,
+          headers: _headers
+        )
         BasicAuth.apply(_request)
         _context = execute_request(_request, name: 'get_orders')
+  
+        # Validate response against endpoint and global error codes.
+        @logger.info("Validating response for get_orders.")
+        unless _context.response.status_code.between?(200, 208)
+          raise RaasGenericException.new(
+            'API Error',
+            _context
+          )
+        end
         validate_response(_context)
   
-        # return appropriate response type
+        # Return appropriate response type.
         @logger.info("Returning response for get_orders.")
         decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        return GetOrdersResponseModel.from_hash(decoded)
+        GetOrdersResponseModel.from_hash(decoded)
+
+      rescue Exception => e
+        @logger.error(e)
+        raise e
+      end
+    end
+
+    # Places an order
+    # @param [CreateOrderRequestModel] body Required parameter: A
+    # CreateOrderRequest object
+    # @return OrderModel response from the API call
+    def create_order(body)
+      begin
+        @logger.info("create_order called.")
+        # Validate required parameters.
+        @logger.info("Validating required parameters for create_order.")
+        validate_parameters(
+          'body' => body
+        )
+        # Prepare query url.
+        @logger.info("Preparing query URL for create_order.")
+        _query_builder = Configuration.get_base_uri
+        _query_builder << '/orders'
+        _query_url = APIHelper.clean_url _query_builder
+  
+        # Prepare headers.
+        @logger.info("Preparing headers for create_order.")
+        _headers = {
+          'accept' => 'application/json',
+          'content-type' => 'application/json; charset=utf-8'
+        }
+  
+        # Prepare and execute HttpRequest.
+        @logger.info('Preparing and executing HttpRequest for create_order.')
+        _request = @http_client.post(
+          _query_url,
+          headers: _headers,
+          parameters: body.to_json
+        )
+        BasicAuth.apply(_request)
+        _context = execute_request(_request, name: 'create_order')
+  
+        # Validate response against endpoint and global error codes.
+        @logger.info("Validating response for create_order.")
+        unless _context.response.status_code.between?(200, 208)
+          raise RaasGenericException.new(
+            'API Error',
+            _context
+          )
+        end
+        validate_response(_context)
+  
+        # Return appropriate response type.
+        @logger.info("Returning response for create_order.")
+        decoded = APIHelper.json_deserialize(_context.response.raw_body)
+        OrderModel.from_hash(decoded)
 
       rescue Exception => e
         @logger.error(e)

data/lib/raas/controllers/status_controller.rb

@@ -1,41 +1,58 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module Raas
+  # StatusController
   class StatusController < BaseController
-    @@instance = StatusController.new
-    # Singleton instance of the controller class
-    def self.instance
-      @@instance
+    @instance = StatusController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
     end
 
-    # Retrieve system status
+    # Retrieves system status
     # @return SystemStatusResponseModel response from the API call
     def get_system_status
       begin
         @logger.info("get_system_status called.")
-  
-        # prepare query url
+        # Prepare query url.
         @logger.info("Preparing query URL for get_system_status.")
-        _query_builder = Configuration.get_base_uri()
+        _query_builder = Configuration.get_base_uri
         _query_builder << '/pulse'
         _query_url = APIHelper.clean_url _query_builder
   
-        # prepare headers
+        # Prepare headers.
         @logger.info("Preparing headers for get_system_status.")
         _headers = {
           'accept' => 'application/json'
         }
   
-        # prepare and execute HttpRequest
+        # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for get_system_status.')
-        _request = @http_client.get _query_url, headers: _headers
+        _request = @http_client.get(
+          _query_url,
+          headers: _headers
+        )
         _context = execute_request(_request, name: 'get_system_status')
+  
+        # Validate response against endpoint and global error codes.
+        @logger.info("Validating response for get_system_status.")
+        unless _context.response.status_code.between?(200, 208)
+          raise RaasGenericException.new(
+            'API Error',
+            _context
+          )
+        end
         validate_response(_context)
   
-        # return appropriate response type
+        # Return appropriate response type.
         @logger.info("Returning response for get_system_status.")
         decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        return SystemStatusResponseModel.from_hash(decoded)
+        SystemStatusResponseModel.from_hash(decoded)
 
       rescue Exception => e
         @logger.error(e)

data/lib/raas/exceptions/api_exception.rb

@@ -1,11 +1,13 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module Raas
+  # Class for exceptions when there is a network error, status code error, etc.
   class APIException < StandardError
     attr_reader :context, :response_code
 
     # The constructor.
-    # @param [String] The reason for raising an exception
+    # @param [String] The reason for raising an exception.
     # @param [HttpContext] The HttpContext of the API call.
     def initialize(reason, context)
       super(reason)

data/lib/raas/exceptions/raas_client_exception.rb

@@ -1,7 +1,9 @@
-# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for Tango Card, Inc. by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 require 'date'
 module Raas
+  # RaaS API 4xx Exception
   class RaasClientException < APIException
     # Request timestamp
     # @return [DateTime]
@@ -28,30 +30,30 @@ module Raas
     attr_accessor :errors
 
     # The constructor.
-    # @param [String] The reason for raising an exception
+    # @param [String] The reason for raising an exception.
     # @param [HttpContext] The HttpContext of the API call.
     def initialize(reason, context)
       super(reason, context)
-      begin
-        hash = APIHelper.json_deserialize(@context.response.raw_body)
-        unbox(hash)
-      rescue TypeError
-      end
+      hash = APIHelper.json_deserialize(@context.response.raw_body)
+      unbox(hash)
     end
 
     # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the response body.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
     def unbox(hash)
-      @timestamp = DateTime.rfc3339(hash['timestamp']) if hash['timestamp']
+      @timestamp = APIHelper.rfc3339(hash['timestamp']) if hash['timestamp']
       @request_id = hash['requestId']
       @path = hash['path']
       @http_code = hash['httpCode']
       @http_phrase = hash['httpPhrase']
       # Parameter is an array, so we need to iterate through it
       @errors = nil
-      if hash['errors'] != nil
-        @errors = Array.new
-        hash['errors'].each{|structure| @errors << (RaasClientErrorModel.from_hash(structure) if structure)}
+      unless hash['errors'].nil?
+        @errors = []
+        hash['errors'].each do |structure|
+          @errors << (RaasClientErrorModel.from_hash(structure) if structure)
+        end
       end
     end
   end