data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/priced_transaction_response_v2.rb

@@ -0,0 +1,110 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # PricedTransactionResponseV2 Model.
+  class PricedTransactionResponseV2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Mandatory UUID (according to RFC 4122 standards) for requests and
+    # responses. This will be played back in the response from the req
+    # @return [String]
+    attr_accessor :request_id
+
+    # Indicates overall status of the request
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates overall status of the request
+    # @return [Array[PricedResponseData]]
+    attr_accessor :data
+
+    # Current page
+    # @return [Integer]
+    attr_accessor :page
+
+    # Number of records returned in the response
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # Total number of pages available for the requested data
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'RequestId'
+      @_hash['status'] = 'Status'
+      @_hash['data'] = 'Data'
+      @_hash['page'] = 'Page'
+      @_hash['page_size'] = 'PageSize'
+      @_hash['total_pages'] = 'TotalPages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        data
+        page
+        page_size
+        total_pages
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   status = SKIP,
+                   data = SKIP,
+                   page = SKIP,
+                   page_size = SKIP,
+                   total_pages = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @data = data unless data == SKIP
+      @page = page unless page == SKIP
+      @page_size = page_size unless page_size == SKIP
+      @total_pages = total_pages unless total_pages == 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.
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['Data'].nil?
+        data = []
+        hash['Data'].each do |structure|
+          data << (PricedResponseData.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+      page = hash.key?('Page') ? hash['Page'] : SKIP
+      page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
+      total_pages = hash.key?('TotalPages') ? hash['TotalPages'] : SKIP
+
+      # Create object from extracted values.
+      PricedTransactionResponseV2.new(request_id,
+                                      status,
+                                      data,
+                                      page,
+                                      page_size,
+                                      total_pages)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/pricing_current_volume.rb

@@ -0,0 +1,115 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # PricingCurrentVolume Model.
+  class PricingCurrentVolume < 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
+
+    # Pricing current period Pricing Price Rule ID that is associated to the
+    # payer.
+    # @return [Integer]
+    attr_accessor :price_rule_id
+
+    # Pricing current period pricing rule description that is associated to the
+    # payer
+    # @return [String]
+    attr_accessor :price_rule_description
+
+    # Total volume consumption for the current period.
+    # @return [Float]
+    attr_accessor :total_volume
+
+    # Next Fee Rule Creation Date for that is associated to the payer.
+    # Format: YYYYMMDD
+    # @return [String]
+    attr_accessor :next_fee_creation_date
+
+    # 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['price_rule_id'] = 'PriceRuleID'
+      @_hash['price_rule_description'] = 'PriceRuleDescription'
+      @_hash['total_volume'] = 'TotalVolume'
+      @_hash['next_fee_creation_date'] = 'NextFeeCreationDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fee_rule_id
+        fee_rule_description
+        price_rule_id
+        price_rule_description
+        total_volume
+        next_fee_creation_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        fee_rule_id
+        fee_rule_description
+        price_rule_id
+        price_rule_description
+        total_volume
+        next_fee_creation_date
+      ]
+    end
+
+    def initialize(fee_rule_id = SKIP,
+                   fee_rule_description = SKIP,
+                   price_rule_id = SKIP,
+                   price_rule_description = SKIP,
+                   total_volume = SKIP,
+                   next_fee_creation_date = SKIP)
+      @fee_rule_id = fee_rule_id unless fee_rule_id == SKIP
+      @fee_rule_description = fee_rule_description unless fee_rule_description == SKIP
+      @price_rule_id = price_rule_id unless price_rule_id == SKIP
+      @price_rule_description = price_rule_description unless price_rule_description == SKIP
+      @total_volume = total_volume unless total_volume == SKIP
+      @next_fee_creation_date = next_fee_creation_date unless next_fee_creation_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.
+      fee_rule_id = hash.key?('FeeRuleId') ? hash['FeeRuleId'] : SKIP
+      fee_rule_description =
+        hash.key?('FeeRuleDescription') ? hash['FeeRuleDescription'] : SKIP
+      price_rule_id = hash.key?('PriceRuleID') ? hash['PriceRuleID'] : SKIP
+      price_rule_description =
+        hash.key?('PriceRuleDescription') ? hash['PriceRuleDescription'] : SKIP
+      total_volume = hash.key?('TotalVolume') ? hash['TotalVolume'] : SKIP
+      next_fee_creation_date =
+        hash.key?('NextFeeCreationDate') ? hash['NextFeeCreationDate'] : SKIP
+
+      # Create object from extracted values.
+      PricingCurrentVolume.new(fee_rule_id,
+                               fee_rule_description,
+                               price_rule_id,
+                               price_rule_description,
+                               total_volume,
+                               next_fee_creation_date)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/pricing_history.rb

