data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/fuel_consumption_request.rb

@@ -0,0 +1,197 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # FuelConsumptionRequest Model.
+  class FuelConsumptionRequest < 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
+
+    # Payer Number of the selected payer.
+    # Optional if PayerId is passed else Mandatory
+    # @return [Array[Accounts]]
+    attr_accessor :accounts
+
+    # Card Group Id in GFN
+    # Optional
+    # Example: 200
+    # @return [Integer]
+    attr_accessor :card_group_id
+
+    # Card Group Name
+    # Optional
+    # This input is a search criterion, if given.
+    # @return [String]
+    attr_accessor :card_group_name
+
+    # Card Group Name
+    # Optional
+    # This input is a search criterion, if given.
+    # @return [Array[FuelConsumptionCard]]
+    attr_accessor :cards
+
+    # Transactions from Date
+    # Optional – ‘Period’ will be considered when this field is not provided.
+    # @return [String]
+    attr_accessor :from_date
+
+    # Transactions to Date
+    # Optional
+    # Format: yyyyMMdd
+    # @return [String]
+    attr_accessor :to_date
+
+    # Transactions Period. This is ignored when FromDate is supplied on the
+    # request 
+    # Allowed values :
+    # 1.	Last 7 Days
+    # 2.	Last 30 Days
+    # 3.	Last 90 Days
+    # Optional - When FromDate/ToDate and Period are not provided, ‘Last 7 Days’
+    # value is considered as default Period.
+    # @return [Integer]
+    attr_accessor :period
+
+    # 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['accounts'] = 'Accounts'
+      @_hash['card_group_id'] = 'CardGroupId'
+      @_hash['card_group_name'] = 'CardGroupName'
+      @_hash['cards'] = 'Cards'
+      @_hash['from_date'] = 'FromDate'
+      @_hash['to_date'] = 'ToDate'
+      @_hash['period'] = 'Period'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        accounts
+        card_group_id
+        card_group_name
+        cards
+        from_date
+        to_date
+        period
+      ]
+    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,
+                   accounts = SKIP,
+                   card_group_id = SKIP,
+                   card_group_name = SKIP,
+                   cards = SKIP,
+                   from_date = SKIP,
+                   to_date = SKIP,
+                   period = 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
+      @accounts = accounts unless accounts == SKIP
+      @card_group_id = card_group_id unless card_group_id == SKIP
+      @card_group_name = card_group_name unless card_group_name == SKIP
+      @cards = cards unless cards == SKIP
+      @from_date = from_date unless from_date == SKIP
+      @to_date = to_date unless to_date == SKIP
+      @period = period unless period == 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
+      accounts = nil
+      unless hash['Accounts'].nil?
+        accounts = []
+        hash['Accounts'].each do |structure|
+          accounts << (Accounts.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = SKIP unless hash.key?('Accounts')
+      card_group_id = hash.key?('CardGroupId') ? hash['CardGroupId'] : SKIP
+      card_group_name =
+        hash.key?('CardGroupName') ? hash['CardGroupName'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      cards = nil
+      unless hash['Cards'].nil?
+        cards = []
+        hash['Cards'].each do |structure|
+          cards << (FuelConsumptionCard.from_hash(structure) if structure)
+        end
+      end
+
+      cards = SKIP unless hash.key?('Cards')
+      from_date = hash.key?('FromDate') ? hash['FromDate'] : SKIP
+      to_date = hash.key?('ToDate') ? hash['ToDate'] : SKIP
+      period = hash.key?('Period') ? hash['Period'] : SKIP
+
+      # Create object from extracted values.
+      FuelConsumptionRequest.new(col_co_id,
+                                 col_co_code,
+                                 payer_id,
+                                 payer_number,
+                                 accounts,
+                                 card_group_id,
+                                 card_group_name,
+                                 cards,
+                                 from_date,
+                                 to_date,
+                                 period)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/fuel_consumption_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
+  # FuelConsumptionResponse Model.
+  class FuelConsumptionResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[FuelConsumptionData]]
+    attr_accessor :fuel_consumption
+
+    # 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['fuel_consumption'] = 'FuelConsumption'
+      @_hash['error'] = 'Error'
+      @_hash['request_id'] = 'RequestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fuel_consumption
+        error
+        request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fuel_consumption = SKIP,
+                   error = SKIP,
+                   request_id = SKIP)
+      @fuel_consumption = fuel_consumption unless fuel_consumption == 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
+      fuel_consumption = nil
+      unless hash['FuelConsumption'].nil?
+        fuel_consumption = []
+        hash['FuelConsumption'].each do |structure|
+          fuel_consumption << (FuelConsumptionData.from_hash(structure) if structure)
+        end
+      end
+
+      fuel_consumption = SKIP unless hash.key?('FuelConsumption')
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+
+      # Create object from extracted values.
+      FuelConsumptionResponse.new(fuel_consumption,
+                                  error,
+                                  request_id)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/invoice_dates_data.rb

