card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/generate_pin_key_response.rb

@@ -0,0 +1,60 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # GeneratePINKeyResponse Model.
+  class GeneratePINKeyResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Random generated unique identifier.
+    # @return [String]
+    attr_accessor :uid
+
+    # Random generated unique identifier.
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP,
+                   value = SKIP)
+      @uid = uid unless uid == SKIP
+      @value = value unless value == 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.
+      uid = hash.key?('uid') ? hash['uid'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create object from extracted values.
+      GeneratePINKeyResponse.new(uid,
+                                 value)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/invoice_distribution_method.rb

@@ -0,0 +1,99 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # InvoiceDistributionMethod Model.
+  class InvoiceDistributionMethod < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If True then this distribution method is the default distribution method.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_primary
+
+    # Frequency type unit Id & description
+    # E.g.:
+    # 1- Daily
+    # 2-Weekly
+    # 3-Monthly
+    # 4-Invoicing
+    # 6-Calendar quarter
+    # @return [String]
+    attr_accessor :frequency_type
+
+    # Invoice Distribution Method (Id-Description)
+    # E.g.:
+    # 1-e-mail
+    # 2-Fax
+    # 3-Courier to Customer
+    # 4-Courier to Client
+    # 5-Print
+    # 6-FTP
+    # 7-SMS
+    # @return [String]
+    attr_accessor :distribution_method
+
+    # Invoice output type (Id - Description)
+    # @return [String]
+    attr_accessor :output_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['is_primary'] = 'IsPrimary'
+      @_hash['frequency_type'] = 'FrequencyType'
+      @_hash['distribution_method'] = 'DistributionMethod'
+      @_hash['output_type'] = 'OutputType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        is_primary
+        frequency_type
+        distribution_method
+        output_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        frequency_type
+        distribution_method
+        output_type
+      ]
+    end
+
+    def initialize(is_primary = true,
+                   frequency_type = SKIP,
+                   distribution_method = SKIP,
+                   output_type = SKIP)
+      @is_primary = is_primary unless is_primary == SKIP
+      @frequency_type = frequency_type unless frequency_type == SKIP
+      @distribution_method = distribution_method unless distribution_method == SKIP
+      @output_type = output_type unless output_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.
+      is_primary = hash['IsPrimary'] ||= true
+      frequency_type = hash.key?('FrequencyType') ? hash['FrequencyType'] : SKIP
+      distribution_method =
+        hash.key?('DistributionMethod') ? hash['DistributionMethod'] : SKIP
+      output_type = hash.key?('OutputType') ? hash['OutputType'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceDistributionMethod.new(is_primary,
+                                    frequency_type,
+                                    distribution_method,
+                                    output_type)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/location_restrictions.rb

@@ -0,0 +1,125 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Location restrictions to be applied on the bundle which either allows or
+  # restricts using the cards, which are under the bundle, in the specified
+  # locations.  Mandatory if respective action is set as “Add”. Details of
+  # location restrictions are given below.
+  class LocationRestrictions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An entity that encapsulate the country restrictions.
+    # Optional.
+    # @return [LocationRestrictionsCountryRestrictions]
+    attr_accessor :country_restrictions
+
+    # A list of NetworkRestriction entity. Each item in the list encapsulates a
+    # network restriction in a given country.
+    # Optional.
+    # The details of the entity are described below:
+    # @return [Array[LocationRestrictionsNetworkRestrictionsItems]]
+    attr_accessor :network_restrictions
+
+    # A list of ShellSiteRestriction entity. Each item in the list encapsulates
+    # a site restriction of Shell network in a given country.
+    # Optional.
+    # The details of the entity are described below.
+    # @return [Array[LocationRestrictionsShellSiteRestrictionsItems]]
+    attr_accessor :shell_site_restrictions
+
+    # A list of PartnerSiteRestriction entity. Each item in the list
+    # encapsulates a site restriction of a given partner network.
+    # Optional.
+    # The details of the entity are described below.
+    # @return [Array[LocationRestrictionsPartnerSiteRestrictionsItems]]
+    attr_accessor :partner_site_restrictions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country_restrictions'] = 'CountryRestrictions'
+      @_hash['network_restrictions'] = 'NetworkRestrictions'
+      @_hash['shell_site_restrictions'] = 'ShellSiteRestrictions'
+      @_hash['partner_site_restrictions'] = 'PartnerSiteRestrictions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        country_restrictions
+        network_restrictions
+        shell_site_restrictions
+        partner_site_restrictions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country_restrictions = SKIP,
+                   network_restrictions = SKIP,
+                   shell_site_restrictions = SKIP,
+                   partner_site_restrictions = SKIP)
+      @country_restrictions = country_restrictions unless country_restrictions == SKIP
+      @network_restrictions = network_restrictions unless network_restrictions == SKIP
+      @shell_site_restrictions = shell_site_restrictions unless shell_site_restrictions == SKIP
+      unless partner_site_restrictions == SKIP
+        @partner_site_restrictions =
+          partner_site_restrictions
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      if hash['CountryRestrictions']
+        country_restrictions = LocationRestrictionsCountryRestrictions.from_hash(hash['CountryRestrictions'])
+      end
+      # Parameter is an array, so we need to iterate through it
+      network_restrictions = nil
+      unless hash['NetworkRestrictions'].nil?
+        network_restrictions = []
+        hash['NetworkRestrictions'].each do |structure|
+          network_restrictions << (LocationRestrictionsNetworkRestrictionsItems.from_hash(structure) if structure)
+        end
+      end
+
+      network_restrictions = SKIP unless hash.key?('NetworkRestrictions')
+      # Parameter is an array, so we need to iterate through it
+      shell_site_restrictions = nil
+      unless hash['ShellSiteRestrictions'].nil?
+        shell_site_restrictions = []
+        hash['ShellSiteRestrictions'].each do |structure|
+          shell_site_restrictions << (LocationRestrictionsShellSiteRestrictionsItems.from_hash(structure) if structure)
+        end
+      end
+
+      shell_site_restrictions = SKIP unless hash.key?('ShellSiteRestrictions')
+      # Parameter is an array, so we need to iterate through it
+      partner_site_restrictions = nil
+      unless hash['PartnerSiteRestrictions'].nil?
+        partner_site_restrictions = []
+        hash['PartnerSiteRestrictions'].each do |structure|
+          partner_site_restrictions << (LocationRestrictionsPartnerSiteRestrictionsItems.from_hash(structure) if structure)
+        end
+      end
+
+      partner_site_restrictions = SKIP unless hash.key?('PartnerSiteRestrictions')
+
+      # Create object from extracted values.
+      LocationRestrictions.new(country_restrictions,
+                               network_restrictions,
+                               shell_site_restrictions,
+                               partner_site_restrictions)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/location_restrictions_country_restrictions.rb

