digital-payments-sdk 1.0.0 → 1.1.0

data/lib/{shell_ev → shell_smart_pay_api}/exceptions/station_locator_unauthorized_exception.rb

@@ -1,9 +1,9 @@
-# shell_ev
+# shell_smart_pay_api
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module ShellEv
+module ShellSmartPayApi
   # StationLocatorUnauthorized class.
   class StationLocatorUnauthorizedException < APIException
     SKIP = Object.new
@@ -15,24 +15,37 @@ module ShellEv
 
     # TODO: Write general description for this method
     # @return [String]
-    attr_accessor :error_description
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@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.
-    def unbox(hash)
+    attr_accessor :error_description
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@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.
+    def unbox(hash)
       @error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
       @error_description =
         hash.key?('errorDescription') ? hash['errorDescription'] : SKIP
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code}, error_description: #{@error_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code.inspect}, error_description:"\
+      " #{@error_description.inspect}>"
+    end
   end
 end

data/lib/{shell_ev → shell_smart_pay_api}/http/auth/mpp_token.rb

@@ -1,9 +1,9 @@
-# shell_ev
+# shell_smart_pay_api
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module ShellEv
+module ShellSmartPayApi
   # Utility class for custom header authorization.
   class MppToken < CoreLibrary::HeaderAuth
     # Display error message on occurrence of authentication failure.

data/lib/{shell_ev → shell_smart_pay_api}/http/auth/o_auth_token_post.rb

@@ -1,9 +1,9 @@
-# shell_ev
+# shell_smart_pay_api
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module ShellEv
+module ShellSmartPayApi
   # Utility class for custom header authorization.
   class OAuthTokenPost < CoreLibrary::HeaderAuth
     # Display error message on occurrence of authentication failure.

data/lib/{shell_ev → shell_smart_pay_api}/http/http_call_back.rb

@@ -1,9 +1,9 @@
-# shell_ev
+# shell_smart_pay_api
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module ShellEv
+module ShellSmartPayApi
   # HttpCallBack allows defining callables for pre and post API calls.
   class HttpCallBack < CoreLibrary::HttpCallback
   end

data/lib/{shell_ev → shell_smart_pay_api}/http/http_method_enum.rb

@@ -1,9 +1,9 @@
-# shell_ev
+# shell_smart_pay_api
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module ShellEv
+module ShellSmartPayApi
   # HTTP Methods Enumeration.
   class HttpMethodEnum < CoreLibrary::HttpMethod
   end

data/lib/{shell_ev → shell_smart_pay_api}/http/http_request.rb

@@ -1,9 +1,9 @@
-# shell_ev
+# shell_smart_pay_api
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module ShellEv
+module ShellSmartPayApi
   # Represents a single Http Request.
   class HttpRequest < CoreLibrary::HttpRequest
   end

data/lib/{shell_ev → shell_smart_pay_api}/http/http_response.rb

@@ -1,9 +1,9 @@
-# shell_ev
+# shell_smart_pay_api
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module ShellEv
+module ShellSmartPayApi
   # Http response received.
   class HttpResponse < CoreLibrary::HttpResponse
   end

data/lib/{shell_ev → shell_smart_pay_api}/models/access_token_response.rb

@@ -1,9 +1,9 @@
-# shell_ev
+# shell_smart_pay_api
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module ShellEv
+module ShellSmartPayApi
   # AccessTokenResponse Model.
   class AccessTokenResponse < BaseModel
     SKIP = Object.new
@@ -45,8 +45,7 @@ module ShellEv
       []
     end
 
-    def initialize(access_token = SKIP,
-                   expires_in = SKIP,
+    def initialize(access_token = SKIP, expires_in = SKIP,
                    token_type = 'Bearer')
       @access_token = access_token unless access_token == SKIP
       @expires_in = expires_in unless expires_in == SKIP
@@ -67,5 +66,19 @@ module ShellEv
                               expires_in,
                               token_type)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} access_token: #{@access_token}, expires_in: #{@expires_in}, token_type:"\
