data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/card_exceptions.rb

@@ -0,0 +1,268 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # CardExceptions Model.
+  class CardExceptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account Id
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Account Short Name
+    # @return [String]
+    attr_accessor :account_short_name
+
+    # Unique Card Id
+    # @return [Integer]
+    attr_accessor :card_id
+
+    # ISO currency code
+    # @return [String]
+    attr_accessor :currency_code
+
+    # Currency symbol of the Invoice Currency Code
+    # @return [String]
+    attr_accessor :currency_symbol
+
+    # Summary Day: Populated when the Period is passed as ‘Day’.
+    # @return [Integer]
+    attr_accessor :day
+
+    # Driver name
+    # @return [String]
+    attr_accessor :driver_name
+
+    # Summary Month: Populated when the Value of Period is Passed as ‘Month’.
+    # @return [Integer]
+    attr_accessor :month
+
+    # Card PAN
+    # @return [String]
+    attr_accessor :pan
+
+    # Payment customer id of the customer
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payment customer number
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Payer Short Name
+    # @return [String]
+    attr_accessor :payer_short_name
+
+    # Total Amount (In Customer Currency) of Transactions met with the given
+    # exceptions criteria.
+    # @return [Float]
+    attr_accessor :total_amount
+
+    # Total Quantity of Transactions met with the given exceptions criteria.
+    # @return [Integer]
+    attr_accessor :total_quantity
+
+    # Total number of Sales Items met with the given exception criteria.
+    # @return [Integer]
+    attr_accessor :total_sales_items
+
+    # Total number of Transactions met with the given exception criteria.
+    # @return [Integer]
+    attr_accessor :total_transactions
+
+    # Vehicle Registration Number
+    # @return [String]
+    attr_accessor :vrn
+
+    # Summary Week Number with in the given date range. Populated when the Value
+    # of Period is Passed as ‘Week’.
+    # @return [Integer]
+    attr_accessor :week
+
+    # Summary Year: Populated when the Value of Period is Passed as ‘Month’.
+    # @return [Integer]
+    attr_accessor :year
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['account_short_name'] = 'AccountShortName'
+      @_hash['card_id'] = 'CardId'
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['currency_symbol'] = 'CurrencySymbol'
+      @_hash['day'] = 'Day'
+      @_hash['driver_name'] = 'DriverName'
+      @_hash['month'] = 'Month'
+      @_hash['pan'] = 'PAN'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['payer_short_name'] = 'PayerShortName'
+      @_hash['total_amount'] = 'TotalAmount'
+      @_hash['total_quantity'] = 'TotalQuantity'
+      @_hash['total_sales_items'] = 'TotalSalesItems'
+      @_hash['total_transactions'] = 'TotalTransactions'
+      @_hash['vrn'] = 'VRN'
+      @_hash['week'] = 'Week'
+      @_hash['year'] = 'Year'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        account_number
+        account_short_name
+        card_id
+        currency_code
+        currency_symbol
+        day
+        driver_name
+        month
+        pan
+        payer_id
+        payer_number
+        payer_short_name
+        total_amount
+        total_quantity
+        total_sales_items
+        total_transactions
+        vrn
+        week
+        year
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_id
+        account_number
+        account_short_name
+        card_id
+        currency_code
+        currency_symbol
+        day
+        driver_name
+        month
+        pan
+        payer_id
+        payer_number
+        payer_short_name
+        total_amount
+        total_quantity
+        total_sales_items
+        total_transactions
+        vrn
+        week
+        year
+      ]
+    end
+
+    def initialize(account_id = SKIP,
+                   account_number = SKIP,
+                   account_short_name = SKIP,
+                   card_id = SKIP,
+                   currency_code = SKIP,
+                   currency_symbol = SKIP,
+                   day = SKIP,
+                   driver_name = SKIP,
+                   month = SKIP,
+                   pan = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   payer_short_name = SKIP,
+                   total_amount = SKIP,
+                   total_quantity = SKIP,
+                   total_sales_items = SKIP,
+                   total_transactions = SKIP,
+                   vrn = SKIP,
+                   week = SKIP,
+                   year = SKIP)
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @account_short_name = account_short_name unless account_short_name == SKIP
+      @card_id = card_id unless card_id == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @currency_symbol = currency_symbol unless currency_symbol == SKIP
+      @day = day unless day == SKIP
+      @driver_name = driver_name unless driver_name == SKIP
+      @month = month unless month == SKIP
+      @pan = pan unless pan == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @payer_short_name = payer_short_name unless payer_short_name == SKIP
+      @total_amount = total_amount unless total_amount == SKIP
+      @total_quantity = total_quantity unless total_quantity == SKIP
+      @total_sales_items = total_sales_items unless total_sales_items == SKIP
+      @total_transactions = total_transactions unless total_transactions == SKIP
+      @vrn = vrn unless vrn == SKIP
+      @week = week unless week == SKIP
+      @year = year unless year == 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_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      account_short_name =
+        hash.key?('AccountShortName') ? hash['AccountShortName'] : SKIP
+      card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
+      currency_symbol =
+        hash.key?('CurrencySymbol') ? hash['CurrencySymbol'] : SKIP
+      day = hash.key?('Day') ? hash['Day'] : SKIP
+      driver_name = hash.key?('DriverName') ? hash['DriverName'] : SKIP
+      month = hash.key?('Month') ? hash['Month'] : SKIP
+      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      payer_short_name =
+        hash.key?('PayerShortName') ? hash['PayerShortName'] : SKIP
+      total_amount = hash.key?('TotalAmount') ? hash['TotalAmount'] : SKIP
+      total_quantity = hash.key?('TotalQuantity') ? hash['TotalQuantity'] : SKIP
+      total_sales_items =
+        hash.key?('TotalSalesItems') ? hash['TotalSalesItems'] : SKIP
+      total_transactions =
+        hash.key?('TotalTransactions') ? hash['TotalTransactions'] : SKIP
+      vrn = hash.key?('VRN') ? hash['VRN'] : SKIP
+      week = hash.key?('Week') ? hash['Week'] : SKIP
+      year = hash.key?('Year') ? hash['Year'] : SKIP
+
+      # Create object from extracted values.
+      CardExceptions.new(account_id,
+                         account_number,
+                         account_short_name,
+                         card_id,
+                         currency_code,
+                         currency_symbol,
+                         day,
+                         driver_name,
+                         month,
+                         pan,
+                         payer_id,
+                         payer_number,
+                         payer_short_name,
+                         total_amount,
+                         total_quantity,
+                         total_sales_items,
+                         total_transactions,
+                         vrn,
+                         week,
+                         year)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/card_group_request.rb