@@ -0,0 +1,65 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # An entity that encapsulate the country restrictions. Optional.
+  class LocationRestrictionsCountryRestrictions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boolean	Flag indicates whether the profile is inclusive or exclusive.
+    # Mandatory
+    # Example: False - (inclusive), i.e. the “Countries” property lists the
+    # countries where the transactions will be allowed.
+    # True - (exclusive), i.e. the “Countries” property lists the countries
+    # where the transactions will be declined.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exclusive
+
+    # ISO 3166-1 Numeric-3 code of the country where the network restriction is
+    # applied.
+    # Example: 826 for United Kingdom.
+    # Mandatory
+    # @return [Array[String]]
+    attr_accessor :countries
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['exclusive'] = 'Exclusive'
+      @_hash['countries'] = 'Countries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(exclusive = nil,
+                   countries = nil)
+      @exclusive = exclusive
+      @countries = countries
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      exclusive = hash.key?('Exclusive') ? hash['Exclusive'] : nil
+      countries = hash.key?('Countries') ? hash['Countries'] : nil
+
+      # Create object from extracted values.
+      LocationRestrictionsCountryRestrictions.new(exclusive,
+                                                  countries)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/location_restrictions_network_restrictions_items.rb

@@ -0,0 +1,77 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # LocationRestrictionsNetworkRestrictionsItems Model.
+  class LocationRestrictionsNetworkRestrictionsItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO 3166-1 Numeric-3 code of the country where the network restriction is
+    # applied.
+    # Example: 826 for United Kingdom.
+    # Mandatory
+    # @return [String]
+    attr_accessor :country
+
+    # Flag indicates whether the profile is inclusive or exclusive.
+    # Mandatory
+    # Example: False - (inclusive), i.e. the “Networks” property lists the
+    # networks in which the transaction will be allowed.
+    # True - (exclusive), i.e. the “Networks” property lists the networks in
+    # which the transactions will be declined.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exclusive
+
+    # A list of Gateway network codes, typically 7 or 10 digits.
+    # Example: 0002003250
+    # @return [Array[String]]
+    attr_accessor :networks
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country'] = 'Country'
+      @_hash['exclusive'] = 'Exclusive'
+      @_hash['networks'] = 'Networks'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        networks
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = nil,
+                   exclusive = nil,
+                   networks = SKIP)
+      @country = country
+      @exclusive = exclusive
+      @networks = networks unless networks == 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.
+      country = hash.key?('Country') ? hash['Country'] : nil
+      exclusive = hash.key?('Exclusive') ? hash['Exclusive'] : nil
+      networks = hash.key?('Networks') ? hash['Networks'] : SKIP
+
+      # Create object from extracted values.
+      LocationRestrictionsNetworkRestrictionsItems.new(country,
+                                                       exclusive,
+                                                       networks)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/location_restrictions_partner_site_restrictions_items.rb

