data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/update_odometer_request.rb

@@ -0,0 +1,146 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # UpdateOdometerRequest Model.
+  class UpdateOdometerRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting Company Id  of the selected payer. 
+    # Optional if ColCoCode is passed else Mandatory.
+    # Example:
+    # 1 for Philippines
+    # 5 for UK
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # Collecting Company Code (Shell Code) of the selected payer. 
+    # Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia,
+    # Ukraine etc. It is optional for other countries if ColCoID is provided.
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Payer Id (i.e. Customer Id of the Payment Customer in Cards Platform) of
+    # the selected payer.
+    # Optional if PayerNumber is passed else Mandatory
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Account Id (i.e. Customer Id of the Sub Account in GFN) of the selected
+    # account.
+    # Optional if AccountNumber is passed else Mandatory
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number (ex: GB000000123) of the selected account.
+    # Optional if AccountId is passed else Mandatory
+    # @return [String]
+    attr_accessor :account_number
+
+    # Account Number (ex: GB000000123) of the selected account.
+    # Optional if AccountId is passed else Mandatory
+    # @return [Array[UpdateOdometer]]
+    attr_accessor :update_odometers
+
+    # True/False.
+    # Optional.
+    # Default: False
+    # If true, the caller would be notified back with the status as success or
+    # failure after the update odometer is processed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :notify_caller
+
+    # The caller to be notified with the status of the update odometer.
+    # Mandatory, if NotifyCaller is true.
+    # @return [String]
+    attr_accessor :caller
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['update_odometers'] = 'UpdateOdometers'
+      @_hash['notify_caller'] = 'NotifyCaller'
+      @_hash['caller'] = 'Caller'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        account_id
+        account_number
+        update_odometers
+        notify_caller
+        caller
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(col_co_id = SKIP,
+                   col_co_code = SKIP,
+                   payer_id = SKIP,
+                   account_id = SKIP,
+                   account_number = SKIP,
+                   update_odometers = SKIP,
+                   notify_caller = SKIP,
+                   caller = SKIP)
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @col_co_code = col_co_code unless col_co_code == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @update_odometers = update_odometers unless update_odometers == SKIP
+      @notify_caller = notify_caller unless notify_caller == SKIP
+      @caller = caller unless caller == 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.
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      update_odometers = nil
+      unless hash['UpdateOdometers'].nil?
+        update_odometers = []
+        hash['UpdateOdometers'].each do |structure|
+          update_odometers << (UpdateOdometer.from_hash(structure) if structure)
+        end
+      end
+
+      update_odometers = SKIP unless hash.key?('UpdateOdometers')
+      notify_caller = hash.key?('NotifyCaller') ? hash['NotifyCaller'] : SKIP
+      caller = hash.key?('Caller') ? hash['Caller'] : SKIP
+
+      # Create object from extracted values.
+      UpdateOdometerRequest.new(col_co_id,
+                                col_co_code,
+                                payer_id,
+                                account_id,
+                                account_number,
+                                update_odometers,
+                                notify_caller,
+                                caller)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/update_odometer_response.rb

