digital-payments-sdk 1.0.0

data/lib/shell_ev/models/payment_details_items.rb

@@ -0,0 +1,78 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # PaymentDetailsItems Model.
+  class PaymentDetailsItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of commercial transaction. Permitted value\:
+    #  *  B2B
+    # @return [String]
+    attr_accessor :payment_category
+
+    # The payment method used to make the transaction. Possible values include: 
+    #   *  euroShell
+    # @return [String]
+    attr_accessor :payment_method_id
+
+    # Object containing Payment Property details Please note:
+    #    All the attributes are optional as they serve all payment methods (i.e.
+    # different payment methods require different fields to be filled/mandated).
+    # As a result, some of these fields will be mandatory depending on the
+    # selected payment method and the API will return an error if they are not
+    # completed
+    # @return [PaymentProperties]
+    attr_accessor :payment_properties
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_category'] = 'paymentCategory'
+      @_hash['payment_method_id'] = 'paymentMethodId'
+      @_hash['payment_properties'] = 'paymentProperties'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_category
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_method_id = nil,
+                   payment_properties = nil,
+                   payment_category = SKIP)
+      @payment_category = payment_category unless payment_category == SKIP
+      @payment_method_id = payment_method_id
+      @payment_properties = payment_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      payment_method_id =
+        hash.key?('paymentMethodId') ? hash['paymentMethodId'] : nil
+      payment_properties = PaymentProperties.from_hash(hash['paymentProperties']) if
+        hash['paymentProperties']
+      payment_category =
+        hash.key?('paymentCategory') ? hash['paymentCategory'] : SKIP
+
+      # Create object from extracted values.
+      PaymentDetailsItems.new(payment_method_id,
+                              payment_properties,
+                              payment_category)
+    end
+  end
+end

data/lib/shell_ev/models/payment_enablement_response.rb

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

data/lib/shell_ev/models/payment_properties.rb