@@ -0,0 +1,62 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # InvoiceDatesData Model.
+  class InvoiceDatesData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of Invoice numbers.
+    # @return [Array[String]]
+    attr_accessor :invoice_numbers
+
+    # List of Invoicing dates.
+    # Format: yyyyMMdd
+    # @return [Array[String]]
+    attr_accessor :invoice_dates
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['invoice_numbers'] = 'InvoiceNumbers'
+      @_hash['invoice_dates'] = 'InvoiceDates'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        invoice_numbers
+        invoice_dates
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(invoice_numbers = SKIP,
+                   invoice_dates = SKIP)
+      @invoice_numbers = invoice_numbers unless invoice_numbers == SKIP
+      @invoice_dates = invoice_dates unless invoice_dates == 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.
+      invoice_numbers =
+        hash.key?('InvoiceNumbers') ? hash['InvoiceNumbers'] : SKIP
+      invoice_dates = hash.key?('InvoiceDates') ? hash['InvoiceDates'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceDatesData.new(invoice_numbers,
+                           invoice_dates)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/invoice_dates_request.rb

@@ -0,0 +1,50 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # InvoiceDatesRequest Model.
+  class InvoiceDatesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [InvoiceDatesRequestFilters]
+    attr_accessor :filters
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['filters'] = 'Filters'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        filters
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(filters = SKIP)
+      @filters = filters unless filters == 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.
+      filters = InvoiceDatesRequestFilters.from_hash(hash['Filters']) if hash['Filters']
+
+      # Create object from extracted values.
+      InvoiceDatesRequest.new(filters)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/invoice_dates_request_filters.rb

@@ -0,0 +1,146 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # InvoiceDatesRequestFilters Model.
+  class InvoiceDatesRequestFilters < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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-Philippines
+    # 5-UK
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Collecting Company Id of the selected payer. 
+    # Optional if ColCoCode is passed else Mandatory.
+    # Example:
+    # 1-Philippines
+    # 5-UK
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # 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
+
+    # Invoice date searched from this date.
+    # Optional.
+    # This input is a search criterion, if given.
+    # Date format: yyyyMMdd
+    # @return [String]
+    attr_accessor :from_date
+
+    # Invoice date searched until this date.
+    # Optional.
+    # This input is a search criterion, if given.
+    # Date format: yyyyMMdd
+    # @return [String]
+    attr_accessor :to_date
+
+    # Invoice date searched until this date.
+    # Optional.
+    # This input is a search criterion, if given.
+    # Date format: yyyyMMdd
+    # @return [Array[Accounts]]
+    attr_accessor :accounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['from_date'] = 'FromDate'
+      @_hash['to_date'] = 'ToDate'
+      @_hash['accounts'] = 'Accounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_code
+        col_co_id
+        payer_id
+        payer_number
+        from_date
+        to_date
+        accounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_code
+        col_co_id
+        payer_id
+        payer_number
+        from_date
+        to_date
+      ]
+    end
+
+    def initialize(col_co_code = SKIP,
+                   col_co_id = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   from_date = SKIP,
+                   to_date = SKIP,
+                   accounts = SKIP)
+      @col_co_code = col_co_code unless col_co_code == SKIP
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @from_date = from_date unless from_date == SKIP
+      @to_date = to_date unless to_date == SKIP
+      @accounts = accounts unless accounts == 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'] : SKIP
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      from_date = hash.key?('FromDate') ? hash['FromDate'] : SKIP
+      to_date = hash.key?('ToDate') ? hash['ToDate'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      accounts = nil
+      unless hash['Accounts'].nil?
+        accounts = []
+        hash['Accounts'].each do |structure|
+          accounts << (Accounts.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = SKIP unless hash.key?('Accounts')
+
+      # Create object from extracted values.
+      InvoiceDatesRequestFilters.new(col_co_code,
+                                     col_co_id,
+                                     payer_id,
+                                     payer_number,
+                                     from_date,
+                                     to_date,
+                                     accounts)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/invoice_dates_response_data.rb

@@ -0,0 +1,80 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # InvoiceDatesResponseData Model.
+  class InvoiceDatesResponseData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique request identifier passed from end user. This identifier helps in
+    # tracing a transaction
+    # @return [String]
+    attr_accessor :request_id
+
+    # Indicates overall status of the request. Allowed values: SUCCES, FAILED
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates overall status of the request. Allowed values: SUCCES, FAILED
+    # @return [Array[InvoiceDatesData]]
+    attr_accessor :data
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   status = SKIP,
+                   data = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @data = data unless data == 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 << (InvoiceDatesData.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+
+      # Create object from extracted values.
+      InvoiceDatesResponseData.new(request_id,
+                                   status,
+                                   data)
+    end
+  end
+end