@@ -0,0 +1,93 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # UpdateOdometerResponse Model.
+  class UpdateOdometerResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Main reference number for tracking.
+    # @return [Integer]
+    attr_accessor :service_reference
+
+    # Main reference number for tracking.
+    # @return [Array[UpdateOdometerReference]]
+    attr_accessor :update_odometer_references
+
+    # Main reference number for tracking.
+    # @return [ErrorStatus]
+    attr_accessor :error
+
+    # API Request Id
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['service_reference'] = 'ServiceReference'
+      @_hash['update_odometer_references'] = 'UpdateOdometerReferences'
+      @_hash['error'] = 'Error'
+      @_hash['request_id'] = 'RequestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        service_reference
+        update_odometer_references
+        error
+        request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(service_reference = SKIP,
+                   update_odometer_references = SKIP,
+                   error = SKIP,
+                   request_id = SKIP)
+      @service_reference = service_reference unless service_reference == SKIP
+      unless update_odometer_references == SKIP
+        @update_odometer_references =
+          update_odometer_references
+      end
+      @error = error unless error == SKIP
+      @request_id = request_id unless 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.
+      service_reference =
+        hash.key?('ServiceReference') ? hash['ServiceReference'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      update_odometer_references = nil
+      unless hash['UpdateOdometerReferences'].nil?
+        update_odometer_references = []
+        hash['UpdateOdometerReferences'].each do |structure|
+          update_odometer_references << (UpdateOdometerReference.from_hash(structure) if structure)
+        end
+      end
+
+      update_odometer_references = SKIP unless hash.key?('UpdateOdometerReferences')
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+
+      # Create object from extracted values.
+      UpdateOdometerResponse.new(service_reference,
+                                 update_odometer_references,
+                                 error,
+                                 request_id)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/usage_summary.rb

@@ -0,0 +1,202 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # UsageSummary Model.
+  class UsageSummary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Transaction date.
+    # The records will be sorted by this field in ascending order.
+    # Format: yyyyMMdd
+    # @return [String]
+    attr_accessor :date
+
+    # Product Id
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # Client Product code
+    # @return [String]
+    attr_accessor :product_code
+
+    # Product name in English
+    # @return [String]
+    attr_accessor :product_name
+
+    # Whether the product is fuel or non-fuel
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_fuel_product
+
+    # Site Group Id
+    # @return [Integer]
+    attr_accessor :site_group_id
+
+    # Site Group Name
+    # @return [String]
+    attr_accessor :site_group_name
+
+    # Total Volume
+    # @return [Float]
+    attr_accessor :total_volume
+
+    # Total Gross in Customer Currency
+    # @return [Float]
+    attr_accessor :total_gross
+
+    # Total Net in Customer Currency
+    # @return [Float]
+    attr_accessor :total_net
+
+    # Customer Currency Code
+    # @return [String]
+    attr_accessor :currency_code
+
+    # Customer Currency Symbol
+    # @return [String]
+    attr_accessor :currency_symbol
+
+    # Product group ID
+    # @return [Integer]
+    attr_accessor :product_group_id
+
+    # Product group Name
+    # @return [String]
+    attr_accessor :product_group_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['date'] = 'Date'
+      @_hash['product_id'] = 'ProductId'
+      @_hash['product_code'] = 'ProductCode'
+      @_hash['product_name'] = 'ProductName'
+      @_hash['is_fuel_product'] = 'IsFuelProduct'
+      @_hash['site_group_id'] = 'SiteGroupId'
+      @_hash['site_group_name'] = 'SiteGroupName'
+      @_hash['total_volume'] = 'TotalVolume'
+      @_hash['total_gross'] = 'TotalGross'
+      @_hash['total_net'] = 'TotalNet'
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['currency_symbol'] = 'CurrencySymbol'
+      @_hash['product_group_id'] = 'ProductGroupID'
+      @_hash['product_group_name'] = 'ProductGroupName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        date
+        product_id
+        product_code
+        product_name
+        is_fuel_product
+        site_group_id
+        site_group_name
+        total_volume
+        total_gross
+        total_net
+        currency_code
+        currency_symbol
+        product_group_id
+        product_group_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        date
+        product_id
+        product_code
+        product_name
+        is_fuel_product
+        site_group_id
+        site_group_name
+        total_volume
+        total_gross
+        total_net
+        currency_code
+        currency_symbol
+        product_group_id
+        product_group_name
+      ]
+    end
+
+    def initialize(date = SKIP,
+                   product_id = SKIP,
+                   product_code = SKIP,
+                   product_name = SKIP,
+                   is_fuel_product = SKIP,
+                   site_group_id = SKIP,
+                   site_group_name = SKIP,
+                   total_volume = SKIP,
+                   total_gross = SKIP,
+                   total_net = SKIP,
+                   currency_code = SKIP,
+                   currency_symbol = SKIP,
+                   product_group_id = SKIP,
+                   product_group_name = SKIP)
+      @date = date unless date == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @product_code = product_code unless product_code == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @is_fuel_product = is_fuel_product unless is_fuel_product == SKIP
+      @site_group_id = site_group_id unless site_group_id == SKIP
+      @site_group_name = site_group_name unless site_group_name == SKIP
+      @total_volume = total_volume unless total_volume == SKIP
+      @total_gross = total_gross unless total_gross == SKIP
+      @total_net = total_net unless total_net == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @currency_symbol = currency_symbol unless currency_symbol == SKIP
+      @product_group_id = product_group_id unless product_group_id == SKIP
+      @product_group_name = product_group_name unless product_group_name == 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.
+      date = hash.key?('Date') ? hash['Date'] : SKIP
+      product_id = hash.key?('ProductId') ? hash['ProductId'] : SKIP
+      product_code = hash.key?('ProductCode') ? hash['ProductCode'] : SKIP
+      product_name = hash.key?('ProductName') ? hash['ProductName'] : SKIP
+      is_fuel_product =
+        hash.key?('IsFuelProduct') ? hash['IsFuelProduct'] : SKIP
+      site_group_id = hash.key?('SiteGroupId') ? hash['SiteGroupId'] : SKIP
+      site_group_name =
+        hash.key?('SiteGroupName') ? hash['SiteGroupName'] : SKIP
+      total_volume = hash.key?('TotalVolume') ? hash['TotalVolume'] : SKIP
+      total_gross = hash.key?('TotalGross') ? hash['TotalGross'] : SKIP
+      total_net = hash.key?('TotalNet') ? hash['TotalNet'] : SKIP
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
+      currency_symbol =
+        hash.key?('CurrencySymbol') ? hash['CurrencySymbol'] : SKIP
+      product_group_id =
+        hash.key?('ProductGroupID') ? hash['ProductGroupID'] : SKIP
+      product_group_name =
+        hash.key?('ProductGroupName') ? hash['ProductGroupName'] : SKIP
+
+      # Create object from extracted values.
+      UsageSummary.new(date,
+                       product_id,
+                       product_code,
+                       product_name,
+                       is_fuel_product,
+                       site_group_id,
+                       site_group_name,
+                       total_volume,
+                       total_gross,
+                       total_net,
+                       currency_code,
+                       currency_symbol,
+                       product_group_id,
+                       product_group_name)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/volume_based_bonus_request.rb

