digital-payments-sdk 1.0.0

data/lib/shell_ev/models/base_model.rb

@@ -0,0 +1,62 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Base model.
+  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..]
+        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
+      hash
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+end

data/lib/shell_ev/models/cancel_fueling_error_response.rb

@@ -0,0 +1,92 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # # 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
+  # | Error Description   | Suggested message to end user   |  |-  |-  |-  |  |
+  # 9342   | Transaction not cancelled, Txn number unknown   | Oops sorry! We
+  # are unable to cancel the transaction. Please wait for the site to cancel the
+  # transaction before you retry   |  | 50004   | Transaction not cancelled,
+  # dispensing is already in progress   | Transaction cannot be cancelled,
+  # fueling already in progress   |  | 50059   | Transaction not cancelable (not
+  # in a 'Processing state')   | Transaction cannot be cancelled, fuel has
+  # already been dispensed   |
+  class CancelFuelingErrorResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The high level error code (e.g. missing data)
+    # @return [String]
+    attr_accessor :error_code
+
+    # The high level error message (e.g. mandatory fields have not been
+    # specified.
+    # @return [String]
+    attr_accessor :error_description
+
+    # Array of error objects. Majority of the time the errorCode and
+    # errorDescription will suffice
+    # @return [Array[MppError]]
+    attr_accessor :errors
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error_code'] = 'errorCode'
+      @_hash['error_description'] = 'errorDescription'
+      @_hash['errors'] = 'errors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error_code
+        error_description
+        errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    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
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      error_description =
+        hash.key?('errorDescription') ? hash['errorDescription'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      errors = nil
+      unless hash['errors'].nil?
+        errors = []
+        hash['errors'].each do |structure|
+          errors << (MppError.from_hash(structure) if structure)
+        end
+      end
+
+      errors = SKIP unless hash.key?('errors')
+
+      # Create object from extracted values.
+      CancelFuelingErrorResponse.new(error_code,
+                                     error_description,
+                                     errors)
+    end
+  end
+end

data/lib/shell_ev/models/cancel_fueling_request.rb

@@ -0,0 +1,61 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # CancelFuelingRequest Model.
+  class CancelFuelingRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :mpp_transaction_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reason_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mpp_transaction_id'] = 'mppTransactionId'
+      @_hash['reason_code'] = 'reasonCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        mpp_transaction_id
+        reason_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    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
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      mpp_transaction_id =
+        hash.key?('mppTransactionId') ? hash['mppTransactionId'] : SKIP
+      reason_code = hash.key?('reasonCode') ? hash['reasonCode'] : SKIP
+
+      # Create object from extracted values.
+      CancelFuelingRequest.new(mpp_transaction_id,
+                               reason_code)
+    end
+  end
+end

data/lib/shell_ev/models/collecting_company.rb

@@ -0,0 +1,50 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # CollectingCompany Model.
+  class CollectingCompany < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the Collecting Company (in GFN), also known as Shell Code of the
+    # selected payer. This property is mandatory if the ColCoCode code is not
+    # passed
+    # @return [String]
+    attr_accessor :col_co_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(col_co_id = nil)
+      @col_co_id = col_co_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : nil
+
+      # Create object from extracted values.
+      CollectingCompany.new(col_co_id)
+    end
+  end
+end

data/lib/shell_ev/models/fault_response.rb

@@ -0,0 +1,50 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # An error response.
+  class FaultResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [FaultResponseFault]
+    attr_accessor :fault
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fault'] = 'fault'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fault
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fault = SKIP)
+      @fault = fault unless fault == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      fault = FaultResponseFault.from_hash(hash['fault']) if hash['fault']
+
+      # Create object from extracted values.
+      FaultResponse.new(fault)
+    end
+  end
+end

data/lib/shell_ev/models/fault_response_fault.rb

@@ -0,0 +1,60 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # FaultResponseFault Model.
+  class FaultResponseFault < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The description of the error.
+    # @return [String]
+    attr_accessor :faultstring
+
+    # The description of the error.
+    # @return [FaultResponseFaultDetail]
+    attr_accessor :detail
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['faultstring'] = 'faultstring'
+      @_hash['detail'] = 'detail'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        faultstring
+        detail
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(faultstring = SKIP,
+                   detail = SKIP)
+      @faultstring = faultstring unless faultstring == SKIP
+      @detail = detail unless detail == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      faultstring = hash.key?('faultstring') ? hash['faultstring'] : SKIP
+      detail = FaultResponseFaultDetail.from_hash(hash['detail']) if hash['detail']
+
+      # Create object from extracted values.
+      FaultResponseFault.new(faultstring,
+                             detail)
+    end
+  end
+end

data/lib/shell_ev/models/fault_response_fault_detail.rb

@@ -0,0 +1,50 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # FaultResponseFaultDetail Model.
+  class FaultResponseFaultDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The error code.
+    # @return [String]
+    attr_accessor :errorcode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['errorcode'] = 'errorcode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        errorcode
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(errorcode = SKIP)
+      @errorcode = errorcode unless errorcode == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      errorcode = hash.key?('errorcode') ? hash['errorcode'] : SKIP
+
+      # Create object from extracted values.
+      FaultResponseFaultDetail.new(errorcode)
+    end
+  end
+end

