card-management-sdk 1.0.0 → 1.1.0

data/lib/shell_card_management_ap_is/models/filters2.rb

@@ -0,0 +1,194 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Filters2 Model.
+  class Filters2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account ID of the customer.<br/> Optional if AccountNumber is passed, else
+    # mandatory. <br/> This input is a search criterion, if given.
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number of the customer.<br/> Optional if AccountId is passed, else
+    # mandatory.<br/> This input is a search criterion, if given.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Collecting Company Code (Shell Code) of the selected payer. <br />
+    # Optional – when ‘ReferenceNumber’ is provided.<br />
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Collecting Company Id (in ) of the selected payer. <br />
+    # Optional – when ‘ReferenceNumber’ is provided. Else, either ‘ColCoId’ or
+    # ‘ColCoCode’ is mandatory.<br />
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # ISO 3166 Alpha-2 Country Code for the customer and card owning country.
+    # @return [String]
+    attr_accessor :col_co_country_code
+
+    # Payer Id (i.e. Customer Id of the Payment Customer) of the selected
+    # payer.<br />
+    # Optional – when ‘ReferenceNumber’ is provided. Else, either ‘PayerId’ or
+    # ‘PayerNumber’ is mandatory.
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number of the selected payer.<br />
+    # Optional – when ‘ReferenceNumber’ is provided. Else, either ‘PayerId’ or
+    # ‘PayerNumber’ is mandatory.
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Reference number of the Card Order/ Bulk Card Order/ Order Card
+    # Request.<br />
+    # Mandatory when ColCo and Payer fields are not provided. Else, optional.
+    # @return [Integer]
+    attr_accessor :reference_number
+
+    # Reference number of the Card Order/ Bulk Card Order/ Order Card
+    # Request.<br />
+    # Mandatory when ColCo and Payer fields are not provided. Else, optional.
+    # @return [OrderCardEnquiryReqReferenceTypeEnum]
+    attr_accessor :reference_type
+
+    # Card Orders from Date/Time.<br />
+    # Optional.<br />
+    # Value should be with in last 7 days<br />
+    # This field is ignored if ReferenceNumber is provided <br />
+    # This field is optional when not provided and ReferenceNumber is null or
+    # empty then the value should be set to D-7(Where D is current date)<br />
+    # Format: yyyyMMdd
+    # @return [String]
+    attr_accessor :from_date
+
+    # Card Order to Date/Time<br />
+    # Optional<br />
+    # Value should be with in last 7 days<br />
+    # This field is ignored if ReferenceNumber is provided <br />
+    # This field is optional when not provided and ReferenceNumber is null or
+    # empty then the value should be set to current date<br />
+    # Format: yyyyMMdd
+    # @return [String]
+    attr_accessor :to_date
+
+    # Client provided Unique Id of the original Order Card request, the status
+    # of which is enquired by this API
+    # @return [String]
+    attr_accessor :order_request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['col_co_country_code'] = 'ColCoCountryCode'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['reference_number'] = 'ReferenceNumber'
+      @_hash['reference_type'] = 'ReferenceType'
+      @_hash['from_date'] = 'FromDate'
+      @_hash['to_date'] = 'ToDate'
+      @_hash['order_request_id'] = 'OrderRequestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        account_number
+        col_co_code
+        col_co_id
+        col_co_country_code
+        payer_id
+        payer_number
+        reference_number
+        reference_type
+        from_date
+        to_date
+        order_request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_id
+        account_number
+        col_co_code
+        col_co_id
+        col_co_country_code
+        payer_id
+        payer_number
+        from_date
+        to_date
+        order_request_id
+      ]
+    end
+
+    def initialize(account_id = SKIP, account_number = SKIP, col_co_code = SKIP,
+                   col_co_id = SKIP, col_co_country_code = SKIP,
+                   payer_id = SKIP, payer_number = SKIP,
+                   reference_number = SKIP, reference_type = SKIP,
+                   from_date = SKIP, to_date = SKIP, order_request_id = SKIP)
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @col_co_code = col_co_code unless col_co_code == SKIP
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @col_co_country_code = col_co_country_code unless col_co_country_code == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @reference_number = reference_number unless reference_number == SKIP
+      @reference_type = reference_type unless reference_type == SKIP
+      @from_date = from_date unless from_date == SKIP
+      @to_date = to_date unless to_date == SKIP
+      @order_request_id = order_request_id unless order_request_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.
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
+      col_co_country_code =
+        hash.key?('ColCoCountryCode') ? hash['ColCoCountryCode'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      reference_number =
+        hash.key?('ReferenceNumber') ? hash['ReferenceNumber'] : SKIP
+      reference_type = hash.key?('ReferenceType') ? hash['ReferenceType'] : SKIP
+      from_date = hash.key?('FromDate') ? hash['FromDate'] : SKIP
+      to_date = hash.key?('ToDate') ? hash['ToDate'] : SKIP
+      order_request_id =
+        hash.key?('OrderRequestId') ? hash['OrderRequestId'] : SKIP
+
+      # Create object from extracted values.
+      Filters2.new(account_id,
+                   account_number,
+                   col_co_code,
+                   col_co_id,
+                   col_co_country_code,
+                   payer_id,
+                   payer_number,
+                   reference_number,
+                   reference_type,
+                   from_date,
+                   to_date,
+                   order_request_id)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/finance_currency.rb

@@ -62,8 +62,7 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(currency_code = SKIP,
-                   currency_symbol = SKIP,
+    def initialize(currency_code = SKIP, currency_symbol = SKIP,
                    invoice_exchange_rate = SKIP,
                    credit_limit_exchange_rate = SKIP)
       @currency_code = currency_code unless currency_code == SKIP

data/lib/shell_card_management_ap_is/models/finance_currency2.rb

@@ -0,0 +1,96 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # FinanceCurrency2 Model.
+  class FinanceCurrency2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Currency ISO Code used for the Finance Widget.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # Currency Symbol
+    # @return [String]
+    attr_accessor :currency_symbol
+
+    # Factor to be used for converting the amounts in invoice currency to
+    # finance widget currency. (If finance currency is same as invoice currency,
+    # then the value of this field will be “1” so that the value does not
+    # change)
+    # @return [Float]
+    attr_accessor :invoice_exchange_rate
+
+    # Factor to be used for converting the amounts in credit limit currency to
+    # finance widget currency. (If finance currency is same as credit limit
+    # currency, then the value of this field will be “1” so that the value does
+    # not change)
+    # @return [Float]
+    attr_accessor :credit_limit_exchange_rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['currency_symbol'] = 'CurrencySymbol'
+      @_hash['invoice_exchange_rate'] = 'Invoice_ExchangeRate'
+      @_hash['credit_limit_exchange_rate'] = 'CreditLimit_ExchangeRate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency_code
+        currency_symbol
+        invoice_exchange_rate
+        credit_limit_exchange_rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        currency_code
+        currency_symbol
+        invoice_exchange_rate
+        credit_limit_exchange_rate
+      ]
+    end
+
+    def initialize(currency_code = SKIP, currency_symbol = SKIP,
+                   invoice_exchange_rate = SKIP,
+                   credit_limit_exchange_rate = SKIP)
+      @currency_code = currency_code unless currency_code == SKIP
+      @currency_symbol = currency_symbol unless currency_symbol == SKIP
+      @invoice_exchange_rate = invoice_exchange_rate unless invoice_exchange_rate == SKIP
+      unless credit_limit_exchange_rate == SKIP
+        @credit_limit_exchange_rate =
+          credit_limit_exchange_rate
+      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.
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
+      currency_symbol =
+        hash.key?('CurrencySymbol') ? hash['CurrencySymbol'] : SKIP
+      invoice_exchange_rate =
+        hash.key?('Invoice_ExchangeRate') ? hash['Invoice_ExchangeRate'] : SKIP
+      credit_limit_exchange_rate =
+        hash.key?('CreditLimit_ExchangeRate') ? hash['CreditLimit_ExchangeRate'] : SKIP
+
+      # Create object from extracted values.
+      FinanceCurrency2.new(currency_code,
+                           currency_symbol,
+                           invoice_exchange_rate,
+                           credit_limit_exchange_rate)
+    end
+  end
+end

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/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

@@ -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