+      " #{@token_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} access_token: #{@access_token.inspect}, expires_in: #{@expires_in.inspect},"\
+      " token_type: #{@token_type.inspect}>"
+    end
   end
 end

data/lib/{shell_ev → shell_smart_pay_api}/models/around_location_array.rb

@@ -1,9 +1,9 @@
-# shell_ev
+# shell_smart_pay_api
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module ShellEv
+module ShellSmartPayApi
   # #Amenities The table below lists all the different types of amenities:  |
   # Code    | Description                               | ------- | --------
   #                              | 1       | ATM
@@ -62,7 +62,7 @@ module ShellEv
     private_constant :SKIP
 
     # An array of station objects
-    # @return [Array[AroundLocationArrayDataItems]]
+    # @return [Array[Datum]]
     attr_accessor :data
 
     # A mapping from model property names to API property names.
@@ -96,7 +96,7 @@ module ShellEv
       unless hash['data'].nil?
         data = []
         hash['data'].each do |structure|
-          data << (AroundLocationArrayDataItems.from_hash(structure) if structure)
+          data << (Datum.from_hash(structure) if structure)
         end
       end
 
@@ -105,5 +105,17 @@ module ShellEv
       # Create object from extracted values.
       AroundLocationArray.new(data)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data.inspect}>"
+    end
   end
 end

data/lib/shell_smart_pay_api/models/base_model.rb

@@ -0,0 +1,110 @@
+# shell_smart_pay_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellSmartPayApi
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end

data/lib/{shell_ev → shell_smart_pay_api}/models/cancel_fueling_error_response.rb

@@ -1,9 +1,9 @@
-# shell_ev
+# shell_smart_pay_api
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module ShellEv
+module ShellSmartPayApi
   # # Digital Payments – Errors  This section details the structure of the
   # response Body vs. the different types of errors that could be returned when
   # Digital Payments system responds with a 400 Response Code.   | Error Code
@@ -56,9 +56,7 @@ module ShellEv
       []
     end
 
-    def initialize(error_code = SKIP,
-                   error_description = SKIP,
-                   errors = SKIP)
+    def initialize(error_code = SKIP, error_description = SKIP, errors = SKIP)
       @error_code = error_code unless error_code == SKIP
       @error_description = error_description unless error_description == SKIP
       @errors = errors unless errors == SKIP
@@ -88,5 +86,19 @@ module ShellEv
                                      error_description,
                                      errors)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code}, error_description: #{@error_description},"\
+      " errors: #{@errors}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code.inspect}, error_description:"\
+      " #{@error_description.inspect}, errors: #{@errors.inspect}>"
+    end
   end
 end

data/lib/{shell_ev → shell_smart_pay_api}/models/cancel_fueling_request.rb

@@ -1,9 +1,9 @@
-# shell_ev
+# shell_smart_pay_api
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module ShellEv
+module ShellSmartPayApi
   # CancelFuelingRequest Model.
   class CancelFuelingRequest < BaseModel
     SKIP = Object.new
@@ -38,8 +38,7 @@ module ShellEv
       []
     end
 
-    def initialize(mpp_transaction_id = SKIP,
-                   reason_code = SKIP)
+    def initialize(mpp_transaction_id = SKIP, reason_code = SKIP)
       @mpp_transaction_id = mpp_transaction_id unless mpp_transaction_id == SKIP
       @reason_code = reason_code unless reason_code == SKIP
     end
@@ -57,5 +56,18 @@ module ShellEv
       CancelFuelingRequest.new(mpp_transaction_id,
                                reason_code)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} mpp_transaction_id: #{@mpp_transaction_id}, reason_code: #{@reason_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} mpp_transaction_id: #{@mpp_transaction_id.inspect}, reason_code:"\
+      " #{@reason_code.inspect}>"
+    end
   end
 end