data/lib/shell_ev/models/finalise_fueling_request.rb

@@ -0,0 +1,181 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # FinaliseFuelingRequest Model.
+  class FinaliseFuelingRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :site_name
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :timestamp
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :volume_quantity
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :volume_unit
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :final_price
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :currency
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :site_address
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :original_price
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :discount
+
+    # TODO: Write general description for this method
+    # @return [FinaliseFuelingRequestPayment]
+    attr_accessor :payment
+
+    # TODO: Write general description for this method
+    # @return [Array[FinaliseFuelingRequestProductsItems]]
+    attr_accessor :products
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :mpp_transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['site_name'] = 'siteName'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['volume_quantity'] = 'volumeQuantity'
+      @_hash['volume_unit'] = 'volumeUnit'
+      @_hash['final_price'] = 'finalPrice'
+      @_hash['currency'] = 'currency'
+      @_hash['status'] = 'status'
+      @_hash['site_address'] = 'siteAddress'
+      @_hash['original_price'] = 'originalPrice'
+      @_hash['discount'] = 'discount'
+      @_hash['payment'] = 'payment'
+      @_hash['products'] = 'products'
+      @_hash['mpp_transaction_id'] = 'mppTransactionId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        site_name
+        timestamp
+        volume_quantity
+        volume_unit
+        final_price
+        currency
+        status
+        site_address
+        original_price
+        discount
+        payment
+        products
+        mpp_transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(site_name = SKIP,
+                   timestamp = SKIP,
+                   volume_quantity = SKIP,
+                   volume_unit = SKIP,
+                   final_price = SKIP,
+                   currency = SKIP,
+                   status = SKIP,
+                   site_address = SKIP,
+                   original_price = SKIP,
+                   discount = SKIP,
+                   payment = SKIP,
+                   products = SKIP,
+                   mpp_transaction_id = SKIP)
+      @site_name = site_name unless site_name == SKIP
+      @timestamp = timestamp unless timestamp == SKIP
+      @volume_quantity = volume_quantity unless volume_quantity == SKIP
+      @volume_unit = volume_unit unless volume_unit == SKIP
+      @final_price = final_price unless final_price == SKIP
+      @currency = currency unless currency == SKIP
+      @status = status unless status == SKIP
+      @site_address = site_address unless site_address == SKIP
+      @original_price = original_price unless original_price == SKIP
+      @discount = discount unless discount == SKIP
+      @payment = payment unless payment == SKIP
+      @products = products unless products == SKIP
+      @mpp_transaction_id = mpp_transaction_id unless mpp_transaction_id == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      site_name = hash.key?('siteName') ? hash['siteName'] : SKIP
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+      volume_quantity =
+        hash.key?('volumeQuantity') ? hash['volumeQuantity'] : SKIP
+      volume_unit = hash.key?('volumeUnit') ? hash['volumeUnit'] : SKIP
+      final_price = hash.key?('finalPrice') ? hash['finalPrice'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      site_address = hash.key?('siteAddress') ? hash['siteAddress'] : SKIP
+      original_price = hash.key?('originalPrice') ? hash['originalPrice'] : SKIP
+      discount = hash.key?('discount') ? hash['discount'] : SKIP
+      payment = FinaliseFuelingRequestPayment.from_hash(hash['payment']) if hash['payment']
+      # Parameter is an array, so we need to iterate through it
+      products = nil
+      unless hash['products'].nil?
+        products = []
+        hash['products'].each do |structure|
+          products << (FinaliseFuelingRequestProductsItems.from_hash(structure) if structure)
+        end
+      end
+
+      products = SKIP unless hash.key?('products')
+      mpp_transaction_id =
+        hash.key?('mppTransactionId') ? hash['mppTransactionId'] : SKIP
+
+      # Create object from extracted values.
+      FinaliseFuelingRequest.new(site_name,
+                                 timestamp,
+                                 volume_quantity,
+                                 volume_unit,
+                                 final_price,
+                                 currency,
+                                 status,
+                                 site_address,
+                                 original_price,
+                                 discount,
+                                 payment,
+                                 products,
+                                 mpp_transaction_id)
+    end
+  end
+end

data/lib/shell_ev/models/finalise_fueling_request_payment.rb

@@ -0,0 +1,71 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # FinaliseFuelingRequestPayment Model.
+  class FinaliseFuelingRequestPayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :method
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :card_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :card_last_digits
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['method'] = 'method'
+      @_hash['card_id'] = 'cardId'
+      @_hash['card_last_digits'] = 'cardLastDigits'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        method
+        card_id
+        card_last_digits
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(method = SKIP,
+                   card_id = SKIP,
+                   card_last_digits = SKIP)
+      @method = method unless method == SKIP
+      @card_id = card_id unless card_id == SKIP
+      @card_last_digits = card_last_digits unless card_last_digits == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      method = hash.key?('method') ? hash['method'] : SKIP
+      card_id = hash.key?('cardId') ? hash['cardId'] : SKIP
+      card_last_digits =
+        hash.key?('cardLastDigits') ? hash['cardLastDigits'] : SKIP
+
+      # Create object from extracted values.
+      FinaliseFuelingRequestPayment.new(method,
+                                        card_id,
+                                        card_last_digits)
+    end
+  end
+end