data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/payer_request.rb

@@ -0,0 +1,126 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # PayerRequest Model.
+  class PayerRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of Payer entity.
+    # Optional.
+    # Note:
+    # •	Max number of payers allowed in the input is 10, if it exceeds in the
+    # input it will throw an error.
+    # •	This value is configurable. Initial configuration will be 1000 and will
+    # change to 10 once SFH changes are integrated.
+    # @return [Array[Payers]]
+    attr_accessor :payers
+
+    # Returns only the high-level basic details of payers. Set this field to
+    # ‘true’ when only the basic details are required to get the result quicker.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :return_basic_details_only
+
+    # Include address related fields on the response. Set this field to ‘False’
+    # when Address fields are not required to get the result quicker.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_addresses
+
+    # Include the Finance Currency, used for Finance Widget, in the response
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_bonus_parameters
+
+    # Page Number
+    # @return [Integer]
+    attr_accessor :current_page
+
+    # Page Size – Number of records to show on a page
+    # Default value 50
+    # Return 250 rows only in the response if -1 is supplied as page size.
+    # Note: 
+    # •	Max page size is 250, if the user provided value is more than 250 then
+    # it will throw error.
+    # •	This value is configurable.
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payers'] = 'Payers'
+      @_hash['return_basic_details_only'] = 'ReturnBasicDetailsOnly'
+      @_hash['include_addresses'] = 'IncludeAddresses'
+      @_hash['include_bonus_parameters'] = 'IncludeBonusParameters'
+      @_hash['current_page'] = 'CurrentPage'
+      @_hash['page_size'] = 'PageSize'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payers
+        return_basic_details_only
+        include_addresses
+        include_bonus_parameters
+        current_page
+        page_size
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payers = SKIP,
+                   return_basic_details_only = false,
+                   include_addresses = false,
+                   include_bonus_parameters = false,
+                   current_page = SKIP,
+                   page_size = SKIP)
+      @payers = payers unless payers == SKIP
+      unless return_basic_details_only == SKIP
+        @return_basic_details_only =
+          return_basic_details_only
+      end
+      @include_addresses = include_addresses unless include_addresses == SKIP
+      @include_bonus_parameters = include_bonus_parameters unless include_bonus_parameters == 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.
+      # Parameter is an array, so we need to iterate through it
+      payers = nil
+      unless hash['Payers'].nil?
+        payers = []
+        hash['Payers'].each do |structure|
+          payers << (Payers.from_hash(structure) if structure)
+        end
+      end
+
+      payers = SKIP unless hash.key?('Payers')
+      return_basic_details_only = hash['ReturnBasicDetailsOnly'] ||= false
+      include_addresses = hash['IncludeAddresses'] ||= false
+      include_bonus_parameters = hash['IncludeBonusParameters'] ||= false
+      current_page = hash.key?('CurrentPage') ? hash['CurrentPage'] : SKIP
+      page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
+
+      # Create object from extracted values.
+      PayerRequest.new(payers,
+                       return_basic_details_only,
+                       include_addresses,
+                       include_bonus_parameters,
+                       current_page,
+                       page_size)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/payer_response.rb