data/lib/{shell_ev → shell_smart_pay_api}/models/collecting_company.rb

@@ -1,9 +1,9 @@
-# shell_ev
+# shell_smart_pay_api
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module ShellEv
+module ShellSmartPayApi
   # CollectingCompany Model.
   class CollectingCompany < BaseModel
     SKIP = Object.new
@@ -46,5 +46,17 @@ module ShellEv
       # Create object from extracted values.
       CollectingCompany.new(col_co_id)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} col_co_id: #{@col_co_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} col_co_id: #{@col_co_id.inspect}>"
+    end
   end
 end

data/lib/{shell_ev/models/around_location_array_data_items.rb → shell_smart_pay_api/models/datum.rb}

@@ -1,11 +1,11 @@
-# shell_ev
+# shell_smart_pay_api
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module ShellEv
-  # AroundLocationArrayDataItems Model.
-  class AroundLocationArrayDataItems < BaseModel
+module ShellSmartPayApi
+  # Datum Model.
+  class Datum < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
@@ -77,7 +77,7 @@ module ShellEv
     attr_accessor :fuel
 
     # Object containing address details/elements
-    # @return [AroundLocationArrayDataItemsLoc]
+    # @return [Loc]
     attr_accessor :loc
 
     # This is the 5-digit Shell Station ID. Leading ‘0’ should be dropped and
@@ -104,7 +104,7 @@ module ShellEv
 
     # An Array of the station’s opening hours. This may have opening and closing
     # times in hours, minutes and the day of the week.
-    # @return [Array[AroundLocationArrayDataItemsOpeningHoursItems]]
+    # @return [Array[OpeningHour]]
     attr_accessor :opening_hours
 
     # Station’s contact telephone number
