data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/card_usage_restrictions.rb

@@ -0,0 +1,281 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # CardUsageRestrictions Model.
+  class CardUsageRestrictions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Describes at which level the restriction is set at.
+    # Possible values:
+    # OU = Restriction set at ColCo card type 
+    # Customer = Restriction set at customer card type
+    # @return [String]
+    attr_accessor :level
+
+    # Maximum amount that can be spend on the card in a day.
+    # @return [Float]
+    attr_accessor :daily_spend_limit
+
+    # Maximum amount that can be spend on the card in a week.
+    # @return [Float]
+    attr_accessor :weekly_spend_limit
+
+    # Maximum amount that can be spend on the card in a month.
+    # @return [Float]
+    attr_accessor :monthly_spend_limit
+
+    # Maximum amount that can be spend on the card in a year.
+    # @return [Float]
+    attr_accessor :annual_spend_limit
+
+    # Maximum amount that can be spend on the card in the card’s life time.
+    # @return [Float]
+    attr_accessor :life_time_spend_limit
+
+    # Maximum volume of fuel that can be bought on the card in a day.
+    # @return [Float]
+    attr_accessor :daily_volume_limit
+
+    # Maximum volume of fuel that can be bought on the card in a week.
+    # @return [Float]
+    attr_accessor :weekly_volume_limit
+
+    # Maximum volume of fuel that can be bought on the card in a month.
+    # @return [Float]
+    attr_accessor :monthly_volume_limit
+
+    # Maximum volume of fuel that can be bought on the card in a year.
+    # @return [Float]
+    attr_accessor :annual_volume_limit
+
+    # Maximum volume of fuel that can be bought on the card in the card’s life
+    # time.
+    # @return [Float]
+    attr_accessor :life_time_volume_limit
+
+    # Maximum amount that can be spend on the card in a transaction.
+    # @return [Float]
+    attr_accessor :transaction_spend_limit
+
+    # Maximum volume of fuel that can be bought on the card in a transaction.
+    # @return [Float]
+    attr_accessor :transaction_volume_limit
+
+    # Maximum number of transactions allowed on a card in a day.
+    # @return [Float]
+    attr_accessor :daily_transaction_count
+
+    # Maximum number of transactions allowed on a card in a week.
+    # @return [Float]
+    attr_accessor :weekly_transaction_count
+
+    # Maximum number of transactions allowed on a card in a month.
+    # @return [Float]
+    attr_accessor :monthly_transaction_count
+
+    # Maximum number of transactions allowed on the card in a year.
+    # @return [Float]
+    attr_accessor :annual_transaction_count
+
+    # Maximum number of transactions allowed on the card in the card’s life
+    # time.
+    # @return [Float]
+    attr_accessor :life_time_transaction_count
+
+    # IsVelocityCeiling flag 
+    # Note: When "True", the velocity defaults configured in MS DB will be
+    # considered as the Max Limits for velocity changes. When ‘false’ max
+    # allowed limits will be 999999999999 for Type “Count” and 9999999999.99 for
+    # Type ‘Value’.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_velocity_ceiling
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['level'] = 'Level'
+      @_hash['daily_spend_limit'] = 'DailySpendLimit'
+      @_hash['weekly_spend_limit'] = 'WeeklySpendLimit'
+      @_hash['monthly_spend_limit'] = 'MonthlySpendLimit'
+      @_hash['annual_spend_limit'] = 'AnnualSpendLimit'
+      @_hash['life_time_spend_limit'] = 'LifeTimeSpendLimit'
+      @_hash['daily_volume_limit'] = 'DailyVolumeLimit'
+      @_hash['weekly_volume_limit'] = 'WeeklyVolumeLimit'
+      @_hash['monthly_volume_limit'] = 'MonthlyVolumeLimit'
+      @_hash['annual_volume_limit'] = 'AnnualVolumeLimit'
+      @_hash['life_time_volume_limit'] = 'LifeTimeVolumeLimit'
+      @_hash['transaction_spend_limit'] = 'TransactionSpendLimit'
+      @_hash['transaction_volume_limit'] = 'TransactionVolumeLimit'
+      @_hash['daily_transaction_count'] = 'DailyTransactionCount'
+      @_hash['weekly_transaction_count'] = 'WeeklyTransactionCount'
+      @_hash['monthly_transaction_count'] = 'MonthlyTransactionCount'
+      @_hash['annual_transaction_count'] = 'AnnualTransactionCount'
+      @_hash['life_time_transaction_count'] = 'LifeTimeTransactionCount'
+      @_hash['is_velocity_ceiling'] = 'IsVelocityCeiling'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        level
+        daily_spend_limit
+        weekly_spend_limit
+        monthly_spend_limit
+        annual_spend_limit
+        life_time_spend_limit
+        daily_volume_limit
+        weekly_volume_limit
+        monthly_volume_limit
+        annual_volume_limit
+        life_time_volume_limit
+        transaction_spend_limit
+        transaction_volume_limit
+        daily_transaction_count
+        weekly_transaction_count
+        monthly_transaction_count
+        annual_transaction_count
+        life_time_transaction_count
+        is_velocity_ceiling
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        level
+        daily_spend_limit
+        weekly_spend_limit
+        monthly_spend_limit
+        annual_spend_limit
+        life_time_spend_limit
+        daily_volume_limit
+        weekly_volume_limit
+        monthly_volume_limit
+        annual_volume_limit
+        life_time_volume_limit
+        transaction_spend_limit
+        transaction_volume_limit
+        daily_transaction_count
+        weekly_transaction_count
+        monthly_transaction_count
+        annual_transaction_count
+        life_time_transaction_count
+      ]
+    end
+
+    def initialize(level = SKIP,
+                   daily_spend_limit = SKIP,
+                   weekly_spend_limit = SKIP,
+                   monthly_spend_limit = SKIP,
+                   annual_spend_limit = SKIP,
+                   life_time_spend_limit = SKIP,
+                   daily_volume_limit = SKIP,
+                   weekly_volume_limit = SKIP,
+                   monthly_volume_limit = SKIP,
+                   annual_volume_limit = 0,
+                   life_time_volume_limit = SKIP,
+                   transaction_spend_limit = SKIP,
+                   transaction_volume_limit = SKIP,
+                   daily_transaction_count = SKIP,
+                   weekly_transaction_count = SKIP,
+                   monthly_transaction_count = SKIP,
+                   annual_transaction_count = SKIP,
+                   life_time_transaction_count = SKIP,
+                   is_velocity_ceiling = SKIP)
+      @level = level unless level == SKIP
+      @daily_spend_limit = daily_spend_limit unless daily_spend_limit == SKIP
+      @weekly_spend_limit = weekly_spend_limit unless weekly_spend_limit == SKIP
+      @monthly_spend_limit = monthly_spend_limit unless monthly_spend_limit == SKIP
+      @annual_spend_limit = annual_spend_limit unless annual_spend_limit == SKIP
+      @life_time_spend_limit = life_time_spend_limit unless life_time_spend_limit == SKIP
+      @daily_volume_limit = daily_volume_limit unless daily_volume_limit == SKIP
+      @weekly_volume_limit = weekly_volume_limit unless weekly_volume_limit == SKIP
+      @monthly_volume_limit = monthly_volume_limit unless monthly_volume_limit == SKIP
+      @annual_volume_limit = annual_volume_limit unless annual_volume_limit == SKIP
+      @life_time_volume_limit = life_time_volume_limit unless life_time_volume_limit == SKIP
+      @transaction_spend_limit = transaction_spend_limit unless transaction_spend_limit == SKIP
+      @transaction_volume_limit = transaction_volume_limit unless transaction_volume_limit == SKIP
+      @daily_transaction_count = daily_transaction_count unless daily_transaction_count == SKIP
+      @weekly_transaction_count = weekly_transaction_count unless weekly_transaction_count == SKIP
+      unless monthly_transaction_count == SKIP
+        @monthly_transaction_count =
+          monthly_transaction_count
+      end
+      @annual_transaction_count = annual_transaction_count unless annual_transaction_count == SKIP
+      unless life_time_transaction_count == SKIP
+        @life_time_transaction_count =
+          life_time_transaction_count
+      end
+      @is_velocity_ceiling = is_velocity_ceiling unless is_velocity_ceiling == 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.
+      level = hash.key?('Level') ? hash['Level'] : SKIP
+      daily_spend_limit =
+        hash.key?('DailySpendLimit') ? hash['DailySpendLimit'] : SKIP
+      weekly_spend_limit =
+        hash.key?('WeeklySpendLimit') ? hash['WeeklySpendLimit'] : SKIP
+      monthly_spend_limit =
+        hash.key?('MonthlySpendLimit') ? hash['MonthlySpendLimit'] : SKIP
+      annual_spend_limit =
+        hash.key?('AnnualSpendLimit') ? hash['AnnualSpendLimit'] : SKIP
+      life_time_spend_limit =
+        hash.key?('LifeTimeSpendLimit') ? hash['LifeTimeSpendLimit'] : SKIP
+      daily_volume_limit =
+        hash.key?('DailyVolumeLimit') ? hash['DailyVolumeLimit'] : SKIP
+      weekly_volume_limit =
+        hash.key?('WeeklyVolumeLimit') ? hash['WeeklyVolumeLimit'] : SKIP
+      monthly_volume_limit =
+        hash.key?('MonthlyVolumeLimit') ? hash['MonthlyVolumeLimit'] : SKIP
+      annual_volume_limit = hash['AnnualVolumeLimit'] ||= 0
+      life_time_volume_limit =
+        hash.key?('LifeTimeVolumeLimit') ? hash['LifeTimeVolumeLimit'] : SKIP
+      transaction_spend_limit =
+        hash.key?('TransactionSpendLimit') ? hash['TransactionSpendLimit'] : SKIP
+      transaction_volume_limit =
+        hash.key?('TransactionVolumeLimit') ? hash['TransactionVolumeLimit'] : SKIP
+      daily_transaction_count =
+        hash.key?('DailyTransactionCount') ? hash['DailyTransactionCount'] : SKIP
+      weekly_transaction_count =
+        hash.key?('WeeklyTransactionCount') ? hash['WeeklyTransactionCount'] : SKIP
+      monthly_transaction_count =
+        hash.key?('MonthlyTransactionCount') ? hash['MonthlyTransactionCount'] : SKIP
+      annual_transaction_count =
+        hash.key?('AnnualTransactionCount') ? hash['AnnualTransactionCount'] : SKIP
+      life_time_transaction_count =
+        hash.key?('LifeTimeTransactionCount') ? hash['LifeTimeTransactionCount'] : SKIP
+      is_velocity_ceiling =
+        hash.key?('IsVelocityCeiling') ? hash['IsVelocityCeiling'] : SKIP
+
+      # Create object from extracted values.
+      CardUsageRestrictions.new(level,
+                                daily_spend_limit,
+                                weekly_spend_limit,
+                                monthly_spend_limit,
+                                annual_spend_limit,
+                                life_time_spend_limit,
+                                daily_volume_limit,
+                                weekly_volume_limit,
+                                monthly_volume_limit,
+                                annual_volume_limit,
+                                life_time_volume_limit,
+                                transaction_spend_limit,
+                                transaction_volume_limit,
+                                daily_transaction_count,
+                                weekly_transaction_count,
+                                monthly_transaction_count,
+                                annual_transaction_count,
+                                life_time_transaction_count,
+                                is_velocity_ceiling)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/card_usage_summary_request.rb