@@ -0,0 +1,169 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # Object containing Payment Property details Please note:    All the
+  # attributes are optional as they serve all payment methods (i.e. different
+  # payment methods require different fields to be filled/mandated). As a
+  # result, some of these fields will be mandatory depending on the selected
+  # payment method and the API will return an error if they are not completed
+  class PaymentProperties < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of payment (e.g. Credit Card, Debit Card)
+    # @return [String]
+    attr_accessor :payment_type
+
+    # This is only used for PayPal. During the creation of the user’s profile an
+    # ID (clientMetadataId) will have been created by PayPal and stored by
+    # Shell. Thus, when PayPal payments are made this ID must be included in
+    # order for the payment to be processed
+    # @return [String]
+    attr_accessor :client_metadata_id
+
+    # This is only used for ApplePay and AndroidPay. Users using either of these
+    # payment methods use device biometrics to authenticate themselves against
+    # their respective payment method/provider (e.g. retina, fingerprint).
+    # Successful authentication will result in Apple/Android issuing a Payment
+    # Token which should be specified here
+    # @return [String]
+    attr_accessor :token
+
+    # This is the payment identifier and it is only used for ApplePay and
+    # AndroidPay.
+    # @return [String]
+    attr_accessor :identifier
+
+    # This is the payment network (e.g. Visa, Mastercard) and it is only used
+    # for ApplePay and AndroidPay.
+    # @return [String]
+    attr_accessor :network
+
+    # This is only relevant for transactions made by B2B customers using the
+    # Shell Card payment method. The ‘cardIdentifier’ is the unique identifier
+    # provided by Commercial Fleet and shared with the Shell mobile payments
+    # platform. This reference ID is used in interactions with the Commercial
+    # Fleet application to retrieve the fueling token - use the cardIdentifier
+    # when requesting a DPAN.
+    # @return [String]
+    attr_accessor :card_identifier
+
+    # This is only relevant for transactions made by B2B customers using a Shell
+    # Card payment method. During set up of the user’s Shell Card it’s possible
+    # to configure the card such that users are forced to provide an odometer
+    # reading before a Sale can begin processing. This field must be filled if
+    # the B2B user’s Shell Card has been configured this way but will be left
+    # blank in all other cases.
+    # @return [String]
+    attr_accessor :odometer
+
+    # Only relevant if Customer attempting to pay with B2B Shell Card. Customers
+    # attempting to pay with a B2B Shell Card may have to specify their Fleet ID
+    # as an extra authorisation/security step. Shell Card configuration will
+    # determine whether or not Fleet ID needs to be provided. Please note this
+    # field is a 6 character numeric field.
+    # @return [String]
+    attr_accessor :fleet_id
+
+    # This is only used for transactions made by B2B customers using the Shell
+    # Card payment method. 
+    #  In this scenario the expectation is that :\ a B2B entity has been
+    # successfully created that includes the external party’s reference for the
+    # entity (e.g. Contract Number, VRN, customer email); a new Shell Card (SFC)
+    # has been successfully created; and Shell Card and B2B Entity have been
+    # linked. 
+    #  
+    #  externalRefId refers to the 3rd Parties External Reference for the B2B
+    # entity and will therefore be used to verify the Customer and SFC before
+    # attempting to process a payment using the SFC card
+    # @return [String]
+    attr_accessor :external_ref_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_type'] = 'paymentType'
+      @_hash['client_metadata_id'] = 'clientMetadataId'
+      @_hash['token'] = 'token'
+      @_hash['identifier'] = 'identifier'
+      @_hash['network'] = 'network'
+      @_hash['card_identifier'] = 'cardIdentifier'
+      @_hash['odometer'] = 'odometer'
+      @_hash['fleet_id'] = 'fleetId'
+      @_hash['external_ref_id'] = 'externalRefId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_type
+        client_metadata_id
+        token
+        identifier
+        network
+        odometer
+        fleet_id
+        external_ref_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_identifier = nil,
+                   payment_type = SKIP,
+                   client_metadata_id = SKIP,
+                   token = SKIP,
+                   identifier = SKIP,
+                   network = SKIP,
+                   odometer = SKIP,
+                   fleet_id = SKIP,
+                   external_ref_id = SKIP)
+      @payment_type = payment_type unless payment_type == SKIP
+      @client_metadata_id = client_metadata_id unless client_metadata_id == SKIP
+      @token = token unless token == SKIP
+      @identifier = identifier unless identifier == SKIP
+      @network = network unless network == SKIP
+      @card_identifier = card_identifier
+      @odometer = odometer unless odometer == SKIP
+      @fleet_id = fleet_id unless fleet_id == SKIP
+      @external_ref_id = external_ref_id unless external_ref_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.
+      card_identifier =
+        hash.key?('cardIdentifier') ? hash['cardIdentifier'] : nil
+      payment_type = hash.key?('paymentType') ? hash['paymentType'] : SKIP
+      client_metadata_id =
+        hash.key?('clientMetadataId') ? hash['clientMetadataId'] : SKIP
+      token = hash.key?('token') ? hash['token'] : SKIP
+      identifier = hash.key?('identifier') ? hash['identifier'] : SKIP
+      network = hash.key?('network') ? hash['network'] : SKIP
+      odometer = hash.key?('odometer') ? hash['odometer'] : SKIP
+      fleet_id = hash.key?('fleetId') ? hash['fleetId'] : SKIP
+      external_ref_id =
+        hash.key?('externalRefId') ? hash['externalRefId'] : SKIP
+
+      # Create object from extracted values.
+      PaymentProperties.new(card_identifier,
+                            payment_type,
+                            client_metadata_id,
+                            token,
+                            identifier,
+                            network,
+                            odometer,
+                            fleet_id,
+                            external_ref_id)
+    end
+  end
+end

data/lib/shell_ev/models/prepare_fueling_request.rb

