digital-payments-sdk 1.0.0

data/lib/shell_ev/models/finalise_fueling_request_products_items.rb

@@ -0,0 +1,70 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # FinaliseFuelingRequestProductsItems Model.
+  class FinaliseFuelingRequestProductsItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_name
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :unit_price
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_id'] = 'productId'
+      @_hash['product_name'] = 'productName'
+      @_hash['unit_price'] = 'unitPrice'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_id
+        product_name
+        unit_price
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_id = SKIP,
+                   product_name = SKIP,
+                   unit_price = SKIP)
+      @product_id = product_id unless product_id == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @unit_price = unit_price unless unit_price == 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.
+      product_id = hash.key?('productId') ? hash['productId'] : SKIP
+      product_name = hash.key?('productName') ? hash['productName'] : SKIP
+      unit_price = hash.key?('unitPrice') ? hash['unitPrice'] : SKIP
+
+      # Create object from extracted values.
+      FinaliseFuelingRequestProductsItems.new(product_id,
+                                              product_name,
+                                              unit_price)
+    end
+  end
+end

data/lib/shell_ev/models/loyalty_details.rb

@@ -0,0 +1,59 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # LoyaltyDetails Model.
+  class LoyaltyDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The user’s Loyalty card number. Although this is optional the expectation
+    # is that if this is specified then loyaltyType must also be specified
+    # @return [String]
+    attr_accessor :loyalty_id
+
+    # Loyalty type being used, associated to the loyalty ID being passed.
+    # Possible values are 'Shell'
+    # @return [String]
+    attr_accessor :loyalty_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['loyalty_id'] = 'loyaltyId'
+      @_hash['loyalty_type'] = 'loyaltyType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(loyalty_id = nil,
+                   loyalty_type = nil)
+      @loyalty_id = loyalty_id
+      @loyalty_type = loyalty_type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      loyalty_id = hash.key?('loyaltyId') ? hash['loyaltyId'] : nil
+      loyalty_type = hash.key?('loyaltyType') ? hash['loyaltyType'] : nil
+
+      # Create object from extracted values.
+      LoyaltyDetails.new(loyalty_id,
+                         loyalty_type)
+    end
+  end
+end

data/lib/shell_ev/models/mobile_payment_registration_request.rb

@@ -0,0 +1,134 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # MobilePaymentRegistrationRequest Model.
+  class MobilePaymentRegistrationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique Reference ID the DPAN is registered to. The Reference ID has been
+    # implemented to accept normal alphanumeric characters plus the following
+    # ‘special characters’&colon;  dot, underscore and hyphen. The following
+    # characters are not acceptable&colon; , / @ !  &num; & * ()
+    # @return [String]
+    attr_accessor :reference_id
+
+    # Original card PAN (generated on creation of Card (see Card Order Service))
+    # @return [String]
+    attr_accessor :pan
+
+    # Expiry Date associated with the PAN in format YYMM.
+    # @return [String]
+    attr_accessor :pan_expiry
+
+    # Specifies how many months the DPAN should be valid for. If not present,
+    # the Token Server determines the expiry date using its default algorithm.
+    # Note that the Token Server might not respect this value and use configured
+    # business rules to override the requested validity period
+    # @return [Integer]
+    attr_accessor :period
+
+    # In Shell, a Payer can have several accounts (representing company
+    # branches, divisions or generally different cost-centers that a customer
+    # wants to group cards on). You can specify this property or the
+    # AccountNumber.
+    # @return [String]
+    attr_accessor :account_id
+
+    # The Payer Id, or the Customer Id of the Payment Customer. In Shell, a
+    # Payer is a customer belonging to a specific market geography. A Payer can
+    # have several Accounts; each account can then have different groups of
+    # cards.
+    # @return [String]
+    attr_accessor :payer_id
+
+    # 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
+
+    # Array of Colco Ids
+    # @return [Array[CollectingCompany]]
+    attr_accessor :collecting_companies
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reference_id'] = 'referenceId'
+      @_hash['pan'] = 'pan'
+      @_hash['pan_expiry'] = 'panExpiry'
+      @_hash['period'] = 'period'
+      @_hash['account_id'] = 'AccountId'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['collecting_companies'] = 'CollectingCompanies'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reference_id = nil,
+                   pan = nil,
+                   pan_expiry = nil,
+                   period = nil,
+                   account_id = nil,
+                   payer_id = nil,
+                   col_co_id = nil,
+                   collecting_companies = nil)
+      @reference_id = reference_id
+      @pan = pan
+      @pan_expiry = pan_expiry
+      @period = period
+      @account_id = account_id
+      @payer_id = payer_id
+      @col_co_id = col_co_id
+      @collecting_companies = collecting_companies
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reference_id = hash.key?('referenceId') ? hash['referenceId'] : nil
+      pan = hash.key?('pan') ? hash['pan'] : nil
+      pan_expiry = hash.key?('panExpiry') ? hash['panExpiry'] : nil
+      period = hash.key?('period') ? hash['period'] : nil
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : nil
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : nil
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : nil
+      # Parameter is an array, so we need to iterate through it
+      collecting_companies = nil
+      unless hash['CollectingCompanies'].nil?
+        collecting_companies = []
+        hash['CollectingCompanies'].each do |structure|
+          collecting_companies << (CollectingCompany.from_hash(structure) if structure)
+        end
+      end
+
+      collecting_companies = nil unless hash.key?('CollectingCompanies')
+
+      # Create object from extracted values.
+      MobilePaymentRegistrationRequest.new(reference_id,
+                                           pan,
+                                           pan_expiry,
+                                           period,
+                                           account_id,
+                                           payer_id,
+                                           col_co_id,
+                                           collecting_companies)
+    end
+  end
+end