@@ -0,0 +1,105 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # PricingHistory Model.
+  class PricingHistory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Pricing History Period Start date and should be the first date of the
+    # month.
+    # Format: YYYYMMDD
+    # @return [String]
+    attr_accessor :from_date
+
+    # Pricing History Period end date and should be the last date of the period
+    # month.
+    # Format: YYYYMMDD
+    # @return [String]
+    attr_accessor :to_date
+
+    # Pricing History Period Fees Rule ID that is associated to the period of
+    # that associated payer.  
+    # Example: 8101
+    # @return [Integer]
+    attr_accessor :fees_rule_id
+
+    # Pricing History Period Fees Rule Description that is associated to the
+    # period of that associated payer.
+    # @return [String]
+    attr_accessor :fees_rule_description
+
+    # Total Quantity for the Pricing History Period that is associated to that
+    # payer.
+    # @return [Float]
+    attr_accessor :total_volume
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['from_date'] = 'FromDate'
+      @_hash['to_date'] = 'ToDate'
+      @_hash['fees_rule_id'] = 'FeesRuleID'
+      @_hash['fees_rule_description'] = 'FeesRuleDescription'
+      @_hash['total_volume'] = 'TotalVolume'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        from_date
+        to_date
+        fees_rule_id
+        fees_rule_description
+        total_volume
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        from_date
+        to_date
+        fees_rule_id
+        fees_rule_description
+        total_volume
+      ]
+    end
+
+    def initialize(from_date = SKIP,
+                   to_date = SKIP,
+                   fees_rule_id = SKIP,
+                   fees_rule_description = SKIP,
+                   total_volume = SKIP)
+      @from_date = from_date unless from_date == SKIP
+      @to_date = to_date unless to_date == SKIP
+      @fees_rule_id = fees_rule_id unless fees_rule_id == SKIP
+      @fees_rule_description = fees_rule_description unless fees_rule_description == 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.
+      from_date = hash.key?('FromDate') ? hash['FromDate'] : SKIP
+      to_date = hash.key?('ToDate') ? hash['ToDate'] : SKIP
+      fees_rule_id = hash.key?('FeesRuleID') ? hash['FeesRuleID'] : SKIP
+      fees_rule_description =
+        hash.key?('FeesRuleDescription') ? hash['FeesRuleDescription'] : SKIP
+      total_volume = hash.key?('TotalVolume') ? hash['TotalVolume'] : SKIP
+
+      # Create object from extracted values.
+      PricingHistory.new(from_date,
+                         to_date,
+                         fees_rule_id,
+                         fees_rule_description,
+                         total_volume)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/purchase_categories.rb