@@ -0,0 +1,183 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # PrepareFuelingRequest Model.
+  class PrepareFuelingRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The user’s current latitude
+    # @return [Float]
+    attr_accessor :latitude
+
+    # The user’s current longitude
+    # @return [Float]
+    attr_accessor :longitude
+
+    # The maximum fuelling amount that can be purchased. If the prepare fuelling
+    # is successful and the Customer starts fuelling their car, the pump will
+    # cut off once this threshold is reached. For B2B customers a maximum
+    # ceiling is set against their Shell Card. As a result, this can be left
+    # blank for B2B customers. If a value is provided it cannot be zero or lower
+    # and values that exceed ceiling will be ignored.
+    # @return [Float]
+    attr_accessor :maximum_fueling_amount
+
+    # Expectation is that a user has to be located at a Shell petrol station in
+    # order to make this call. A user is recognised as being located at a Shell
+    # station if the user’s current location (as determined by GPS) is within
+    # 300 meters of a Shell station. Expectation is that requester will have
+    # established the Shell petrol station the user is located at prior to
+    # making this call by calling Station Locator APIs. The API will use
+    # stationId and siteCountry/GPS to verify the user is The user’s current
+    # latitude genuinely located at the specified Station. ‘mpp_station_id’ of
+    # the Station Locator API should be used. Leading ‘0’ should be dropped and
+    # only last four digits, should be used. E.G. for ‘00123’, only ‘0123’
+    # should be used and for ‘04567’ only ‘4567’ should be used.
+    # @return [String]
+    attr_accessor :station_id
+
+    # A two digit numeric number of the pump as marked on the forecourt (e.g.
+    # pump number 12)
+    # @return [String]
+    attr_accessor :pump_id
+
+    # Object containing Loyalty details
+    # @return [Array[LoyaltyDetails]]
+    attr_accessor :loyalty_details
+
+    # The ID of the source application making this call. Each 3rd Party will be
+    # issued with its own sourceApp ID that must be specified correctly here
+    #  *   3rdParty_App_Archetype
+    # @return [String]
+    attr_accessor :source_application
+
+    # The type of device making this call. Permitted values for deviceType:
+    #  *  car
+    #  *  phone
+    # @return [String]
+    attr_accessor :device_type
+
+    # Object containing Payment details
+    # @return [Array[PaymentDetailsItems]]
+    attr_accessor :payment_details
+
+    # Object containing device details
+    # @return [Array[PrepareFuelingRequestDeviceDetailsItems]]
+    attr_accessor :device_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['latitude'] = 'latitude'
+      @_hash['longitude'] = 'longitude'
+      @_hash['maximum_fueling_amount'] = 'maximumFuelingAmount'
+      @_hash['station_id'] = 'stationId'
+      @_hash['pump_id'] = 'pumpId'
+      @_hash['loyalty_details'] = 'loyaltyDetails'
+      @_hash['source_application'] = 'sourceApplication'
+      @_hash['device_type'] = 'deviceType'
+      @_hash['payment_details'] = 'paymentDetails'
+      @_hash['device_details'] = 'deviceDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        maximum_fueling_amount
+        loyalty_details
+        device_type
+        device_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(latitude = nil,
+                   longitude = nil,
+                   station_id = nil,
+                   pump_id = nil,
+                   source_application = nil,
+                   payment_details = nil,
+                   maximum_fueling_amount = SKIP,
+                   loyalty_details = SKIP,
+                   device_type = SKIP,
+                   device_details = SKIP)
+      @latitude = latitude
+      @longitude = longitude
+      @maximum_fueling_amount = maximum_fueling_amount unless maximum_fueling_amount == SKIP
+      @station_id = station_id
+      @pump_id = pump_id
+      @loyalty_details = loyalty_details unless loyalty_details == SKIP
+      @source_application = source_application
+      @device_type = device_type unless device_type == SKIP
+      @payment_details = payment_details
+      @device_details = device_details unless device_details == 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.
+      latitude = hash.key?('latitude') ? hash['latitude'] : nil
+      longitude = hash.key?('longitude') ? hash['longitude'] : nil
+      station_id = hash.key?('stationId') ? hash['stationId'] : nil
+      pump_id = hash.key?('pumpId') ? hash['pumpId'] : nil
+      source_application =
+        hash.key?('sourceApplication') ? hash['sourceApplication'] : nil
+      # Parameter is an array, so we need to iterate through it
+      payment_details = nil
+      unless hash['paymentDetails'].nil?
+        payment_details = []
+        hash['paymentDetails'].each do |structure|
+          payment_details << (PaymentDetailsItems.from_hash(structure) if structure)
+        end
+      end
+
+      payment_details = nil unless hash.key?('paymentDetails')
+      maximum_fueling_amount =
+        hash.key?('maximumFuelingAmount') ? hash['maximumFuelingAmount'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      loyalty_details = nil
+      unless hash['loyaltyDetails'].nil?
+        loyalty_details = []
+        hash['loyaltyDetails'].each do |structure|
+          loyalty_details << (LoyaltyDetails.from_hash(structure) if structure)
+        end
+      end
+
+      loyalty_details = SKIP unless hash.key?('loyaltyDetails')
+      device_type = hash.key?('deviceType') ? hash['deviceType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      device_details = nil
+      unless hash['deviceDetails'].nil?
+        device_details = []
+        hash['deviceDetails'].each do |structure|
+          device_details << (PrepareFuelingRequestDeviceDetailsItems.from_hash(structure) if structure)
+        end
+      end
+
+      device_details = SKIP unless hash.key?('deviceDetails')
+
+      # Create object from extracted values.
+      PrepareFuelingRequest.new(latitude,
+                                longitude,
+                                station_id,
+                                pump_id,
+                                source_application,
+                                payment_details,
+                                maximum_fueling_amount,
+                                loyalty_details,
+                                device_type,
+                                device_details)
+    end
+  end
+end

data/lib/shell_ev/models/prepare_fueling_request_device_details_items.rb

@@ -0,0 +1,95 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # PrepareFuelingRequestDeviceDetailsItems Model.
+  class PrepareFuelingRequestDeviceDetailsItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This is the mobile device’s unique ID (Vendor ID for iOS vs. Android ID
+    # for Android). This is only used for transactions made via the Shell Mobile
+    # App and will therefore be mandatory for requests originating from Shell’s
+    # mobile app but can be ignored by all other parties.
+    # @return [String]
+    attr_accessor :device_id
+
+    # This is the mobile device’s model (machine name/systemInfo for iOS vs.
+    # Build.MODEL for Android).  This is only used for transactions made via the
+    # Shell Mobile App and will therefore be mandatory for requests originating
+    # from Shell’s mobile app but can be ignored by all other parties.
+    # @return [String]
+    attr_accessor :model
+
+    # This is the mobile device’s OS Version. This is only used for transactions
+    # made via the Shell Mobile App and will therefore be mandatory for requests
+    # originating from Shell’s mobile app but can be ignored by all other
+    # parties.
+    # @return [String]
+    attr_accessor :os_version
+
+    # This is only used for transactions made via Android versions of the Shell
+    # Mobile App and will therefore be mandatory for requests originating from
+    # Shell’s Android mobile app but can be ignored by all other devices and/or
+    # parties.
+    # This field is used to capture the Shell App build that was used to make
+    # this call.
+    # @return [String]
+    attr_accessor :other_device_information
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['model'] = 'model'
+      @_hash['os_version'] = 'osVersion'
+      @_hash['other_device_information'] = 'otherDeviceInformation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_id
+        model
+        os_version
+        other_device_information
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = SKIP,
+                   model = SKIP,
+                   os_version = SKIP,
+                   other_device_information = SKIP)
+      @device_id = device_id unless device_id == SKIP
+      @model = model unless model == SKIP
+      @os_version = os_version unless os_version == SKIP
+      @other_device_information = other_device_information unless other_device_information == 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.
+      device_id = hash.key?('deviceId') ? hash['deviceId'] : SKIP
+      model = hash.key?('model') ? hash['model'] : SKIP
+      os_version = hash.key?('osVersion') ? hash['osVersion'] : SKIP
+      other_device_information =
+        hash.key?('otherDeviceInformation') ? hash['otherDeviceInformation'] : SKIP
+
+      # Create object from extracted values.
+      PrepareFuelingRequestDeviceDetailsItems.new(device_id,
+                                                  model,
+                                                  os_version,
+                                                  other_device_information)
+    end
+  end
+end

data/lib/shell_ev/models/prepare_fueling_response.rb

@@ -0,0 +1,66 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # The response of prepare fueling returns
+  class PrepareFuelingResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier of the Order. NB at this stage the Customer hasn’t
+    # actually bought anything so there’s no formal transaction associated with
+    # the Order. A transaction is not processed until refuelling has been
+    # completed successfully and will be triggered by returning the nozzle to
+    # the pump.
+    # @return [String]
+    attr_accessor :mpp_transaction_id
+
+    # An array of Strings that contain the list of products that the user can
+    # purchase at the specified Station/Pump. The text is localized based on the
+    # country.
+    # @return [Array[String]]
+    attr_accessor :products
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mpp_transaction_id'] = 'mppTransactionId'
+      @_hash['products'] = 'products'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        products
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(mpp_transaction_id = nil,
+                   products = SKIP)
+      @mpp_transaction_id = mpp_transaction_id
+      @products = products unless products == 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'] : nil
+      products = hash.key?('products') ? hash['products'] : SKIP
+
+      # Create object from extracted values.
+      PrepareFuelingResponse.new(mpp_transaction_id,
+                                 products)
+    end
+  end
+end

data/lib/shell_ev/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module ShellEv
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/shell_ev/utilities/file_wrapper.rb

@@ -0,0 +1,16 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+  end
+end