data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/fees_fee_rule_tiers.rb

@@ -0,0 +1,124 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # FeesFeeRuleTiers Model.
+  class FeesFeeRuleTiers < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :tier_min
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :tier_max
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :date_effective
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :date_terminated
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :tier_value
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :fee_rule_basis_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :fee_rule_basis_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tier_min'] = 'TierMin'
+      @_hash['tier_max'] = 'TierMax'
+      @_hash['date_effective'] = 'DateEffective'
+      @_hash['date_terminated'] = 'DateTerminated'
+      @_hash['tier_value'] = 'TierValue'
+      @_hash['fee_rule_basis_id'] = 'FeeRuleBasisID'
+      @_hash['fee_rule_basis_description'] = 'FeeRuleBasisDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tier_min
+        tier_max
+        date_effective
+        date_terminated
+        tier_value
+        fee_rule_basis_id
+        fee_rule_basis_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        tier_min
+        tier_max
+        date_effective
+        date_terminated
+        tier_value
+        fee_rule_basis_id
+        fee_rule_basis_description
+      ]
+    end
+
+    def initialize(tier_min = SKIP,
+                   tier_max = SKIP,
+                   date_effective = SKIP,
+                   date_terminated = SKIP,
+                   tier_value = SKIP,
+                   fee_rule_basis_id = SKIP,
+                   fee_rule_basis_description = SKIP)
+      @tier_min = tier_min unless tier_min == SKIP
+      @tier_max = tier_max unless tier_max == SKIP
+      @date_effective = date_effective unless date_effective == SKIP
+      @date_terminated = date_terminated unless date_terminated == SKIP
+      @tier_value = tier_value unless tier_value == SKIP
+      @fee_rule_basis_id = fee_rule_basis_id unless fee_rule_basis_id == SKIP
+      unless fee_rule_basis_description == SKIP
+        @fee_rule_basis_description =
+          fee_rule_basis_description
+      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.
+      tier_min = hash.key?('TierMin') ? hash['TierMin'] : SKIP
+      tier_max = hash.key?('TierMax') ? hash['TierMax'] : SKIP
+      date_effective = hash.key?('DateEffective') ? hash['DateEffective'] : SKIP
+      date_terminated =
+        hash.key?('DateTerminated') ? hash['DateTerminated'] : SKIP
+      tier_value = hash.key?('TierValue') ? hash['TierValue'] : SKIP
+      fee_rule_basis_id =
+        hash.key?('FeeRuleBasisID') ? hash['FeeRuleBasisID'] : SKIP
+      fee_rule_basis_description =
+        hash.key?('FeeRuleBasisDescription') ? hash['FeeRuleBasisDescription'] : SKIP
+
+      # Create object from extracted values.
+      FeesFeeRuleTiers.new(tier_min,
+                           tier_max,
+                           date_effective,
+                           date_terminated,
+                           tier_value,
+                           fee_rule_basis_id,
+                           fee_rule_basis_description)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/finance_currency.rb

@@ -0,0 +1,98 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # This entity will not be present in the response if the
+  # ‘IncludeFinanceCurrency’ flag in the request is ‘false’
+  class FinanceCurrency < 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.
+      FinanceCurrency.new(currency_code,
+                          currency_symbol,
+                          invoice_exchange_rate,
+                          credit_limit_exchange_rate)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/fuel_consumption_card.rb

@@ -0,0 +1,73 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # FuelConsumptionCard Model.
+  class FuelConsumptionCard < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Card Id 
+    # Optional, when PAN is provided else mandatory.
+    # @return [Integer]
+    attr_accessor :card_id
+
+    # Full Card PAN
+    # Optional, when CardId is provided else mandatory.
+    # @return [String]
+    attr_accessor :pan
+
+    # Card Expiry Date
+    # Format: yyyyMMdd
+    # @return [String]
+    attr_accessor :expiry_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_id'] = 'CardId'
+      @_hash['pan'] = 'PAN'
+      @_hash['expiry_date'] = 'ExpiryDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_id
+        pan
+        expiry_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_id = SKIP,
+                   pan = SKIP,
+                   expiry_date = SKIP)
+      @card_id = card_id unless card_id == SKIP
+      @pan = pan unless pan == SKIP
+      @expiry_date = expiry_date unless expiry_date == 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_id = hash.key?('CardId') ? hash['CardId'] : SKIP
+      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      expiry_date = hash.key?('ExpiryDate') ? hash['ExpiryDate'] : SKIP
+
+      # Create object from extracted values.
+      FuelConsumptionCard.new(card_id,
+                              pan,
+                              expiry_date)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/fuel_consumption_data.rb

