card-management-sdk 1.0.0 → 1.2.0

data/lib/shell_card_management_ap_is/models/fleetmanagement_v1_user_loggedinuser_request.rb

@@ -0,0 +1,104 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # FleetmanagementV1UserLoggedinuserRequest Model.
+  class FleetmanagementV1UserLoggedinuserRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # True/False. The output will include the payer group information only when
+    # true is passed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_payer_group
+
+    # True/False. The output will include the EID (Electronic Invoice data)
+    # information only when true is passed..
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_eid_details
+
+    # Name of the API on which user access needs to be validated
+    # Optional.
+    # @return [String]
+    attr_accessor :requested_api_name
+
+    # Payer id of the customer.</br>
+    # Optional.</br>
+    # This input is a search criterion.</br>
+    # Note: If PayerId or PayerNumber is provided in the input, the given payer
+    # will be available in the output if the user has access to the given payer.
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # PayerNumber of the customer.</br>
+    # Optional</br>
+    # This input is a search criterion.</br>
+    # Note: If Payerid or PayerNumber is provided in the input, the given payer
+    # will be available in the output if the user has access to the given payer.
+    # @return [String]
+    attr_accessor :payer_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['include_payer_group'] = 'IncludePayerGroup'
+      @_hash['include_eid_details'] = 'IncludeEIDDetails'
+      @_hash['requested_api_name'] = 'RequestedAPIName'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        include_payer_group
+        include_eid_details
+        requested_api_name
+        payer_id
+        payer_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        requested_api_name
+        payer_id
+        payer_number
+      ]
+    end
+
+    def initialize(include_payer_group = false, include_eid_details = false,
+                   requested_api_name = SKIP, payer_id = SKIP,
+                   payer_number = SKIP)
+      @include_payer_group = include_payer_group unless include_payer_group == SKIP
+      @include_eid_details = include_eid_details unless include_eid_details == SKIP
+      @requested_api_name = requested_api_name unless requested_api_name == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == 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.
+      include_payer_group = hash['IncludePayerGroup'] ||= false
+      include_eid_details = hash['IncludeEIDDetails'] ||= false
+      requested_api_name =
+        hash.key?('RequestedAPIName') ? hash['RequestedAPIName'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+
+      # Create object from extracted values.
+      FleetmanagementV1UserLoggedinuserRequest.new(include_payer_group,
+                                                   include_eid_details,
+                                                   requested_api_name,
+                                                   payer_id,
+                                                   payer_number)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/fleetmanagement_v2_restriction_searchcard401_error1.rb

@@ -0,0 +1,50 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # FleetmanagementV2RestrictionSearchcard401Error1 Model.
+  class FleetmanagementV2RestrictionSearchcard401Error1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Fault]
+    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 = Fault.from_hash(hash['fault']) if hash['fault']
+
+      # Create object from extracted values.
+      FleetmanagementV2RestrictionSearchcard401Error1.new(fault)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/fleetmanagement_v2_restriction_searchcard500_error1.rb

@@ -0,0 +1,50 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # FleetmanagementV2RestrictionSearchcard500Error1 Model.
+  class FleetmanagementV2RestrictionSearchcard500Error1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Fault]
+    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 = Fault.from_hash(hash['fault']) if hash['fault']
+
+      # Create object from extracted values.
+      FleetmanagementV2RestrictionSearchcard500Error1.new(fault)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/generate_pin_key_response.rb

@@ -38,8 +38,7 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(uid = SKIP,
-                   value = SKIP)
+    def initialize(uid = SKIP, value = SKIP)
       @uid = uid unless uid == SKIP
       @value = value unless value == SKIP
     end

data/lib/shell_card_management_ap_is/models/invoice_distribution_method.rb

@@ -68,10 +68,8 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(is_primary = true,
-                   frequency_type = SKIP,
-                   distribution_method = SKIP,
-                   output_type = SKIP)
+    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

data/lib/shell_card_management_ap_is/models/{location_restrictions.rb → location_restriction.rb}

@@ -4,38 +4,25 @@
 # ( 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
