data-and-reporting-sdk 1.0.0

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

data/lib/shell_data_reporting_ap_is/models/priced_trans_summary_response_transactions_summary_items.rb

@@ -0,0 +1,242 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # PricedTransSummaryResponseTransactionsSummaryItems Model.
+  class PricedTransSummaryResponseTransactionsSummaryItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Product Id
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # Product Code
+    # Examples: 
+    # 10	TMF Charges
+    # 11	Tunnel/Bridges
+    # 12	Motorway toll
+    # 13	Ferries
+    # @return [String]
+    attr_accessor :product_code
+
+    # Product Name
+    # Examples: 
+    # Unleaded - High octane
+    # Unleaded - Medium octane
+    # Unleaded - Low octane
+    # Unleaded Environmental
+    # @return [String]
+    attr_accessor :product_name
+
+    # Product Group Id
+    # Example: 
+    # 1	Parent Product Group
+    # 2	All Fuels
+    # 3	Motor gasoline
+    # 4	2 stroke
+    # 5	Autogas
+    # 6	CNG
+    # @return [Integer]
+    attr_accessor :product_group_id
+
+    # Product Group Name
+    # Example: 
+    # 1	Parent Product Group
+    # 2	All Fuels
+    # 3	Motor gasoline
+    # 4	2 stroke
+    # 5	Autogas
+    # 6	CNG
+    # 7	Automotive Gas Oil
+    # @return [String]
+    attr_accessor :product_group_name
+
+    # Site Group Id
+    # Example: 202
+    # @return [Integer]
+    attr_accessor :site_group_id
+
+    # Site Group Name
+    # Example: CZ 9100 ECONOMY NETWORK
+    # @return [String]
+    attr_accessor :site_group_name
+
+    # Total Fuel Quantity
+    # @return [Integer]
+    attr_accessor :total_fuel_quantity
+
+    # Total Net amount in invoice currency
+    # @return [Integer]
+    attr_accessor :total_net_amount
+
+    # Total Gross amount in invoice currency
+    # @return [Integer]
+    attr_accessor :total_gross_amount
+
+    # ISO currency code 
+    # Example: GBP
+    # @return [String]
+    attr_accessor :invoice_currency_code
+
+    # Currency symbol of the Invoice Currency Code 
+    # Example: £, $
+    # @return [String]
+    attr_accessor :invoice_currency_symbol
+
+    # Sum of the retail net price
+    # @return [Float]
+    attr_accessor :customer_retail_value_total_net
+
+    # Sum of the retail gross price
+    # @return [Float]
+    attr_accessor :customer_retail_value_total_gross
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_id'] = 'ProductId'
+      @_hash['product_code'] = 'ProductCode'
+      @_hash['product_name'] = 'ProductName'
+      @_hash['product_group_id'] = 'ProductGroupId'
+      @_hash['product_group_name'] = 'ProductGroupName'
+      @_hash['site_group_id'] = 'SiteGroupId'
+      @_hash['site_group_name'] = 'SiteGroupName'
+      @_hash['total_fuel_quantity'] = 'TotalFuelQuantity'
+      @_hash['total_net_amount'] = 'TotalNetAmount'
+      @_hash['total_gross_amount'] = 'TotalGrossAmount'
+      @_hash['invoice_currency_code'] = 'InvoiceCurrencyCode'
+      @_hash['invoice_currency_symbol'] = 'InvoiceCurrencySymbol'
+      @_hash['customer_retail_value_total_net'] =
+        'CustomerRetailValueTotalNet'
+      @_hash['customer_retail_value_total_gross'] =
+        'CustomerRetailValueTotalGross'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_id
+        product_code
+        product_name
+        product_group_id
+        product_group_name
+        site_group_id
+        site_group_name
+        total_fuel_quantity
+        total_net_amount
+        total_gross_amount
+        invoice_currency_code
+        invoice_currency_symbol
+        customer_retail_value_total_net
+        customer_retail_value_total_gross
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        product_id
+        product_code
+        product_name
+        product_group_id
+        product_group_name
+        site_group_id
+        site_group_name
+        total_fuel_quantity
+        total_net_amount
+        total_gross_amount
+        invoice_currency_code
+        invoice_currency_symbol
+        customer_retail_value_total_net
+        customer_retail_value_total_gross
+      ]
+    end
+
+    def initialize(product_id = SKIP,
+                   product_code = SKIP,
+                   product_name = SKIP,
+                   product_group_id = SKIP,
+                   product_group_name = SKIP,
+                   site_group_id = SKIP,
+                   site_group_name = SKIP,
+                   total_fuel_quantity = SKIP,
+                   total_net_amount = SKIP,
+                   total_gross_amount = SKIP,
+                   invoice_currency_code = SKIP,
+                   invoice_currency_symbol = SKIP,
+                   customer_retail_value_total_net = SKIP,
+                   customer_retail_value_total_gross = SKIP)
+      @product_id = product_id unless product_id == SKIP
+      @product_code = product_code unless product_code == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @product_group_id = product_group_id unless product_group_id == SKIP
+      @product_group_name = product_group_name unless product_group_name == SKIP
+      @site_group_id = site_group_id unless site_group_id == SKIP
+      @site_group_name = site_group_name unless site_group_name == SKIP
+      @total_fuel_quantity = total_fuel_quantity unless total_fuel_quantity == SKIP
+      @total_net_amount = total_net_amount unless total_net_amount == SKIP
+      @total_gross_amount = total_gross_amount unless total_gross_amount == SKIP
+      @invoice_currency_code = invoice_currency_code unless invoice_currency_code == SKIP
+      @invoice_currency_symbol = invoice_currency_symbol unless invoice_currency_symbol == SKIP
+      unless customer_retail_value_total_net == SKIP
+        @customer_retail_value_total_net =
+          customer_retail_value_total_net
+      end
+      unless customer_retail_value_total_gross == SKIP
+        @customer_retail_value_total_gross =
+          customer_retail_value_total_gross
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      product_id = hash.key?('ProductId') ? hash['ProductId'] : SKIP
+      product_code = hash.key?('ProductCode') ? hash['ProductCode'] : SKIP
+      product_name = hash.key?('ProductName') ? hash['ProductName'] : SKIP
+      product_group_id =
+        hash.key?('ProductGroupId') ? hash['ProductGroupId'] : SKIP
+      product_group_name =
+        hash.key?('ProductGroupName') ? hash['ProductGroupName'] : SKIP
+      site_group_id = hash.key?('SiteGroupId') ? hash['SiteGroupId'] : SKIP
+      site_group_name =
+        hash.key?('SiteGroupName') ? hash['SiteGroupName'] : SKIP
+      total_fuel_quantity =
+        hash.key?('TotalFuelQuantity') ? hash['TotalFuelQuantity'] : SKIP
+      total_net_amount =
+        hash.key?('TotalNetAmount') ? hash['TotalNetAmount'] : SKIP
+      total_gross_amount =
+        hash.key?('TotalGrossAmount') ? hash['TotalGrossAmount'] : SKIP
+      invoice_currency_code =
+        hash.key?('InvoiceCurrencyCode') ? hash['InvoiceCurrencyCode'] : SKIP
+      invoice_currency_symbol =
+        hash.key?('InvoiceCurrencySymbol') ? hash['InvoiceCurrencySymbol'] : SKIP
+      customer_retail_value_total_net =
+        hash.key?('CustomerRetailValueTotalNet') ? hash['CustomerRetailValueTotalNet'] : SKIP
+      customer_retail_value_total_gross =
+        hash.key?('CustomerRetailValueTotalGross') ? hash['CustomerRetailValueTotalGross'] : SKIP
+
+      # Create object from extracted values.
+      PricedTransSummaryResponseTransactionsSummaryItems.new(product_id,
+                                                             product_code,
+                                                             product_name,
+                                                             product_group_id,
+                                                             product_group_name,
+                                                             site_group_id,
+                                                             site_group_name,
+                                                             total_fuel_quantity,
+                                                             total_net_amount,
+                                                             total_gross_amount,
+                                                             invoice_currency_code,
+                                                             invoice_currency_symbol,
+                                                             customer_retail_value_total_net,
+                                                             customer_retail_value_total_gross)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/priced_transaction_items_location_items.rb