@@ -143,6 +143,16 @@ module ShellEv
     # An array for optional fields
     def self.optionals
       %w[
+        id
+        type
+        name
+        addr
+        lat
+        lon
+        amen
+        fuel
+        loc
+        mpp_station_id
         double_site_id
         opening_hours
         telephone
@@ -156,31 +166,21 @@ module ShellEv
       []
     end
 
-    def initialize(id = nil,
-                   type = nil,
-                   name = nil,
-                   addr = nil,
-                   lat = nil,
-                   lon = nil,
-                   amen = nil,
-                   fuel = nil,
-                   loc = nil,
-                   mpp_station_id = nil,
-                   double_site_id = SKIP,
-                   opening_hours = SKIP,
-                   telephone = SKIP,
-                   authorisation_code = SKIP,
-                   mp_preauth = SKIP)
-      @id = id
-      @type = type
-      @name = name
-      @addr = addr
-      @lat = lat
-      @lon = lon
-      @amen = amen
-      @fuel = fuel
-      @loc = loc
-      @mpp_station_id = mpp_station_id
+    def initialize(id = SKIP, type = SKIP, name = SKIP, addr = SKIP, lat = SKIP,
+                   lon = SKIP, amen = SKIP, fuel = SKIP, loc = SKIP,
+                   mpp_station_id = SKIP, double_site_id = SKIP,
+                   opening_hours = SKIP, telephone = SKIP,
+                   authorisation_code = SKIP, mp_preauth = SKIP)
+      @id = id unless id == SKIP
+      @type = type unless type == SKIP
+      @name = name unless name == SKIP
+      @addr = addr unless addr == SKIP
+      @lat = lat unless lat == SKIP
+      @lon = lon unless lon == SKIP
+      @amen = amen unless amen == SKIP
+      @fuel = fuel unless fuel == SKIP
+      @loc = loc unless loc == SKIP
+      @mpp_station_id = mpp_station_id unless mpp_station_id == SKIP
       @double_site_id = double_site_id unless double_site_id == SKIP
       @opening_hours = opening_hours unless opening_hours == SKIP
       @telephone = telephone unless telephone == SKIP
@@ -193,17 +193,17 @@ module ShellEv
       return nil unless hash
 
       # Extract variables from the hash.
-      id = hash.key?('id') ? hash['id'] : nil
-      type = hash.key?('type') ? hash['type'] : nil
-      name = hash.key?('name') ? hash['name'] : nil
-      addr = hash.key?('addr') ? hash['addr'] : nil
-      lat = hash.key?('lat') ? hash['lat'] : nil
-      lon = hash.key?('lon') ? hash['lon'] : nil
-      amen = hash.key?('amen') ? hash['amen'] : nil
-      fuel = hash.key?('fuel') ? hash['fuel'] : nil
-      loc = AroundLocationArrayDataItemsLoc.from_hash(hash['loc']) if hash['loc']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      addr = hash.key?('addr') ? hash['addr'] : SKIP
+      lat = hash.key?('lat') ? hash['lat'] : SKIP
+      lon = hash.key?('lon') ? hash['lon'] : SKIP
+      amen = hash.key?('amen') ? hash['amen'] : SKIP
+      fuel = hash.key?('fuel') ? hash['fuel'] : SKIP
+      loc = Loc.from_hash(hash['loc']) if hash['loc']
       mpp_station_id =
-        hash.key?('mpp_station_id') ? hash['mpp_station_id'] : nil
+        hash.key?('mpp_station_id') ? hash['mpp_station_id'] : SKIP
       double_site_id =
         hash.key?('double_site_id') ? hash['double_site_id'] : SKIP
       # Parameter is an array, so we need to iterate through it
@@ -211,7 +211,7 @@ module ShellEv
       unless hash['opening_hours'].nil?
         opening_hours = []
         hash['opening_hours'].each do |structure|
-          opening_hours << (AroundLocationArrayDataItemsOpeningHoursItems.from_hash(structure) if structure)
+          opening_hours << (OpeningHour.from_hash(structure) if structure)
         end
       end
 
@@ -222,21 +222,42 @@ module ShellEv
       mp_preauth = hash.key?('mp_preauth') ? hash['mp_preauth'] : SKIP
 
       # Create object from extracted values.
-      AroundLocationArrayDataItems.new(id,
-                                       type,
-                                       name,
-                                       addr,
-                                       lat,
-                                       lon,
-                                       amen,
-                                       fuel,
-                                       loc,
-                                       mpp_station_id,
-                                       double_site_id,
-                                       opening_hours,
-                                       telephone,
-                                       authorisation_code,
-                                       mp_preauth)
+      Datum.new(id,
+                type,
+                name,
+                addr,
+                lat,
+                lon,
+                amen,
+                fuel,
+                loc,
+                mpp_station_id,
+                double_site_id,
+                opening_hours,
+                telephone,
+                authorisation_code,
+                mp_preauth)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, type: #{@type}, name: #{@name}, addr: #{@addr}, lat: #{@lat},"\
+      " lon: #{@lon}, amen: #{@amen}, fuel: #{@fuel}, loc: #{@loc}, mpp_station_id:"\
+      " #{@mpp_station_id}, double_site_id: #{@double_site_id}, opening_hours: #{@opening_hours},"\
+      " telephone: #{@telephone}, authorisation_code: #{@authorisation_code}, mp_preauth:"\
+      " #{@mp_preauth}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, type: #{@type.inspect}, name: #{@name.inspect}, addr:"\
+      " #{@addr.inspect}, lat: #{@lat.inspect}, lon: #{@lon.inspect}, amen: #{@amen.inspect},"\
+      " fuel: #{@fuel.inspect}, loc: #{@loc.inspect}, mpp_station_id: #{@mpp_station_id.inspect},"\
+      " double_site_id: #{@double_site_id.inspect}, opening_hours: #{@opening_hours.inspect},"\
+      " telephone: #{@telephone.inspect}, authorisation_code: #{@authorisation_code.inspect},"\
+      " mp_preauth: #{@mp_preauth.inspect}>"
     end
   end
 end