+  # LocationRestriction Model.
+  class LocationRestriction < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
-    # An entity that encapsulate the country restrictions.
-    # Optional.
-    # @return [LocationRestrictionsCountryRestrictions]
+    # TODO: Write general description for this method
+    # @return [CountryRestriction]
     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]]
+    # TODO: Write general description for this method
+    # @return [Array[NetworkRestriction]]
     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]]
+    # TODO: Write general description for this method
+    # @return [Array[ShellSiteRestriction]]
     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]]
+    # TODO: Write general description for this method
+    # @return [Array[PartnerSiteRestriction]]
     attr_accessor :partner_site_restrictions
 
     # A mapping from model property names to API property names.
@@ -63,8 +50,7 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(country_restrictions = SKIP,
-                   network_restrictions = SKIP,
+    def initialize(country_restrictions = SKIP, network_restrictions = SKIP,
                    shell_site_restrictions = SKIP,
                    partner_site_restrictions = SKIP)
       @country_restrictions = country_restrictions unless country_restrictions == SKIP
@@ -81,15 +67,14 @@ module ShellCardManagementApIs
       return nil unless hash
 
       # Extract variables from the hash.
-      if hash['CountryRestrictions']
-        country_restrictions = LocationRestrictionsCountryRestrictions.from_hash(hash['CountryRestrictions'])
-      end
+      country_restrictions = CountryRestriction.from_hash(hash['CountryRestrictions']) if
+        hash['CountryRestrictions']
       # 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)
+          network_restrictions << (NetworkRestriction.from_hash(structure) if structure)
         end
       end
 
@@ -99,7 +84,7 @@ module ShellCardManagementApIs
       unless hash['ShellSiteRestrictions'].nil?
         shell_site_restrictions = []
         hash['ShellSiteRestrictions'].each do |structure|
-          shell_site_restrictions << (LocationRestrictionsShellSiteRestrictionsItems.from_hash(structure) if structure)
+          shell_site_restrictions << (ShellSiteRestriction.from_hash(structure) if structure)
         end
       end
 
@@ -109,17 +94,17 @@ module ShellCardManagementApIs
       unless hash['PartnerSiteRestrictions'].nil?
         partner_site_restrictions = []
         hash['PartnerSiteRestrictions'].each do |structure|
-          partner_site_restrictions << (LocationRestrictionsPartnerSiteRestrictionsItems.from_hash(structure) if structure)
+          partner_site_restrictions << (PartnerSiteRestriction.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)
+      LocationRestriction.new(country_restrictions,
+                              network_restrictions,
+                              shell_site_restrictions,
+                              partner_site_restrictions)
     end
   end
 end

data/lib/shell_card_management_ap_is/models/logged_in_user_request.rb

@@ -72,10 +72,8 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(include_payer_group = false,
-                   include_eid_details = false,
-                   requested_api_name = SKIP,
-                   payer_id = SKIP,
+    def initialize(include_payer_group = false, include_eid_details = false,
+                   requested_api_name = SKIP, payer_id = SKIP,
                    payer_number = SKIP)
       @include_payer_group = include_payer_group unless include_payer_group == SKIP
       @include_eid_details = include_eid_details unless include_eid_details == SKIP

data/lib/shell_card_management_ap_is/models/logged_in_user_response.rb

@@ -71,9 +71,9 @@ module ShellCardManagementApIs
     attr_accessor :roles
 
     # List of payers which the user has access to.
-    # •	It will return 250 payers only and it is configurable. If the user has
-    # more than that, the remaining will be ignored.
-    # •	The payer which is marked as default will be the first item in the
+    # •    It will return 250 payers only and it is configurable. If the user
+    # has more than that, the remaining will be ignored.
+    # •    The payer which is marked as default will be the first item in the
     # output.
     # Note: This list will be empty for users mapped with roles which has either
     # IsShellAdmin or IsServiceAccount set to true as their access level is
@@ -225,30 +225,17 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(user_name = SKIP,
-                   display_name = SKIP,
-                   id_mssoid = SKIP,
-                   preferred_language = SKIP,
-                   is_super_admin = false,
-                   date_format = SKIP,
-                   time_format = SKIP,
-                   week_begins = SKIP,
-                   display_week = true,
-                   csv_separator = SKIP,
-                   decimal_separator = SKIP,
-                   report_format = SKIP,
-                   has_api_access = true,
-                   roles = SKIP,
-                   payers = SKIP,
-                   accounts = SKIP,
-                   collecting_companies = SKIP,
+    def initialize(user_name = SKIP, display_name = SKIP, id_mssoid = SKIP,
+                   preferred_language = SKIP, is_super_admin = false,
+                   date_format = SKIP, time_format = SKIP, week_begins = SKIP,
+                   display_week = true, csv_separator = SKIP,
+                   decimal_separator = SKIP, report_format = SKIP,
+                   has_api_access = true, roles = SKIP, payers = SKIP,
+                   accounts = SKIP, collecting_companies = SKIP,
                    eid_access_details = SKIP,
                    user_classification_by_system = SKIP,
-                   user_classification_by_shell = SKIP,
-                   payer_count = SKIP,
-                   account_count = SKIP,
-                   card_count = SKIP,
-                   error = SKIP,
+                   user_classification_by_shell = SKIP, payer_count = SKIP,
+                   account_count = SKIP, card_count = SKIP, error = SKIP,
                    request_id = SKIP)
       @user_name = user_name unless user_name == SKIP
       @display_name = display_name unless display_name == SKIP

data/lib/shell_card_management_ap_is/models/{location_restrictions_network_restrictions_items.rb → network_restriction.rb}

@@ -4,20 +4,23 @@
 # ( https://apimatic.io ).
 
 module ShellCardManagementApIs
-  # LocationRestrictionsNetworkRestrictionsItems Model.
-  class LocationRestrictionsNetworkRestrictionsItems < BaseModel
+  # NetworkRestriction Model.
+  class NetworkRestriction < 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
 
+    # A list of Gateway network codes, typically 7 or 10 digits.
+    # Example: 0002003250
+    # @return [Array[String]]
+    attr_accessor :networks
+
     # 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
@@ -25,24 +28,21 @@ module ShellCardManagementApIs
     # @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['exclusive'] = 'Exclusive'
       @_hash
     end
 
     # An array for optional fields
     def self.optionals
       %w[
+        country
         networks
+        exclusive
       ]
     end
 
@@ -51,12 +51,10 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(country = nil,
-                   exclusive = nil,
-                   networks = SKIP)
-      @country = country
-      @exclusive = exclusive
+    def initialize(country = SKIP, networks = SKIP, exclusive = SKIP)
+      @country = country unless country == SKIP
       @networks = networks unless networks == SKIP
+      @exclusive = exclusive unless exclusive == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -64,14 +62,14 @@ module ShellCardManagementApIs
       return nil unless hash
 
       # Extract variables from the hash.
-      country = hash.key?('Country') ? hash['Country'] : nil
-      exclusive = hash.key?('Exclusive') ? hash['Exclusive'] : nil
+      country = hash.key?('Country') ? hash['Country'] : SKIP
       networks = hash.key?('Networks') ? hash['Networks'] : SKIP
+      exclusive = hash.key?('Exclusive') ? hash['Exclusive'] : SKIP
 
       # Create object from extracted values.
-      LocationRestrictionsNetworkRestrictionsItems.new(country,
-                                                       exclusive,
-                                                       networks)
+      NetworkRestriction.new(country,
+                             networks,
+                             exclusive)
     end
   end
 end

data/lib/shell_card_management_ap_is/models/o_auth_token.rb

@@ -62,12 +62,8 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(access_token = nil,
-                   token_type = nil,
-                   expires_in = SKIP,
-                   scope = SKIP,
-                   expiry = SKIP,
-                   refresh_token = SKIP)
+    def initialize(access_token = nil, token_type = nil, expires_in = SKIP,
+                   scope = SKIP, expiry = SKIP, refresh_token = SKIP)
       @access_token = access_token
       @token_type = token_type
       @expires_in = expires_in unless expires_in == SKIP