data/lib/shell_ev/models/mpp_acces_token_response.rb

@@ -0,0 +1,81 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # MppAccesTokenResponse Model.
+  class MppAccesTokenResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # It is the token used in the requests that required to authenticate an
+    # user.
+    # @return [String]
+    attr_accessor :access_token
+
+    # type of token provided
+    # @return [String]
+    attr_accessor :token_type
+
+    # validity of the access token in seconds
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # scope for the authentication protocol
+    # @return [String]
+    attr_accessor :scope
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['token_type'] = 'token_type'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['scope'] = 'scope'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        access_token
+        token_type
+        expires_in
+        scope
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token = SKIP,
+                   token_type = 'bearer',
+                   expires_in = SKIP,
+                   scope = 'basic openid')
+      @access_token = access_token unless access_token == SKIP
+      @token_type = token_type unless token_type == SKIP
+      @expires_in = expires_in unless expires_in == SKIP
+      @scope = scope unless scope == 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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : SKIP
+      token_type = hash['token_type'] ||= 'bearer'
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      scope = hash['scope'] ||= 'basic openid'
+
+      # Create object from extracted values.
+      MppAccesTokenResponse.new(access_token,
+                                token_type,
+                                expires_in,
+                                scope)
+    end
+  end
+end

data/lib/shell_ev/models/mpp_error.rb