@@ -0,0 +1,267 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # FuelConsumptionData Model.
+  class FuelConsumptionData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account Name
+    # @return [String]
+    attr_accessor :account_name
+
+    # Account Number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Payment customer Name
+    # @return [String]
+    attr_accessor :payer_name
+
+    # Payment customer number
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Card PAN
+    # @return [String]
+    attr_accessor :card_number
+
+    # Card group ID
+    # @return [Integer]
+    attr_accessor :card_group_id
+
+    # Card group name
+    # @return [String]
+    attr_accessor :card_group_name
+
+    # Driver name
+    # @return [String]
+    attr_accessor :driver_name
+
+    # Vehicle registration number
+    # @return [String]
+    attr_accessor :license_number
+
+    # First transaction odometer reading
+    # @return [Float]
+    attr_accessor :initial_odometer
+
+    # Last transaction odometer reading
+    # @return [Float]
+    attr_accessor :last_odometer
+
+    # Distance in  KM or Miles based on Customer and Colco Settings
+    # @return [Float]
+    attr_accessor :distance
+
+    # Total Fuel Consumption.
+    # @return [Float]
+    attr_accessor :fuel_consumption
+
+    # Net Fuel Amount
+    # @return [Float]
+    attr_accessor :fuel_net_amount
+
+    # Total Discount
+    # @return [Float]
+    attr_accessor :discount
+
+    # Fuel Tax Amount
+    # @return [Float]
+    attr_accessor :fuel_tax
+
+    # Total Fuel Volume in Litres
+    # @return [Float]
+    attr_accessor :fuel_volume
+
+    # Gross Nonfuel Amount
+    # @return [Float]
+    attr_accessor :gross_non_fuel_expenses
+
+    # Total Co2 produced
+    # @return [Float]
+    attr_accessor :co2_produced
+
+    # Total Transaction Count
+    # @return [Float]
+    attr_accessor :transaction_count
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'AccountName'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['payer_name'] = 'PayerName'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['card_number'] = 'CardNumber'
+      @_hash['card_group_id'] = 'CardGroupId'
+      @_hash['card_group_name'] = 'CardGroupName'
+      @_hash['driver_name'] = 'DriverName'
+      @_hash['license_number'] = 'LicenseNumber'
+      @_hash['initial_odometer'] = 'InitialOdometer'
+      @_hash['last_odometer'] = 'LastOdometer'
+      @_hash['distance'] = 'Distance'
+      @_hash['fuel_consumption'] = 'FuelConsumption'
+      @_hash['fuel_net_amount'] = 'FuelNetAmount'
+      @_hash['discount'] = 'Discount'
+      @_hash['fuel_tax'] = 'FuelTax'
+      @_hash['fuel_volume'] = 'FuelVolume'
+      @_hash['gross_non_fuel_expenses'] = 'GrossNonFuelExpenses'
+      @_hash['co2_produced'] = 'CO2Produced'
+      @_hash['transaction_count'] = 'TransactionCount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        account_number
+        payer_name
+        payer_number
+        card_number
+        card_group_id
+        card_group_name
+        driver_name
+        license_number
+        initial_odometer
+        last_odometer
+        distance
+        fuel_consumption
+        fuel_net_amount
+        discount
+        fuel_tax
+        fuel_volume
+        gross_non_fuel_expenses
+        co2_produced
+        transaction_count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_name
+        account_number
+        payer_name
+        payer_number
+        card_number
+        card_group_id
+        card_group_name
+        driver_name
+        license_number
+        initial_odometer
+        last_odometer
+        distance
+        fuel_consumption
+        fuel_net_amount
+        discount
+        fuel_tax
+        fuel_volume
+        gross_non_fuel_expenses
+        co2_produced
+        transaction_count
+      ]
+    end
+
+    def initialize(account_name = SKIP,
+                   account_number = SKIP,
+                   payer_name = SKIP,
+                   payer_number = SKIP,
+                   card_number = SKIP,
+                   card_group_id = SKIP,
+                   card_group_name = SKIP,
+                   driver_name = SKIP,
+                   license_number = SKIP,
+                   initial_odometer = SKIP,
+                   last_odometer = SKIP,
+                   distance = SKIP,
+                   fuel_consumption = SKIP,
+                   fuel_net_amount = SKIP,
+                   discount = SKIP,
+                   fuel_tax = SKIP,
+                   fuel_volume = SKIP,
+                   gross_non_fuel_expenses = SKIP,
+                   co2_produced = SKIP,
+                   transaction_count = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @payer_name = payer_name unless payer_name == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @card_number = card_number unless card_number == SKIP
+      @card_group_id = card_group_id unless card_group_id == SKIP
+      @card_group_name = card_group_name unless card_group_name == SKIP
+      @driver_name = driver_name unless driver_name == SKIP
+      @license_number = license_number unless license_number == SKIP
+      @initial_odometer = initial_odometer unless initial_odometer == SKIP
+      @last_odometer = last_odometer unless last_odometer == SKIP
+      @distance = distance unless distance == SKIP
+      @fuel_consumption = fuel_consumption unless fuel_consumption == SKIP
+      @fuel_net_amount = fuel_net_amount unless fuel_net_amount == SKIP
+      @discount = discount unless discount == SKIP
+      @fuel_tax = fuel_tax unless fuel_tax == SKIP
+      @fuel_volume = fuel_volume unless fuel_volume == SKIP
+      @gross_non_fuel_expenses = gross_non_fuel_expenses unless gross_non_fuel_expenses == SKIP
+      @co2_produced = co2_produced unless co2_produced == SKIP
+      @transaction_count = transaction_count unless transaction_count == 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_name = hash.key?('AccountName') ? hash['AccountName'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      payer_name = hash.key?('PayerName') ? hash['PayerName'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      card_number = hash.key?('CardNumber') ? hash['CardNumber'] : SKIP
+      card_group_id = hash.key?('CardGroupId') ? hash['CardGroupId'] : SKIP
+      card_group_name =
+        hash.key?('CardGroupName') ? hash['CardGroupName'] : SKIP
+      driver_name = hash.key?('DriverName') ? hash['DriverName'] : SKIP
+      license_number = hash.key?('LicenseNumber') ? hash['LicenseNumber'] : SKIP
+      initial_odometer =
+        hash.key?('InitialOdometer') ? hash['InitialOdometer'] : SKIP
+      last_odometer = hash.key?('LastOdometer') ? hash['LastOdometer'] : SKIP
+      distance = hash.key?('Distance') ? hash['Distance'] : SKIP
+      fuel_consumption =
+        hash.key?('FuelConsumption') ? hash['FuelConsumption'] : SKIP
+      fuel_net_amount =
+        hash.key?('FuelNetAmount') ? hash['FuelNetAmount'] : SKIP
+      discount = hash.key?('Discount') ? hash['Discount'] : SKIP
+      fuel_tax = hash.key?('FuelTax') ? hash['FuelTax'] : SKIP
+      fuel_volume = hash.key?('FuelVolume') ? hash['FuelVolume'] : SKIP
+      gross_non_fuel_expenses =
+        hash.key?('GrossNonFuelExpenses') ? hash['GrossNonFuelExpenses'] : SKIP
+      co2_produced = hash.key?('CO2Produced') ? hash['CO2Produced'] : SKIP
+      transaction_count =
+        hash.key?('TransactionCount') ? hash['TransactionCount'] : SKIP
+
+      # Create object from extracted values.
+      FuelConsumptionData.new(account_name,
+                              account_number,
+                              payer_name,
+                              payer_number,
+                              card_number,
+                              card_group_id,
+                              card_group_name,
+                              driver_name,
+                              license_number,
+                              initial_odometer,
+                              last_odometer,
+                              distance,
+                              fuel_consumption,
+                              fuel_net_amount,
+                              discount,
+                              fuel_tax,
+                              fuel_volume,
+                              gross_non_fuel_expenses,
+                              co2_produced,
+                              transaction_count)
+    end
+  end
+end