@@ -0,0 +1,95 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # LocationRestrictionsPartnerSiteRestrictionsItems Model.
+  class LocationRestrictionsPartnerSiteRestrictionsItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gateway network codes, typically 7 or 10 digits, where sites and site
+    # groups belong to.
+    # Example: 0002003250
+    # Mandatory
+    # @return [String]
+    attr_accessor :network_code
+
+    # A list of Site IDs in this network which needs to be either restricted or
+    # allowed.
+    # For example, 97123, 97155
+    # A list of values must be passed for either Sites or SiteGroups or both.
+    # Max 10 sites are allowed for the Partner site Restriction.
+    # @return [Array[String]]
+    attr_accessor :sites
+
+    # A list of site group ids in this network which needs to be either
+    # restricted or allowed.
+    # For example, 83649200
+    # A list of values must be passed for either Sites or SiteGroups or both.
+    # Max 10 sites groups are allowed for the Partner site Restriction.
+    # @return [Array[String]]
+    attr_accessor :site_groups
+
+    # Flag indicates whether the profile is inclusive or exclusive.
+    # Mandatory
+    # Example: False - (inclusive), i.e. the “Sites” & “SiteGroups” properties
+    # lists the sites & site groups where the transaction will be allowed.
+    # True - (exclusive), i.e. the “Sites” & “SiteGroups” properties lists the
+    # sites and site groups where the transactions will be declined.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exclusive
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['network_code'] = 'NetworkCode'
+      @_hash['sites'] = 'Sites'
+      @_hash['site_groups'] = 'SiteGroups'
+      @_hash['exclusive'] = 'Exclusive'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sites
+        site_groups
+        exclusive
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(network_code = nil,
+                   sites = SKIP,
+                   site_groups = SKIP,
+                   exclusive = SKIP)
+      @network_code = network_code
+      @sites = sites unless sites == SKIP
+      @site_groups = site_groups unless site_groups == SKIP
+      @exclusive = exclusive unless exclusive == 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.
+      network_code = hash.key?('NetworkCode') ? hash['NetworkCode'] : nil
+      sites = hash.key?('Sites') ? hash['Sites'] : SKIP
+      site_groups = hash.key?('SiteGroups') ? hash['SiteGroups'] : SKIP
+      exclusive = hash.key?('Exclusive') ? hash['Exclusive'] : SKIP
+
+      # Create object from extracted values.
+      LocationRestrictionsPartnerSiteRestrictionsItems.new(network_code,
+                                                           sites,
+                                                           site_groups,
+                                                           exclusive)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/location_restrictions_shell_site_restrictions_items.rb

@@ -0,0 +1,95 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # LocationRestrictionsShellSiteRestrictionsItems Model.
+  class LocationRestrictionsShellSiteRestrictionsItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO 3166-1 Numeric-3 code of the country where the site restriction is
+    # applied.
+    # Example: 826 for United Kingdom.
+    # @return [String]
+    attr_accessor :country
+
+    # A list of Site IDs in this country, in the format “AA1111” where “AA” is a
+    # 2-character country code and “1111” is a 4-digit site number in that
+    # country, which needs to be either restricted or allowed.
+    # A list of values must be passed for either Sites or SiteGroups or both.
+    # Max 10 sites are allowed for the Shell site Restriction.
+    # For example, “GB1234”.
+    # @return [Array[String]]
+    attr_accessor :sites
+
+    # A list of site group ids in this country which needs to be either
+    # restricted or allowed.
+    # A list of values must be passed for either Sites or SiteGroups or both.
+    # Max 10 sites groups are allowed for the Shell site Restriction.
+    # @return [Array[String]]
+    attr_accessor :site_groups
+
+    # Flag indicates whether the profile is inclusive or exclusive.
+    # Mandatory
+    # Example: False - (inclusive), i.e. the “Sites” & “SiteGroups” properties
+    # lists the sites & site groups where the transaction will be allowed.
+    # True - (exclusive), i.e. the “Sites” & “SiteGroups” properties lists the
+    # sites and site groups where the transactions will be declined.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exclusive
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country'] = 'Country'
+      @_hash['sites'] = 'Sites'
+      @_hash['site_groups'] = 'SiteGroups'
+      @_hash['exclusive'] = 'Exclusive'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        country
+        sites
+        site_groups
+        exclusive
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = SKIP,
+                   sites = SKIP,
+                   site_groups = SKIP,
+                   exclusive = SKIP)
+      @country = country unless country == SKIP
+      @sites = sites unless sites == SKIP
+      @site_groups = site_groups unless site_groups == SKIP
+      @exclusive = exclusive unless exclusive == 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.
+      country = hash.key?('Country') ? hash['Country'] : SKIP
+      sites = hash.key?('Sites') ? hash['Sites'] : SKIP
+      site_groups = hash.key?('SiteGroups') ? hash['SiteGroups'] : SKIP
+      exclusive = hash.key?('Exclusive') ? hash['Exclusive'] : SKIP
+
+      # Create object from extracted values.
+      LocationRestrictionsShellSiteRestrictionsItems.new(country,
+                                                         sites,
+                                                         site_groups,
+                                                         exclusive)
+    end
+  end
+end