data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/volume_based_pricing_request.rb

@@ -0,0 +1,103 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # VolumeBasedPricingRequest Model.
+  class VolumeBasedPricingRequest < 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
+
+    # The API will return the details of the previously calculated/paid bonus
+    # and fuel consumption (Volume) in the response when this flag is ‘True’.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_history
+
+    # 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['include_history'] = 'IncludeHistory'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        include_history
+      ]
+    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,
+                   include_history = 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
+      @include_history = include_history unless include_history == 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
+      include_history =
+        hash.key?('IncludeHistory') ? hash['IncludeHistory'] : SKIP
+
+      # Create object from extracted values.
+      VolumeBasedPricingRequest.new(col_co_id,
+                                    col_co_code,
+                                    payer_id,
+                                    payer_number,
+                                    include_history)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/volume_based_pricing_response.rb

@@ -0,0 +1,120 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # VolumeBasedPricingResponse Model.
+  class VolumeBasedPricingResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[BonusConfiguration]]
+    attr_accessor :configuration
+
+    # TODO: Write general description for this method
+    # @return [Array[PricingCurrentVolume]]
+    attr_accessor :current_period_consumption
+
+    # TODO: Write general description for this method
+    # @return [Array[PricingHistory]]
+    attr_accessor :history
+
+    # 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['configuration'] = 'Configuration'
+      @_hash['current_period_consumption'] = 'CurrentPeriodConsumption'
+      @_hash['history'] = 'History'
+      @_hash['error'] = 'Error'
+      @_hash['request_id'] = 'RequestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        configuration
+        current_period_consumption
+        history
+        error
+        request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(configuration = SKIP,
+                   current_period_consumption = SKIP,
+                   history = SKIP,
+                   error = SKIP,
+                   request_id = SKIP)
+      @configuration = configuration unless configuration == SKIP
+      unless current_period_consumption == SKIP
+        @current_period_consumption =
+          current_period_consumption
+      end
+      @history = history unless history == 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
+      configuration = nil
+      unless hash['Configuration'].nil?
+        configuration = []
+        hash['Configuration'].each do |structure|
+          configuration << (BonusConfiguration.from_hash(structure) if structure)
+        end
+      end
+
+      configuration = SKIP unless hash.key?('Configuration')
+      # Parameter is an array, so we need to iterate through it
+      current_period_consumption = nil
+      unless hash['CurrentPeriodConsumption'].nil?
+        current_period_consumption = []
+        hash['CurrentPeriodConsumption'].each do |structure|
+          current_period_consumption << (PricingCurrentVolume.from_hash(structure) if structure)
+        end
+      end
+
+      current_period_consumption = SKIP unless hash.key?('CurrentPeriodConsumption')
+      # Parameter is an array, so we need to iterate through it
+      history = nil
+      unless hash['History'].nil?
+        history = []
+        hash['History'].each do |structure|
+          history << (PricingHistory.from_hash(structure) if structure)
+        end
+      end
+
+      history = SKIP unless hash.key?('History')
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+
+      # Create object from extracted values.
+      VolumeBasedPricingResponse.new(configuration,
+                                     current_period_consumption,
+                                     history,
+                                     error,
+                                     request_id)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module ShellDataReportingApIs
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/shell_data_reporting_ap_is/utilities/file_wrapper.rb

@@ -0,0 +1,16 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is.rb