@@ -0,0 +1,115 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # PayerResponse Model.
+  class PayerResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Request Id of the API call
+    # @return [String]
+    attr_accessor :request_id
+
+    # Request Id of the API call
+    # @return [Array[PayerDetails]]
+    attr_accessor :payers
+
+    # Current Page
+    # @return [Integer]
+    attr_accessor :current_page
+
+    # Total row count matched for the given input criteria
+    # @return [Integer]
+    attr_accessor :row_count
+
+    # Calculated page count based on page size from the incoming API request and
+    # total number of rows matched for the given input criteria. Return 1 if the
+    # page size is -1 as all records are returned
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # Calculated page count based on page size from the incoming API request and
+    # total number of rows matched for the given input criteria. Return 1 if the
+    # page size is -1 as all records are returned
+    # @return [ErrorStatus]
+    attr_accessor :error
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'RequestId'
+      @_hash['payers'] = 'Payers'
+      @_hash['current_page'] = 'CurrentPage'
+      @_hash['row_count'] = 'RowCount'
+      @_hash['total_pages'] = 'TotalPages'
+      @_hash['error'] = 'Error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        payers
+        current_page
+        row_count
+        total_pages
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        request_id
+      ]
+    end
+
+    def initialize(request_id = SKIP,
+                   payers = SKIP,
+                   current_page = SKIP,
+                   row_count = SKIP,
+                   total_pages = SKIP,
+                   error = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @payers = payers unless payers == 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
+    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
+      # Parameter is an array, so we need to iterate through it
+      payers = nil
+      unless hash['Payers'].nil?
+        payers = []
+        hash['Payers'].each do |structure|
+          payers << (PayerDetails.from_hash(structure) if structure)
+        end
+      end
+
+      payers = SKIP unless hash.key?('Payers')
+      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']
+
+      # Create object from extracted values.
+      PayerResponse.new(request_id,
+                        payers,
+                        current_page,
+                        row_count,
+                        total_pages,
+                        error)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/payers.rb

@@ -0,0 +1,109 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Payers Model.
+  class Payers < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting Company Id of the payer
+    # @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.
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Payer id of the customer.
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number of the customer.
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Payer Name of the customer.
+    # @return [String]
+    attr_accessor :payer_name
+
+    # Payer Group identifier of the customer
+    # @return [Integer]
+    attr_accessor :payer_group_id
+
+    # 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['payer_name'] = 'PayerName'
+      @_hash['payer_group_id'] = 'PayerGroupId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        payer_name
+        payer_group_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        payer_name
+        payer_group_id
+      ]
+    end
+
+    def initialize(col_co_id = SKIP,
+                   col_co_code = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   payer_name = SKIP,
+                   payer_group_id = 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
+      @payer_name = payer_name unless payer_name == SKIP
+      @payer_group_id = payer_group_id unless payer_group_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.
+      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
+      payer_name = hash.key?('PayerName') ? hash['PayerName'] : SKIP
+      payer_group_id = hash.key?('PayerGroupId') ? hash['PayerGroupId'] : SKIP
+
+      # Create object from extracted values.
+      Payers.new(col_co_id,
+                 col_co_code,
+                 payer_id,
+                 payer_number,
+                 payer_name,
+                 payer_group_id)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/payments_since_last_soa.rb

@@ -0,0 +1,322 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # List of payments made by the customer after the latest Statement of Account.
+  # Note: All the payments made by the customer will be returned when there is
+  # no Statement of Account available for customer.
+  class PaymentsSinceLastSOA < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account Identifier for which payment is made. 
+    # Example: 12345
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account number for which payment is made. 
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :account_number
+
+    # Account Short Name
+    # Example: GB Earth Movers-SN
+    # @return [String]
+    attr_accessor :account_short_name
+
+    # Summary billing document reference id.
+    # Example: 2
+    # @return [Integer]
+    attr_accessor :summary_document_id
+
+    # Summary billing document reference number.
+    # @return [String]
+    attr_accessor :summary_document_number
+
+    # Summary billing document date. 
+    # Format: YYYYMMDD
+    # @return [String]
+    attr_accessor :summary_document_date
+
+    # Payment due date of the Summary billing document. 
+    # Format: YYYYMMDD
+    # @return [String]
+    attr_accessor :summary_document_payment_due_date
+
+    # Total value in the Summary billing document.
+    # @return [Float]
+    attr_accessor :summary_document_total_value
+
+    # Total VAT in the Summary billing document.
+    # @return [Float]
+    attr_accessor :summary_document_total_vat
+
+    # Total DD amount in the Summary billing document.
+    # @return [Float]
+    attr_accessor :summary_document_dd_amount
+
+    # Date of payment.
+    # Format: YYYYMMDD
+    # @return [String]
+    attr_accessor :payment_date
+
+    # Reference text of the payment.
+    # @return [String]
+    attr_accessor :payment_reference
+
+    # ISO code of payment currency. 
+    # Example: EUR
+    # @return [String]
+    attr_accessor :payment_currency_code
+
+    # Symbol of payment currency. 
+    # Example: €
+    # @return [String]
+    attr_accessor :payment_currency_symbol
+
+    # Amount paid.
+    # @return [Float]
+    attr_accessor :amount_paid
+
+    # Balance amount to be settled for the Summary document.
+    # @return [Float]
+    attr_accessor :balance
+
+    # True Payment.
+    # @return [String]
+    attr_accessor :true_payment
+
+    # Balance in the pre-paid amount.
+    # @return [Float]
+    attr_accessor :prepaid_balance
+
+    # Currency ISO code of the local country. It is derived based on CountryCode
+    # from microservice configuration. This field is expected to have different
+    # value than the previously mentioned field CurrencyCode, only in the case
+    # of serviced OUs.
+    # Example: EUR
+    # @return [String]
+    attr_accessor :local_currency_code
+
+    # Currency Symbol of the local country. It is derived based on CountryCode
+    # from microservice configuration. This field is expected to have different
+    # value than the previously mentioned field CurrencySymbol, only in the case
+    # of serviced OUs.
+    # Example: €
+    # @return [String]
+    attr_accessor :local_currency_symbol
+
+    # Exchange rate from Payment currency to local currency.
+    # @return [String]
+    attr_accessor :local_currency_exchange_rate
+
+    # 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['summary_document_id'] = 'SummaryDocumentId'
+      @_hash['summary_document_number'] = 'SummaryDocumentNumber'
+      @_hash['summary_document_date'] = 'SummaryDocumentDate'
+      @_hash['summary_document_payment_due_date'] =
+        'SummaryDocumentPaymentDueDate'
+      @_hash['summary_document_total_value'] = 'SummaryDocumentTotalValue'
+      @_hash['summary_document_total_vat'] = 'SummaryDocumentTotalVAT'
+      @_hash['summary_document_dd_amount'] = 'SummaryDocumentDDAmount'
+      @_hash['payment_date'] = 'PaymentDate'
+      @_hash['payment_reference'] = 'PaymentReference'
+      @_hash['payment_currency_code'] = 'PaymentCurrencyCode'
+      @_hash['payment_currency_symbol'] = 'PaymentCurrencySymbol'
+      @_hash['amount_paid'] = 'AmountPaid'
+      @_hash['balance'] = 'Balance'
+      @_hash['true_payment'] = 'TruePayment'
+      @_hash['prepaid_balance'] = 'PrepaidBalance'
+      @_hash['local_currency_code'] = 'LocalCurrencyCode'
+      @_hash['local_currency_symbol'] = 'LocalCurrencySymbol'
+      @_hash['local_currency_exchange_rate'] = 'LocalCurrencyExchangeRate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        account_number
+        account_short_name
+        summary_document_id
+        summary_document_number
+        summary_document_date
+        summary_document_payment_due_date
+        summary_document_total_value
+        summary_document_total_vat
+        summary_document_dd_amount
+        payment_date
+        payment_reference
+        payment_currency_code
+        payment_currency_symbol
+        amount_paid
+        balance
+        true_payment
+        prepaid_balance
+        local_currency_code
+        local_currency_symbol
+        local_currency_exchange_rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_id
+        account_number
+        account_short_name
+        summary_document_id
+        summary_document_number
+        summary_document_date
+        summary_document_payment_due_date
+        summary_document_total_value
+        summary_document_total_vat
+        summary_document_dd_amount
+        payment_date
+        payment_reference
+        payment_currency_code
+        payment_currency_symbol
+        amount_paid
+        balance
+        true_payment
+        prepaid_balance
+        local_currency_code
+        local_currency_symbol
+        local_currency_exchange_rate
+      ]
+    end
+
+    def initialize(account_id = SKIP,
+                   account_number = SKIP,
+                   account_short_name = SKIP,
+                   summary_document_id = SKIP,
+                   summary_document_number = SKIP,
+                   summary_document_date = SKIP,
+                   summary_document_payment_due_date = SKIP,
+                   summary_document_total_value = SKIP,
+                   summary_document_total_vat = SKIP,
+                   summary_document_dd_amount = SKIP,
+                   payment_date = SKIP,
+                   payment_reference = SKIP,
+                   payment_currency_code = SKIP,
+                   payment_currency_symbol = SKIP,
+                   amount_paid = SKIP,
+                   balance = SKIP,
+                   true_payment = SKIP,
+                   prepaid_balance = SKIP,
+                   local_currency_code = SKIP,
+                   local_currency_symbol = SKIP,
+                   local_currency_exchange_rate = 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
+      @summary_document_id = summary_document_id unless summary_document_id == SKIP
+      @summary_document_number = summary_document_number unless summary_document_number == SKIP
+      @summary_document_date = summary_document_date unless summary_document_date == SKIP
+      unless summary_document_payment_due_date == SKIP
+        @summary_document_payment_due_date =
+          summary_document_payment_due_date
+      end
+      unless summary_document_total_value == SKIP
+        @summary_document_total_value =
+          summary_document_total_value
+      end
+      unless summary_document_total_vat == SKIP
+        @summary_document_total_vat =
+          summary_document_total_vat
+      end
+      unless summary_document_dd_amount == SKIP
+        @summary_document_dd_amount =
+          summary_document_dd_amount
+      end
+      @payment_date = payment_date unless payment_date == SKIP
+      @payment_reference = payment_reference unless payment_reference == SKIP
+      @payment_currency_code = payment_currency_code unless payment_currency_code == SKIP
+      @payment_currency_symbol = payment_currency_symbol unless payment_currency_symbol == SKIP
+      @amount_paid = amount_paid unless amount_paid == SKIP
+      @balance = balance unless balance == SKIP
+      @true_payment = true_payment unless true_payment == SKIP
+      @prepaid_balance = prepaid_balance unless prepaid_balance == SKIP
+      @local_currency_code = local_currency_code unless local_currency_code == SKIP
+      @local_currency_symbol = local_currency_symbol unless local_currency_symbol == SKIP
+      unless local_currency_exchange_rate == SKIP
+        @local_currency_exchange_rate =
+          local_currency_exchange_rate
+      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.
+      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
+      summary_document_id =
+        hash.key?('SummaryDocumentId') ? hash['SummaryDocumentId'] : SKIP
+      summary_document_number =
+        hash.key?('SummaryDocumentNumber') ? hash['SummaryDocumentNumber'] : SKIP
+      summary_document_date =
+        hash.key?('SummaryDocumentDate') ? hash['SummaryDocumentDate'] : SKIP
+      summary_document_payment_due_date =
+        hash.key?('SummaryDocumentPaymentDueDate') ? hash['SummaryDocumentPaymentDueDate'] : SKIP
+      summary_document_total_value =
+        hash.key?('SummaryDocumentTotalValue') ? hash['SummaryDocumentTotalValue'] : SKIP
+      summary_document_total_vat =
+        hash.key?('SummaryDocumentTotalVAT') ? hash['SummaryDocumentTotalVAT'] : SKIP
+      summary_document_dd_amount =
+        hash.key?('SummaryDocumentDDAmount') ? hash['SummaryDocumentDDAmount'] : SKIP
+      payment_date = hash.key?('PaymentDate') ? hash['PaymentDate'] : SKIP
+      payment_reference =
+        hash.key?('PaymentReference') ? hash['PaymentReference'] : SKIP
+      payment_currency_code =
+        hash.key?('PaymentCurrencyCode') ? hash['PaymentCurrencyCode'] : SKIP
+      payment_currency_symbol =
+        hash.key?('PaymentCurrencySymbol') ? hash['PaymentCurrencySymbol'] : SKIP
+      amount_paid = hash.key?('AmountPaid') ? hash['AmountPaid'] : SKIP
+      balance = hash.key?('Balance') ? hash['Balance'] : SKIP
+      true_payment = hash.key?('TruePayment') ? hash['TruePayment'] : SKIP
+      prepaid_balance =
+        hash.key?('PrepaidBalance') ? hash['PrepaidBalance'] : SKIP
+      local_currency_code =
+        hash.key?('LocalCurrencyCode') ? hash['LocalCurrencyCode'] : SKIP
+      local_currency_symbol =
+        hash.key?('LocalCurrencySymbol') ? hash['LocalCurrencySymbol'] : SKIP
+      local_currency_exchange_rate =
+        hash.key?('LocalCurrencyExchangeRate') ? hash['LocalCurrencyExchangeRate'] : SKIP
+
+      # Create object from extracted values.
+      PaymentsSinceLastSOA.new(account_id,
+                               account_number,
+                               account_short_name,
+                               summary_document_id,
+                               summary_document_number,
+                               summary_document_date,
+                               summary_document_payment_due_date,
+                               summary_document_total_value,
+                               summary_document_total_vat,
+                               summary_document_dd_amount,
+                               payment_date,
+                               payment_reference,
+                               payment_currency_code,
+                               payment_currency_symbol,
+                               amount_paid,
+                               balance,
+                               true_payment,
+                               prepaid_balance,
+                               local_currency_code,
+                               local_currency_symbol,
+                               local_currency_exchange_rate)
+    end
+  end
+end