data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/current_volume.rb

@@ -0,0 +1,99 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # CurrentVolume Model.
+  class CurrentVolume < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Bonus or association bonus configuration identifier that is associated to
+    # the payer
+    # @return [Integer]
+    attr_accessor :fee_rule_id
+
+    # Bonus or association bonus configuration description that is associated to
+    # the payer.
+    # @return [String]
+    attr_accessor :fee_rule_description
+
+    # Consumption(Volume) of the month.
+    # @return [Integer]
+    attr_accessor :month
+
+    # Consumption (Volume) of the year.
+    # @return [String]
+    attr_accessor :year
+
+    # Total volume consumption for the month/year above.
+    # @return [Float]
+    attr_accessor :total_volume
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fee_rule_id'] = 'FeeRuleId'
+      @_hash['fee_rule_description'] = 'FeeRuleDescription'
+      @_hash['month'] = 'Month'
+      @_hash['year'] = 'Year'
+      @_hash['total_volume'] = 'TotalVolume'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fee_rule_id
+        fee_rule_description
+        month
+        year
+        total_volume
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        fee_rule_id
+        fee_rule_description
+        month
+        year
+        total_volume
+      ]
+    end
+
+    def initialize(fee_rule_id = SKIP,
+                   fee_rule_description = SKIP,
+                   month = SKIP,
+                   year = SKIP,
+                   total_volume = SKIP)
+      @fee_rule_id = fee_rule_id unless fee_rule_id == SKIP
+      @fee_rule_description = fee_rule_description unless fee_rule_description == SKIP
+      @month = month unless month == SKIP
+      @year = year unless year == SKIP
+      @total_volume = total_volume unless total_volume == 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.
+      fee_rule_id = hash.key?('FeeRuleId') ? hash['FeeRuleId'] : SKIP
+      fee_rule_description =
+        hash.key?('FeeRuleDescription') ? hash['FeeRuleDescription'] : SKIP
+      month = hash.key?('Month') ? hash['Month'] : SKIP
+      year = hash.key?('Year') ? hash['Year'] : SKIP
+      total_volume = hash.key?('TotalVolume') ? hash['TotalVolume'] : SKIP
+
+      # Create object from extracted values.
+      CurrentVolume.new(fee_rule_id,
+                        fee_rule_description,
+                        month,
+                        year,
+                        total_volume)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/customer_contract.rb

@@ -0,0 +1,63 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # CustomerContract Model.
+  class CustomerContract < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Partner Id in e-TM system
+    # @return [String]
+    attr_accessor :partner_id
+
+    # Partner Name in e-TM system
+    # @return [String]
+    attr_accessor :partner_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['partner_id'] = 'PartnerId'
+      @_hash['partner_name'] = 'PartnerName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        partner_id
+        partner_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        partner_id
+        partner_name
+      ]
+    end
+
+    def initialize(partner_id = SKIP,
+                   partner_name = SKIP)
+      @partner_id = partner_id unless partner_id == SKIP
+      @partner_name = partner_name unless partner_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.
+      partner_id = hash.key?('PartnerId') ? hash['PartnerId'] : SKIP
+      partner_name = hash.key?('PartnerName') ? hash['PartnerName'] : SKIP
+
+      # Create object from extracted values.
+      CustomerContract.new(partner_id,
+                           partner_name)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/customer_detail_request.rb

@@ -0,0 +1,123 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # CustomerDetailRequest Model.
+  class CustomerDetailRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting Company Id (in GFN) of the selected payer. 
+    # Optional if ColCoCode is passed else Mandatory.
+    # Example:
+    # 1-Philippines
+    # 5-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.
+    # Example:
+    # 86-Philippines
+    # 5-UK
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Payer Id (i.e., Customer Id of the Payment Customer in H3 Cards Platform)
+    # of the selected payer.
+    # Optional if PayerNumber is passed else Mandatory
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number of the selected payer.
+    # Optional if PayerId is passed else Mandatory
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Account ID of the customer.
+    # Optional if AccountNumber is passed else Mandatory.
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number of the customer.
+    # Optional if AccountId is passed else Mandatory.
+    # @return [String]
+    attr_accessor :account_number
+
+    # 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['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        account_id
+        account_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        account_id
+        account_number
+      ]
+    end
+
+    def initialize(col_co_id = SKIP,
+                   col_co_code = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   account_id = SKIP,
+                   account_number = 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
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_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.
+      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
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+
+      # Create object from extracted values.
+      CustomerDetailRequest.new(col_co_id,
+                                col_co_code,
+                                payer_id,
+                                payer_number,
+                                account_id,
+                                account_number)
+    end
+  end
+end