@@ -0,0 +1,229 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+require 'json'
+
+require 'apimatic_core_interfaces'
+require 'apimatic_core'
+require 'apimatic_faraday_client_adapter'
+
+require_relative 'shell_data_reporting_ap_is/api_helper'
+require_relative 'shell_data_reporting_ap_is/client'
+
+# Utilities
+require_relative 'shell_data_reporting_ap_is/utilities/file_wrapper'
+require_relative 'shell_data_reporting_ap_is/utilities/date_time_helper'
+
+# Http
+require_relative 'shell_data_reporting_ap_is/http/http_call_back'
+require_relative 'shell_data_reporting_ap_is/http/http_method_enum'
+require_relative 'shell_data_reporting_ap_is/http/http_request'
+require_relative 'shell_data_reporting_ap_is/http/http_response'
+
+# Logger
+require_relative 'shell_data_reporting_ap_is/http/auth/basic_auth'
+require_relative 'shell_data_reporting_ap_is/http/auth/bearer_token'
+
+# Models
+require_relative 'shell_data_reporting_ap_is/models/base_model'
+require_relative 'shell_data_reporting_ap_is/models/logged_in_user_request'
+require_relative 'shell_data_reporting_ap_is/models/logged_in_user_response'
+require_relative 'shell_data_reporting_ap_is/models/role'
+require_relative 'shell_data_reporting_ap_is/models/payer_access'
+require_relative 'shell_data_reporting_ap_is/models/account_access'
+require_relative 'shell_data_reporting_ap_is/models/col_co_access'
+require_relative 'shell_data_reporting_ap_is/models/eid_access'
+require_relative 'shell_data_reporting_ap_is/models/error_status'
+require_relative 'shell_data_reporting_ap_is/models/default_error_fault'
+require_relative 'shell_data_reporting_ap_is/models/default_error_fault_detail'
+require_relative 'shell_data_reporting_ap_is/models/error_user_access'
+require_relative 'shell_data_reporting_ap_is/models/error_user_access_error'
+require_relative 'shell_data_reporting_ap_is/models/payer_request'
+require_relative 'shell_data_reporting_ap_is/models/payers'
+require_relative 'shell_data_reporting_ap_is/models/payer_response'
+require_relative 'shell_data_reporting_ap_is/models/payer_details'
+require_relative 'shell_data_reporting_ap_is/models/invoice_distribution_method'
+require_relative 'shell_data_reporting_ap_is/models/bank_account'
+require_relative 'shell_data_reporting_ap_is/models/address'
+require_relative 'shell_data_reporting_ap_is/models/finance_currency'
+require_relative 'shell_data_reporting_ap_is/models/customer_contract'
+require_relative 'shell_data_reporting_ap_is/models/customer_detail_request'
+require_relative 'shell_data_reporting_ap_is/models/customer_detail_response'
+require_relative 'shell_data_reporting_ap_is/models/delivery_addresses'
+require_relative 'shell_data_reporting_ap_is/models/pin_advice_types'
+require_relative 'shell_data_reporting_ap_is/models/customer_price_list_request'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'customer_price_list_response'
+require_relative 'shell_data_reporting_ap_is/models/price_list'
+require_relative 'shell_data_reporting_ap_is/models/tier'
+require_relative 'shell_data_reporting_ap_is/models/account_request'
+require_relative 'shell_data_reporting_ap_is/models/accounts'
+require_relative 'shell_data_reporting_ap_is/models/account_response'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'account_response_accounts_items'
+require_relative 'shell_data_reporting_ap_is/models/card_type_request'
+require_relative 'shell_data_reporting_ap_is/models/card_type_response'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'card_type_response_customer_card_types_items'
+require_relative 'shell_data_reporting_ap_is/models/card_day_time_restrictions'
+require_relative 'shell_data_reporting_ap_is/models/purchase_categories'
+require_relative 'shell_data_reporting_ap_is/models/card_usage_restrictions'
+require_relative 'shell_data_reporting_ap_is/models/card_type_response_error'
+require_relative 'shell_data_reporting_ap_is/models/card_group_request'
+require_relative 'shell_data_reporting_ap_is/models/card_group_response'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'card_group_response_card_groups_items'
+require_relative 'shell_data_reporting_ap_is/models/audit_request'
+require_relative 'shell_data_reporting_ap_is/models/audit_response'
+require_relative 'shell_data_reporting_ap_is/models/audit_response_audits_items'
+require_relative 'shell_data_reporting_ap_is/models/price_transaction_request'
+require_relative 'shell_data_reporting_ap_is/models/priced_transaction_response'
+require_relative 'shell_data_reporting_ap_is/models/price_trans_summary_request'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'priced_trans_summary_response'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'multi_priced_transaction_request'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'multi_priced_transaction_response'
+require_relative 'shell_data_reporting_ap_is/models/site_location'
+require_relative 'shell_data_reporting_ap_is/models/card_usage_summary_request'
+require_relative 'shell_data_reporting_ap_is/models/card_usage_summary_response'
+require_relative 'shell_data_reporting_ap_is/models/usage_summary'
+require_relative 'shell_data_reporting_ap_is/models/volume_based_bonus_request'
+require_relative 'shell_data_reporting_ap_is/models/volume_based_bonus_response'
+require_relative 'shell_data_reporting_ap_is/models/bonus_configuration'
+require_relative 'shell_data_reporting_ap_is/models/fee_rule_location'
+require_relative 'shell_data_reporting_ap_is/models/fee_rule_tier'
+require_relative 'shell_data_reporting_ap_is/models/associated_account'
+require_relative 'shell_data_reporting_ap_is/models/fee_rule_product'
+require_relative 'shell_data_reporting_ap_is/models/current_volume'
+require_relative 'shell_data_reporting_ap_is/models/bonus_history'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'volume_based_pricing_request'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'volume_based_pricing_response'
+require_relative 'shell_data_reporting_ap_is/models/pricing_current_volume'
+require_relative 'shell_data_reporting_ap_is/models/pricing_history'
+require_relative 'shell_data_reporting_ap_is/models/transaction_fees_request'
+require_relative 'shell_data_reporting_ap_is/models/transaction_fees_response'
+require_relative 'shell_data_reporting_ap_is/models/fee_item'
+require_relative 'shell_data_reporting_ap_is/models/fees_fee_rule_tiers'
+require_relative 'shell_data_reporting_ap_is/models/fee_summary_response'
+require_relative 'shell_data_reporting_ap_is/models/fee_item_summary_all_of0'
+require_relative 'shell_data_reporting_ap_is/models/fuel_consumption_request'
+require_relative 'shell_data_reporting_ap_is/models/fuel_consumption_card'
+require_relative 'shell_data_reporting_ap_is/models/fuel_consumption_response'
+require_relative 'shell_data_reporting_ap_is/models/fuel_consumption_data'
+require_relative 'shell_data_reporting_ap_is/models/update_odometer_request'
+require_relative 'shell_data_reporting_ap_is/models/update_odometer'
+require_relative 'shell_data_reporting_ap_is/models/update_odometer_response'
+require_relative 'shell_data_reporting_ap_is/models/update_odometer_reference'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'transaction_exceptions_request'
+require_relative 'shell_data_reporting_ap_is/models/exception_product'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'transaction_exceptions_response'
+require_relative 'shell_data_reporting_ap_is/models/card_exceptions'
+require_relative 'shell_data_reporting_ap_is/models/transaction_exceptions'
+require_relative 'shell_data_reporting_ap_is/models/exception_site_location'
+require_relative 'shell_data_reporting_ap_is/models/recent_transaction_request'
+require_relative 'shell_data_reporting_ap_is/models/recent_transaction_req'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'recent_transactions_response'
+require_relative 'shell_data_reporting_ap_is/models/recent_transactions'
+require_relative 'shell_data_reporting_ap_is/models/error_details'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'priced_transaction_request_v2'
+require_relative 'shell_data_reporting_ap_is/models/priced_request_data'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'priced_transaction_response_v2'
+require_relative 'shell_data_reporting_ap_is/models/priced_response_data'
+require_relative 'shell_data_reporting_ap_is/models/invoice_search_request'
+require_relative 'shell_data_reporting_ap_is/models/invoice_search_response'
+require_relative 'shell_data_reporting_ap_is/models/invoice_search_details'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'invoice_search_additional_document'
+require_relative 'shell_data_reporting_ap_is/models/invoice_summary_request'
+require_relative 'shell_data_reporting_ap_is/models/invoice_summary_response'
+require_relative 'shell_data_reporting_ap_is/models/invoice_summary_details'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'statement_of_account_request'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'statement_of_account_response'
+require_relative 'shell_data_reporting_ap_is/models/statement_of_account_resp'
+require_relative 'shell_data_reporting_ap_is/models/last_statement_of_account'
+require_relative 'shell_data_reporting_ap_is/models/monthly_invoice_trend'
+require_relative 'shell_data_reporting_ap_is/models/past_statement_of_accounts'
+require_relative 'shell_data_reporting_ap_is/models/payments_since_last_soa'
+require_relative 'shell_data_reporting_ap_is/models/invoices_summaries'
+require_relative 'shell_data_reporting_ap_is/models/invoice_dates_request'
+require_relative 'shell_data_reporting_ap_is/models/invoice_dates_response_data'
+require_relative 'shell_data_reporting_ap_is/models/invoice_dates_data'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'search_statement_of_account_request'
+require_relative 'shell_data_reporting_ap_is/models/search_soa_req'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'search_statement_of_account_response'
+require_relative 'shell_data_reporting_ap_is/models/search_statement_of_account'
+require_relative 'shell_data_reporting_ap_is/models/search_documents_request'
+require_relative 'shell_data_reporting_ap_is/models/search_doc_req'
+require_relative 'shell_data_reporting_ap_is/models/search_documents_response'
+require_relative 'shell_data_reporting_ap_is/models/search_documents_invoice'
+require_relative 'shell_data_reporting_ap_is/models/eid_search_request'
+require_relative 'shell_data_reporting_ap_is/models/eid_search_req'
+require_relative 'shell_data_reporting_ap_is/models/eid_document_response'
+require_relative 'shell_data_reporting_ap_is/models/eid_document'
+require_relative 'shell_data_reporting_ap_is/models/invoice_download_request'
+require_relative 'shell_data_reporting_ap_is/models/invoice_download_req'
+require_relative 'shell_data_reporting_ap_is/models/eid_download_request'
+require_relative 'shell_data_reporting_ap_is/models/eid_download_req'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'priced_transaction_response_transactions_items'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'priced_transaction_items_location_items'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'priced_trans_summary_response_transactions_summary_items'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'multi_priced_transaction_request_accounts_items'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'multi_priced_transaction_response_transactions_items'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'invoice_search_request_filters'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'invoice_summary_request_filters'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'statement_of_account_request_filters'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'invoice_dates_request_filters'
+require_relative 'shell_data_reporting_ap_is/models/o_auth_token'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'priced_transaction_req_v2_invoice_status_enum'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'priced_transaction_req_v2_sort_order_enum'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'priced_transaction_req_v2_period_enum'
+require_relative 'shell_data_reporting_ap_is/models/' \
+                 'priced_transaction_resp_v2_refund_flag_enum'
+require_relative 'shell_data_reporting_ap_is/models/o_auth_provider_error_enum'
+
+# Exceptions
+require_relative 'shell_data_reporting_ap_is/exceptions/api_exception'
+require_relative 'shell_data_reporting_ap_is/exceptions/default_error_exception'
+require_relative 'shell_data_reporting_ap_is/exceptions/error_object_exception'
+require_relative 'shell_data_reporting_ap_is/exceptions/' \
+                 'error_user_access_error1_exception'
+require_relative 'shell_data_reporting_ap_is/exceptions/' \
+                 'o_auth_provider_exception'
+
+require_relative 'shell_data_reporting_ap_is/configuration'
+
+# Controllers
+require_relative 'shell_data_reporting_ap_is/controllers/base_controller'
+require_relative 'shell_data_reporting_ap_is/controllers/customer_controller'
+require_relative 'shell_data_reporting_ap_is/controllers/transaction_controller'
+require_relative 'shell_data_reporting_ap_is/controllers/invoice_controller'
+require_relative 'shell_data_reporting_ap_is/controllers/' \
+                 'o_auth_authorization_controller'

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,34 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'json'
+require 'minitest/autorun'
+require 'minitest/hell'
+require 'minitest/pride'
+require 'minitest/proveit'
+require 'shell_data_reporting_ap_is'
+require_relative '../http_response_catcher'
+
+class ControllerTestBase < Minitest::Test
+  parallelize_me!
+  include ShellDataReportingApIs
+  include CoreLibrary
+
+  # Create configuration and set any test parameters
+  def create_configuration
+    Configuration.new(http_callback: HttpResponseCatcher.new)
+  end
+
+  # Initializes the base test controller
+  def setup_class
+    _config = create_configuration
+    @client = Client.new(config: _config)
+
+    bearer_token_token = @client.bearer_token.fetch_token()
+    bearer_token_credentials = _config.bearer_token_credentials.clone_with(o_auth_token: bearer_token_token)
+    _config = _config.clone_with(bearer_token_credentials: bearer_token_credentials)
+    @client = Client.new(config: _config)
+  end
+end