@@ -0,0 +1,114 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # PurchaseCategories Model.
+  class PurchaseCategories < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Purchase category Id
+    # @return [Integer]
+    attr_accessor :id
+
+    # Purchase category code
+    # Example: 0,1, 2 etc.
+    # Full list below:
+    # 0 - All Fuels (without VP) and Lubricants
+    # 1 - Fuel Save only
+    # 2 - Fuel Save and Lubricants
+    # 3 - No Restrictions
+    # 4 - VP and Fuel Save
+    # 5 - Diesel ONLY
+    # 6 - Diesel and Lubricants
+    # 7 - VP and Lubricants
+    # 8 - VP and Fuel Save and Lubricants
+    # @return [String]
+    attr_accessor :code
+
+    # Purchase category name 
+    # Example: Fuel Save Only
+    # Full list below:
+    # 0 - All Fuels (without VP) and Lubricants
+    # 1 - Fuel Save only
+    # 2 - Fuel Save and Lubricants
+    # 3 - No Restrictions
+    # 4 - VP and Fuel Save
+    # 5 - Diesel ONLY
+    # 6 - Diesel and Lubricants
+    # 7 - VP and Lubricants
+    # 8 - VP and Fuel Save and Lubricants
+    # @return [String]
+    attr_accessor :name
+
+    # If True then PurchaseCategory can be used while submitting new order cards
+    # requests.
+    # If false this PurchaseCategory will not be used for Ordering Cards.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_visible
+
+    # List of Default product groups
+    # @return [String]
+    attr_accessor :product_groups
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['code'] = 'Code'
+      @_hash['name'] = 'Name'
+      @_hash['is_visible'] = 'IsVisible'
+      @_hash['product_groups'] = 'ProductGroups'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        code
+        name
+        is_visible
+        product_groups
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP,
+                   code = SKIP,
+                   name = SKIP,
+                   is_visible = SKIP,
+                   product_groups = SKIP)
+      @id = id unless id == SKIP
+      @code = code unless code == SKIP
+      @name = name unless name == SKIP
+      @is_visible = is_visible unless is_visible == SKIP
+      @product_groups = product_groups unless product_groups == 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.
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      is_visible = hash.key?('IsVisible') ? hash['IsVisible'] : SKIP
+      product_groups = hash.key?('ProductGroups') ? hash['ProductGroups'] : SKIP
+
+      # Create object from extracted values.
+      PurchaseCategories.new(id,
+                             code,
+                             name,
+                             is_visible,
+                             product_groups)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/recent_transaction_req.rb