@@ -0,0 +1,67 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # PricedTransactionItemsLocationItems Model.
+  class PricedTransactionItemsLocationItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Latitude for the Site Geographic Location
+    # Example: 37.4224764
+    # Note: - The value could be null/blank for fees item.
+    # @return [String]
+    attr_accessor :latitude
+
+    # Longitude for the Site Geographic Location
+    # Example: 122.0842499
+    # Note: - The value could be null/blank for fees item.
+    # @return [String]
+    attr_accessor :longitude
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['latitude'] = 'Latitude'
+      @_hash['longitude'] = 'Longitude'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        latitude
+        longitude
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        latitude
+        longitude
+      ]
+    end
+
+    def initialize(latitude = SKIP,
+                   longitude = SKIP)
+      @latitude = latitude unless latitude == SKIP
+      @longitude = longitude unless longitude == 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.
+      latitude = hash.key?('Latitude') ? hash['Latitude'] : SKIP
+      longitude = hash.key?('Longitude') ? hash['Longitude'] : SKIP
+
+      # Create object from extracted values.
+      PricedTransactionItemsLocationItems.new(latitude,
+                                              longitude)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/priced_transaction_req_v2_invoice_status_enum.rb

@@ -0,0 +1,27 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Invoice status of the transactions. Mandatory Possible options:I - Invoiced,
+  # U – Un-Invoiced, A – All
+  class PricedTransactionReqV2InvoiceStatusEnum
+    PRICED_TRANSACTION_REQ_V2_INVOICE_STATUS_ENUM = [
+      # TODO: Write general description for I
+      I = 'I'.freeze,
+
+      # TODO: Write general description for U
+      U = 'U'.freeze,
+
+      # TODO: Write general description for A
+      A = 'A'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PRICED_TRANSACTION_REQ_V2_INVOICE_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/priced_transaction_req_v2_period_enum.rb

@@ -0,0 +1,27 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Pass below one of the value as per the required transaction period 1. Last 7
+  # Days 2. Last 30 Days 3. Last 90 Days
+  class PricedTransactionReqV2PeriodEnum
+    PRICED_TRANSACTION_REQ_V2_PERIOD_ENUM = [
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = 1,
+
+      # TODO: Write general description for ENUM_2
+      ENUM_2 = 2,
+
+      # TODO: Write general description for ENUM_3
+      ENUM_3 = 3
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PRICED_TRANSACTION_REQ_V2_PERIOD_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/priced_transaction_req_v2_sort_order_enum.rb

@@ -0,0 +1,37 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Allowed Sorting Options 1.    TransactionDateAscending 2.
+  # TransactionDateDescending 3.    GrossAmountDescending 4.
+  # GrossAmountAscending 5.    NetAmountAscending 6.    NetAmountDescensding
+  class PricedTransactionReqV2SortOrderEnum
+    PRICED_TRANSACTION_REQ_V2_SORT_ORDER_ENUM = [
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = '1'.freeze,
+
+      # TODO: Write general description for ENUM_2
+      ENUM_2 = '2'.freeze,
+
+      # TODO: Write general description for ENUM_3
+      ENUM_3 = '3'.freeze,
+
+      # TODO: Write general description for ENUM_4
+      ENUM_4 = '4'.freeze,
+
+      # TODO: Write general description for ENUM_5
+      ENUM_5 = '5'.freeze,
+
+      # TODO: Write general description for ENUM_6
+      ENUM_6 = '6'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PRICED_TRANSACTION_REQ_V2_SORT_ORDER_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/priced_transaction_request_v2.rb

@@ -0,0 +1,72 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # PricedTransactionRequestV2 Model.
+  class PricedTransactionRequestV2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This endpoint allows querying the transaction data (i.e. Priced, Billed
+    # and Unbilled sales items) from SFSBI. It provides a flexible search
+    # criteria and supports paging
+    # @return [PricedRequestData]
+    attr_accessor :filters
+
+    # Specify the page of results to be returned.
+    # @return [Integer]
+    attr_accessor :page
+
+    # Specify the number of records to returned; Max 1000
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['filters'] = 'Filters'
+      @_hash['page'] = 'Page'
+      @_hash['page_size'] = 'PageSize'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        filters
+        page
+        page_size
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(filters = SKIP,
+                   page = SKIP,
+                   page_size = SKIP)
+      @filters = filters unless filters == SKIP
+      @page = page unless 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.
+      filters = PricedRequestData.from_hash(hash['Filters']) if hash['Filters']
+      page = hash.key?('Page') ? hash['Page'] : SKIP
+      page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
+
+      # Create object from extracted values.
+      PricedTransactionRequestV2.new(filters,
+                                     page,
+                                     page_size)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/priced_transaction_resp_v2_refund_flag_enum.rb

@@ -0,0 +1,23 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Flag to check if there is any refund
+  class PricedTransactionRespV2RefundFlagEnum
+    PRICED_TRANSACTION_RESP_V2_REFUND_FLAG_ENUM = [
+      # TODO: Write general description for Y
+      Y = 'Y'.freeze,
+
+      # TODO: Write general description for N
+      N = 'N'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PRICED_TRANSACTION_RESP_V2_REFUND_FLAG_ENUM.include?(value)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/priced_transaction_response.rb

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