@@ -0,0 +1,94 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # MppError Model.
+  class MppError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Descriptive, human readable error message. Description of the error (e.g.
+    # This field is required and must to be between 1 and 255 characters long)
+    # @return [String]
+    attr_accessor :message
+
+    # Additional classification specific for each error type e.g. 'noStock'. The
+    # nature of the issue (e.g. missing)
+    # @return [String]
+    attr_accessor :reason
+
+    # Identifier of the related object e.g. '1'. The field/attribute with an
+    # issue (e.g. First Name)
+    # @return [String]
+    attr_accessor :subject
+
+    # Type of the object related to the error e.g. 'entry'. The item it relates
+    # to (e.g. Parameter)
+    # @return [String]
+    attr_accessor :subject_type
+
+    # Type of the error e.g. 'LowStockError', 'Validation Error'
+    # @return [String]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
+      @_hash['reason'] = 'reason'
+      @_hash['subject'] = 'subject'
+      @_hash['subject_type'] = 'subjectType'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        message
+        reason
+        subject
+        subject_type
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message = SKIP,
+                   reason = SKIP,
+                   subject = SKIP,
+                   subject_type = SKIP,
+                   type = SKIP)
+      @message = message unless message == SKIP
+      @reason = reason unless reason == SKIP
+      @subject = subject unless subject == SKIP
+      @subject_type = subject_type unless subject_type == SKIP
+      @type = type unless type == 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.
+      message = hash.key?('message') ? hash['message'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      subject = hash.key?('subject') ? hash['subject'] : SKIP
+      subject_type = hash.key?('subjectType') ? hash['subjectType'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      MppError.new(message,
+                   reason,
+                   subject,
+                   subject_type,
+                   type)
+    end
+  end
+end

data/lib/shell_ev/models/mpp_token_request_body.rb

@@ -0,0 +1,73 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # MppTokenRequestBody Model.
+  class MppTokenRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # In OAuth 2.0, the term grant type refers to the way an application gets an
+    # access token. OAuth 2.0 defines several grant types, including the
+    # authorization code flow.
+    # @return [String]
+    attr_accessor :grant_type
+
+    # After registering your app, you will receive a client ID and a client
+    # secret. The client ID is considered public information, and is used to
+    # build login URLs, or included in Javascript source code on a page.
+    # @return [String]
+    attr_accessor :client_id
+
+    # After registering your app, you will receive a client ID and a client
+    # secret. The client ID is considered public information, and is used to
+    # build login URLs, or included in Javascript source code on a page. The
+    # client secret must be kept confidential.
+    # @return [String]
+    attr_accessor :client_secret
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grant_type'] = 'grant_type'
+      @_hash['client_id'] = 'client_id'
+      @_hash['client_secret'] = 'client_secret'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(grant_type = nil,
+                   client_id = nil,
+                   client_secret = nil)
+      @grant_type = grant_type
+      @client_id = client_id
+      @client_secret = client_secret
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      grant_type = hash.key?('grant_type') ? hash['grant_type'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : nil
+      client_secret = hash.key?('client_secret') ? hash['client_secret'] : nil
+
+      # Create object from extracted values.
+      MppTokenRequestBody.new(grant_type,
+                              client_id,
+                              client_secret)
+    end
+  end
+end

data/lib/shell_ev/models/oauth_token_post_request_body.rb

@@ -0,0 +1,73 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # OauthTokenPostRequestBody Model.
+  class OauthTokenPostRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # In OAuth 2.0, the term grant typee refers to the way an application gets
+    # an access token. OAuth 2.0 defines several grant types, including the
+    # authorization code flow.
+    # @return [String]
+    attr_accessor :grant_type
+
+    # After registering your app, you will receive a client ID and a client
+    # secret. The client ID is considered public information, and is used to
+    # build login URLs, or included in Javascript source code on a page.
+    # @return [String]
+    attr_accessor :client_id
+
+    # After registering your app, you will receive a client ID and a client
+    # secret. The client ID is considered public information, and is used to
+    # build login URLs, or included in Javascript source code on a page. The
+    # client secret must be kept confidential.
+    # @return [String]
+    attr_accessor :client_secret
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grant_type'] = 'grant_type'
+      @_hash['client_id'] = 'client_id'
+      @_hash['client_secret'] = 'client_secret'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(grant_type = 'client_credentials',
+                   client_id = 'SOFflRakNlwnWlxfOXQ4GHDVyqGawuKA',
+                   client_secret = 'cRnWgw7gACqM3gVS')
+      @grant_type = grant_type
+      @client_id = client_id
+      @client_secret = client_secret
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      grant_type = hash['grant_type'] ||= 'client_credentials'
+      client_id = hash['client_id'] ||= 'SOFflRakNlwnWlxfOXQ4GHDVyqGawuKA'
+      client_secret = hash['client_secret'] ||= 'cRnWgw7gACqM3gVS'
+
+      # Create object from extracted values.
+      OauthTokenPostRequestBody.new(grant_type,
+                                    client_id,
+                                    client_secret)
+    end
+  end
+end

data/lib/shell_ev/models/partner_token_request_body.rb

@@ -0,0 +1,73 @@
+# shell_ev
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellEv
+  # PartnerTokenRequestBody Model.
+  class PartnerTokenRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # In OAuth 2.0, the term grant typee refers to the way an application gets
+    # an access token. OAuth 2.0 defines several grant types, including the
+    # authorization code flow.
+    # @return [String]
+    attr_accessor :grant_type
+
+    # After registering your app, you will receive a client ID and a client
+    # secret. The client ID is considered public information, and is used to
+    # build login URLs, or included in Javascript source code on a page.
+    # @return [String]
+    attr_accessor :client_id
+
+    # After registering your app, you will receive a client ID and a client
+    # secret. The client ID is considered public information, and is used to
+    # build login URLs, or included in Javascript source code on a page. The
+    # client secret must be kept confidential.
+    # @return [String]
+    attr_accessor :client_secret
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grant_type'] = 'grant_type'
+      @_hash['client_id'] = 'client_id'
+      @_hash['client_secret'] = 'client_secret'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(grant_type = 'client_credentials',
+                   client_id = 'SOFflRakNlwnWlxfOXQ4GHDVyqGawuKA',
+                   client_secret = 'cRnWgw7gACqM3gVS')
+      @grant_type = grant_type
+      @client_id = client_id
+      @client_secret = client_secret
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      grant_type = hash['grant_type'] ||= 'client_credentials'
+      client_id = hash['client_id'] ||= 'SOFflRakNlwnWlxfOXQ4GHDVyqGawuKA'
+      client_secret = hash['client_secret'] ||= 'cRnWgw7gACqM3gVS'
+
+      # Create object from extracted values.
+      PartnerTokenRequestBody.new(grant_type,
+                                  client_id,
+                                  client_secret)
+    end
+  end
+end