@@ -0,0 +1,118 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # VolumeBasedBonusRequest Model.
+  class VolumeBasedBonusRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting Company Id of the selected payer. 
+    # Optional if ColCoCode is passed else Mandatory.
+    # Example:
+    # 1 for Philippines
+    # 5 for UK
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # Collecting Company Code of the selected payer. 
+    # Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia,
+    # Ukraine etc. It is optional for other countries if ColCoID is provided.
+    # Example:
+    # 86 for Philippines
+    # 5 for UK
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Payer Id of the selected payer.
+    # Optional if PayerNumber is passed else Mandatory
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number of the selected payer.
+    # Optional if PayerId is passed else Mandatory
+    # @return [String]
+    attr_accessor :payer_number
+
+    # The API will return the details of the previously calculated/paid bonus
+    # and fuel consumption (Volume) in the response when this flag is ‘True’.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_history
+
+    # The API will return the details of the monthly breakup of current period
+    # fuel consumption (Volume) in the response when this flag is ‘True’.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_current_period_volume
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['include_history'] = 'IncludeHistory'
+      @_hash['include_current_period_volume'] = 'IncludeCurrentPeriodVolume'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        include_history
+        include_current_period_volume
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(col_co_id = SKIP,
+                   col_co_code = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   include_history = SKIP,
+                   include_current_period_volume = SKIP)
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @col_co_code = col_co_code unless col_co_code == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @include_history = include_history unless include_history == SKIP
+      unless include_current_period_volume == SKIP
+        @include_current_period_volume =
+          include_current_period_volume
+      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.
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      include_history =
+        hash.key?('IncludeHistory') ? hash['IncludeHistory'] : SKIP
+      include_current_period_volume =
+        hash.key?('IncludeCurrentPeriodVolume') ? hash['IncludeCurrentPeriodVolume'] : SKIP
+
+      # Create object from extracted values.
+      VolumeBasedBonusRequest.new(col_co_id,
+                                  col_co_code,
+                                  payer_id,
+                                  payer_number,
+                                  include_history,
+                                  include_current_period_volume)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/volume_based_bonus_response.rb

@@ -0,0 +1,120 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # VolumeBasedBonusResponse Model.
+  class VolumeBasedBonusResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[BonusConfiguration]]
+    attr_accessor :configuration
+
+    # TODO: Write general description for this method
+    # @return [Array[CurrentVolume]]
+    attr_accessor :current_period_consumption
+
+    # TODO: Write general description for this method
+    # @return [Array[BonusHistory]]
+    attr_accessor :historical_bonus_paid
+
+    # TODO: Write general description for this method
+    # @return [ErrorStatus]
+    attr_accessor :error
+
+    # API Request Id
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['configuration'] = 'Configuration'
+      @_hash['current_period_consumption'] = 'CurrentPeriodConsumption'
+      @_hash['historical_bonus_paid'] = 'HistoricalBonusPaid'
+      @_hash['error'] = 'Error'
+      @_hash['request_id'] = 'RequestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        configuration
+        current_period_consumption
+        historical_bonus_paid
+        error
+        request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(configuration = SKIP,
+                   current_period_consumption = SKIP,
+                   historical_bonus_paid = SKIP,
+                   error = SKIP,
+                   request_id = SKIP)
+      @configuration = configuration unless configuration == SKIP
+      unless current_period_consumption == SKIP
+        @current_period_consumption =
+          current_period_consumption
+      end
+      @historical_bonus_paid = historical_bonus_paid unless historical_bonus_paid == SKIP
+      @error = error unless error == SKIP
+      @request_id = request_id unless 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.
+      # Parameter is an array, so we need to iterate through it
+      configuration = nil
+      unless hash['Configuration'].nil?
+        configuration = []
+        hash['Configuration'].each do |structure|
+          configuration << (BonusConfiguration.from_hash(structure) if structure)
+        end
+      end
+
+      configuration = SKIP unless hash.key?('Configuration')
+      # Parameter is an array, so we need to iterate through it
+      current_period_consumption = nil
+      unless hash['CurrentPeriodConsumption'].nil?
+        current_period_consumption = []
+        hash['CurrentPeriodConsumption'].each do |structure|
+          current_period_consumption << (CurrentVolume.from_hash(structure) if structure)
+        end
+      end
+
+      current_period_consumption = SKIP unless hash.key?('CurrentPeriodConsumption')
+      # Parameter is an array, so we need to iterate through it
+      historical_bonus_paid = nil
+      unless hash['HistoricalBonusPaid'].nil?
+        historical_bonus_paid = []
+        hash['HistoricalBonusPaid'].each do |structure|
+          historical_bonus_paid << (BonusHistory.from_hash(structure) if structure)
+        end
+      end
+
+      historical_bonus_paid = SKIP unless hash.key?('HistoricalBonusPaid')
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+
+      # Create object from extracted values.
+      VolumeBasedBonusResponse.new(configuration,
+                                   current_period_consumption,
+                                   historical_bonus_paid,
+                                   error,
+                                   request_id)
+    end
+  end
+end