@@ -0,0 +1,217 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # RecentTransactionReq Model.
+  class RecentTransactionReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Three character Collecting Company Code (Shell Code) of the selected payer
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Unique Identifier for the customer at payment point.
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Customer account number.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Global product code
+    # @return [String]
+    attr_accessor :product_code
+
+    # Delco country
+    # @return [String]
+    attr_accessor :purchased_in_country
+
+    # Card identifier number masked
+    # @return [String]
+    attr_accessor :card_pan
+
+    # Start date and time of transactions
+    # @return [String]
+    attr_accessor :from_date_time
+
+    # End date and time of transactions. Mandatory if FromDateTime is provided.
+    # @return [String]
+    attr_accessor :to_date_time
+
+    # Status of transaction. DO NOT pass the value if includeDeclines is passed
+    # @return [String]
+    attr_accessor :transaction_status
+
+    # When passed as ‘true’ Only returned records with Fuel transactions.(All
+    # Fuels).When passed as ‘false’ the above condition will not be checked.
+    # (Both All Fuels and Non-Fuel)
+    # @return [String]
+    attr_accessor :fuel_only
+
+    # Product group name
+    # @return [String]
+    attr_accessor :product_group_name
+
+    # Vehicle registration number embossed on the card
+    # @return [String]
+    attr_accessor :vehicle_registration_number
+
+    # Flag to enable to get declined records
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_declines
+
+    # Card issuer name
+    # @return [String]
+    attr_accessor :card_issuer_name
+
+    # Column list to be part of response, it can be 'All' to return all possible
+    # column. E.g. 'All'
+    # To get specific columns pass multiple columns name separated by comma
+    # along with 'PayerNumber'. E.g. "PayerNumber,ProductCode"
+    # @return [String]
+    attr_accessor :column_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['product_code'] = 'ProductCode'
+      @_hash['purchased_in_country'] = 'PurchasedInCountry'
+      @_hash['card_pan'] = 'CardPAN'
+      @_hash['from_date_time'] = 'FromDateTime'
+      @_hash['to_date_time'] = 'ToDateTime'
+      @_hash['transaction_status'] = 'TransactionStatus'
+      @_hash['fuel_only'] = 'FuelOnly'
+      @_hash['product_group_name'] = 'ProductGroupName'
+      @_hash['vehicle_registration_number'] = 'VehicleRegistrationNumber'
+      @_hash['include_declines'] = 'IncludeDeclines'
+      @_hash['card_issuer_name'] = 'CardIssuerName'
+      @_hash['column_list'] = 'ColumnList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        product_code
+        purchased_in_country
+        card_pan
+        from_date_time
+        to_date_time
+        transaction_status
+        fuel_only
+        product_group_name
+        vehicle_registration_number
+        include_declines
+        card_issuer_name
+        column_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_code
+        payer_number
+        account_number
+        product_code
+        purchased_in_country
+        card_pan
+        from_date_time
+        to_date_time
+        transaction_status
+        fuel_only
+        product_group_name
+        vehicle_registration_number
+        include_declines
+        card_issuer_name
+      ]
+    end
+
+    def initialize(col_co_code = nil,
+                   payer_number = nil,
+                   account_number = SKIP,
+                   product_code = SKIP,
+                   purchased_in_country = SKIP,
+                   card_pan = SKIP,
+                   from_date_time = SKIP,
+                   to_date_time = SKIP,
+                   transaction_status = SKIP,
+                   fuel_only = SKIP,
+                   product_group_name = SKIP,
+                   vehicle_registration_number = SKIP,
+                   include_declines = SKIP,
+                   card_issuer_name = SKIP,
+                   column_list = SKIP)
+      @col_co_code = col_co_code
+      @payer_number = payer_number
+      @account_number = account_number unless account_number == SKIP
+      @product_code = product_code unless product_code == SKIP
+      @purchased_in_country = purchased_in_country unless purchased_in_country == SKIP
+      @card_pan = card_pan unless card_pan == SKIP
+      @from_date_time = from_date_time unless from_date_time == SKIP
+      @to_date_time = to_date_time unless to_date_time == SKIP
+      @transaction_status = transaction_status unless transaction_status == SKIP
+      @fuel_only = fuel_only unless fuel_only == SKIP
+      @product_group_name = product_group_name unless product_group_name == SKIP
+      unless vehicle_registration_number == SKIP
+        @vehicle_registration_number =
+          vehicle_registration_number
+      end
+      @include_declines = include_declines unless include_declines == SKIP
+      @card_issuer_name = card_issuer_name unless card_issuer_name == SKIP
+      @column_list = column_list unless column_list == 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_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : nil
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : nil
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      product_code = hash.key?('ProductCode') ? hash['ProductCode'] : SKIP
+      purchased_in_country =
+        hash.key?('PurchasedInCountry') ? hash['PurchasedInCountry'] : SKIP
+      card_pan = hash.key?('CardPAN') ? hash['CardPAN'] : SKIP
+      from_date_time = hash.key?('FromDateTime') ? hash['FromDateTime'] : SKIP
+      to_date_time = hash.key?('ToDateTime') ? hash['ToDateTime'] : SKIP
+      transaction_status =
+        hash.key?('TransactionStatus') ? hash['TransactionStatus'] : SKIP
+      fuel_only = hash.key?('FuelOnly') ? hash['FuelOnly'] : SKIP
+      product_group_name =
+        hash.key?('ProductGroupName') ? hash['ProductGroupName'] : SKIP
+      vehicle_registration_number =
+        hash.key?('VehicleRegistrationNumber') ? hash['VehicleRegistrationNumber'] : SKIP
+      include_declines =
+        hash.key?('IncludeDeclines') ? hash['IncludeDeclines'] : SKIP
+      card_issuer_name =
+        hash.key?('CardIssuerName') ? hash['CardIssuerName'] : SKIP
+      column_list = hash.key?('ColumnList') ? hash['ColumnList'] : SKIP
+
+      # Create object from extracted values.
+      RecentTransactionReq.new(col_co_code,
+                               payer_number,
+                               account_number,
+                               product_code,
+                               purchased_in_country,
+                               card_pan,
+                               from_date_time,
+                               to_date_time,
+                               transaction_status,
+                               fuel_only,
+                               product_group_name,
+                               vehicle_registration_number,
+                               include_declines,
+                               card_issuer_name,
+                               column_list)
+    end
+  end
+end