@@ -0,0 +1,178 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # CardGroupRequest Model.
+  class CardGroupRequest < 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.
+    # Example:
+    # 86 for Philippines
+    # 5 for UK
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Payer id of the customer.
+    # Optional if PayerNumber is passed, else Mandatory.
+    # This input is a search criterion.
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # PayerNumber of the customer.
+    # Optional if PayerId is passed, else Mandatory. 
+    # This input is a search criterion.
+    # Example: GB00123456
+    # @return [String]
+    attr_accessor :payer_number
+
+    # PayerNumber of the customer.
+    # Optional if PayerId is passed, else Mandatory. 
+    # This input is a search criterion.
+    # Example: GB00123456
+    # @return [Array[Accounts]]
+    attr_accessor :account
+
+    # Card Group Name 
+    # Optional. 
+    # Minimum of 2 characters should be provided else not considered.
+    # CardGroups those have the entered value at any part
+    # @return [String]
+    attr_accessor :card_group_name
+
+    # Card Group Status
+    # Mandatory
+    # Allowed values:
+    # •	ALL
+    # •	TERMINATED
+    # •	ACTIVE
+    # @return [String]
+    attr_accessor :status
+
+    # Page Number (as shown to the users)
+    # Optional
+    # Default value 1
+    # @return [Integer]
+    attr_accessor :current_page
+
+    # Page Size – Number of records to show on a page.
+    # Optional
+    # Default value 50.
+    # Return all rows if -1 is supplied as page size.
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # 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'] = 'Account'
+      @_hash['card_group_name'] = 'CardGroupName'
+      @_hash['status'] = 'Status'
+      @_hash['current_page'] = 'CurrentPage'
+      @_hash['page_size'] = 'PageSize'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        account
+        card_group_name
+        status
+        current_page
+        page_size
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        card_group_name
+        status
+      ]
+    end
+
+    def initialize(col_co_id = SKIP,
+                   col_co_code = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   account = SKIP,
+                   card_group_name = SKIP,
+                   status = SKIP,
+                   current_page = SKIP,
+                   page_size = 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 = account unless account == SKIP
+      @card_group_name = card_group_name unless card_group_name == SKIP
+      @status = status unless status == SKIP
+      @current_page = current_page unless current_page == SKIP
+      @page_size = page_size unless page_size == 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
+      # Parameter is an array, so we need to iterate through it
+      account = nil
+      unless hash['Account'].nil?
+        account = []
+        hash['Account'].each do |structure|
+          account << (Accounts.from_hash(structure) if structure)
+        end
+      end
+
+      account = SKIP unless hash.key?('Account')
+      card_group_name =
+        hash.key?('CardGroupName') ? hash['CardGroupName'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      current_page = hash.key?('CurrentPage') ? hash['CurrentPage'] : SKIP
+      page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
+
+      # Create object from extracted values.
+      CardGroupRequest.new(col_co_id,
+                           col_co_code,
+                           payer_id,
+                           payer_number,
+                           account,
+                           card_group_name,
+                           status,
+                           current_page,
+                           page_size)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/card_group_response.rb

@@ -0,0 +1,109 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # CardGroupResponse Model.
+  class CardGroupResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CardGroupResponseCardGroupsItems]]
+    attr_accessor :card_groups
+
+    # current page
+    # @return [Integer]
+    attr_accessor :current_page
+
+    # number of records in current response
+    # @return [Integer]
+    attr_accessor :row_count
+
+    # Total pages available
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # Total pages available
+    # @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['card_groups'] = 'CardGroups'
+      @_hash['current_page'] = 'CurrentPage'
+      @_hash['row_count'] = 'RowCount'
+      @_hash['total_pages'] = 'TotalPages'
+      @_hash['error'] = 'Error'
+      @_hash['request_id'] = 'RequestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_groups
+        current_page
+        row_count
+        total_pages
+        error
+        request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_groups = SKIP,
+                   current_page = SKIP,
+                   row_count = SKIP,
+                   total_pages = SKIP,
+                   error = SKIP,
+                   request_id = SKIP)
+      @card_groups = card_groups unless card_groups == SKIP
+      @current_page = current_page unless current_page == SKIP
+      @row_count = row_count unless row_count == SKIP
+      @total_pages = total_pages unless total_pages == 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
+      card_groups = nil
+      unless hash['CardGroups'].nil?
+        card_groups = []
+        hash['CardGroups'].each do |structure|
+          card_groups << (CardGroupResponseCardGroupsItems.from_hash(structure) if structure)
+        end
+      end
+
+      card_groups = SKIP unless hash.key?('CardGroups')
+      current_page = hash.key?('CurrentPage') ? hash['CurrentPage'] : SKIP
+      row_count = hash.key?('RowCount') ? hash['RowCount'] : SKIP
+      total_pages = hash.key?('TotalPages') ? hash['TotalPages'] : SKIP
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+
+      # Create object from extracted values.
+      CardGroupResponse.new(card_groups,
+                            current_page,
+                            row_count,
+                            total_pages,
+                            error,
+                            request_id)
+    end
+  end
+end