@@ -0,0 +1,159 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # CardUsageSummaryRequest Model.
+  class CardUsageSummaryRequest < 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
+
+    # Account ID of the customer.
+    # Optional if account number is passed else mandatory.
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number of the customer.
+    # Optional if Account ID is passed else mandatory.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Card Id of the card.
+    # Optional if PAN is passed, else Mandatory.
+    # @return [Integer]
+    attr_accessor :card_id
+
+    # PAN of the card.
+    # Optional if CardId is passed, else Mandatory.
+    # @return [String]
+    attr_accessor :pan
+
+    # Expiry date of the card.
+    # Mandatory if Card ID is not provided, else optional.
+    # Format: yyyyMMdd
+    # Example: 20170930
+    # @return [String]
+    attr_accessor :card_expiry_date
+
+    # 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['card_id'] = 'CardId'
+      @_hash['pan'] = 'PAN'
+      @_hash['card_expiry_date'] = 'CardExpiryDate'
+      @_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
+        card_id
+        pan
+        card_expiry_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        account_id
+        account_number
+        card_id
+        pan
+        card_expiry_date
+      ]
+    end
+
+    def initialize(col_co_id = SKIP,
+                   col_co_code = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   account_id = SKIP,
+                   account_number = SKIP,
+                   card_id = SKIP,
+                   pan = SKIP,
+                   card_expiry_date = 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
+      @card_id = card_id unless card_id == SKIP
+      @pan = pan unless pan == SKIP
+      @card_expiry_date = card_expiry_date unless card_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.
+      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
+      card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
+      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      card_expiry_date =
+        hash.key?('CardExpiryDate') ? hash['CardExpiryDate'] : SKIP
+
+      # Create object from extracted values.
+      CardUsageSummaryRequest.new(col_co_id,
+                                  col_co_code,
+                                  payer_id,
+                                  payer_number,
+                                  account_id,
+                                  account_number,
+                                  card_id,
+                                  pan,
+                                  card_expiry_date)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/card_usage_summary_response.rb

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

data/lib/shell_data_reporting_ap_is/models/col_co_access.rb

@@ -0,0 +1,88 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # ColCoAccess Model.
+  class ColCoAccess < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting company ID.
+    # @return [String]
+    attr_accessor :col_co_id
+
+    # Collecting company code.
+    # @return [String]
+    attr_accessor :col_co_code
+
+    # Collecting company’s Country name. ex: United Kingdom
+    # @return [String]
+    attr_accessor :col_co_country_name
+
+    # Issuing Country Number.
+    #  ex: 032 - Czech Republic
+    # @return [String]
+    attr_accessor :issuing_country_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['col_co_country_name'] = 'ColCoCountryName'
+      @_hash['issuing_country_number'] = 'IssuingCountryNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        col_co_country_name
+        issuing_country_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_id
+        col_co_code
+        col_co_country_name
+        issuing_country_number
+      ]
+    end
+
+    def initialize(col_co_id = SKIP,
+                   col_co_code = SKIP,
+                   col_co_country_name = SKIP,
+                   issuing_country_number = SKIP)
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @col_co_code = col_co_code unless col_co_code == SKIP
+      @col_co_country_name = col_co_country_name unless col_co_country_name == SKIP
+      @issuing_country_number = issuing_country_number unless issuing_country_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
+      col_co_country_name =
+        hash.key?('ColCoCountryName') ? hash['ColCoCountryName'] : SKIP
+      issuing_country_number =
+        hash.key?('IssuingCountryNumber') ? hash['IssuingCountryNumber'] : SKIP
+
+      # Create object from extracted values.
+      ColCoAccess.new(col_co_id,
+                      col_co_code,
+                      col_co_country_name,
+                      issuing_country_number)
+    end
+  end
+end