data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/search_statement_of_account_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
+  # SearchStatementOfAccountResponse Model.
+  class SearchStatementOfAccountResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Mandatory UUID (according to RFC 4122 standards) for requests and
+    # responses. This will be played back in the response from the req
+    # @return [String]
+    attr_accessor :request_id
+
+    # Indicates overall status of the request
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates overall status of the request
+    # @return [Array[SearchStatementOfAccount]]
+    attr_accessor :data
+
+    # Current page
+    # @return [Integer]
+    attr_accessor :page
+
+    # Total Number of records in response
+    # @return [Integer]
+    attr_accessor :total_records
+
+    # Total number of pages available for the requested data
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # Number of records returned in the response
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # 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['page'] = 'Page'
+      @_hash['total_records'] = 'TotalRecords'
+      @_hash['total_pages'] = 'TotalPages'
+      @_hash['page_size'] = 'PageSize'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        data
+        page
+        total_records
+        total_pages
+        page_size
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   status = SKIP,
+                   data = SKIP,
+                   page = SKIP,
+                   total_records = SKIP,
+                   total_pages = SKIP,
+                   page_size = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @data = data unless data == SKIP
+      @page = page unless page == SKIP
+      @total_records = total_records unless total_records == SKIP
+      @total_pages = total_pages unless total_pages == 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.
+      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 << (SearchStatementOfAccount.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+      page = hash.key?('Page') ? hash['Page'] : SKIP
+      total_records = hash.key?('TotalRecords') ? hash['TotalRecords'] : SKIP
+      total_pages = hash.key?('TotalPages') ? hash['TotalPages'] : SKIP
+      page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
+
+      # Create object from extracted values.
+      SearchStatementOfAccountResponse.new(request_id,
+                                           status,
+                                           data,
+                                           page,
+                                           total_records,
+                                           total_pages,
+                                           page_size)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/site_location.rb

@@ -0,0 +1,67 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Geography Location entity for Site Location
+  class SiteLocation < 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.
+      SiteLocation.new(latitude,
+                       longitude)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/statement_of_account_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
+  # StatementOfAccountRequest Model.
+  class StatementOfAccountRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [StatementOfAccountRequestFilters]
+    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 = StatementOfAccountRequestFilters.from_hash(hash['Filters']) if hash['Filters']
+
+      # Create object from extracted values.
+      StatementOfAccountRequest.new(filters)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/statement_of_account_request_filters.rb

@@ -0,0 +1,197 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # StatementOfAccountRequestFilters Model.
+  class StatementOfAccountRequestFilters < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting Company Code (Shell Code) of the selected payer. 
+    # Optional If ColCo Id is passed else Mandatory.
+    # @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
+
+    # True/False.
+    # Optional. Default is False.
+    # True if the past 13 monthly invoice trend to be included as part of the
+    # response. Else false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_monthly_invoice_trend
+
+    # True/False.
+    # Optional. Default is False.
+    # True if the past X SOA documents are to be included as part of the
+    # response. Else false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_past_statement_of_accounts
+
+    # True/False
+    # Optional Default is False.
+    # If true PastStatementOfAccounts entity on this API output should contain
+    # the SOA documents that are due or overdue only.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :due_or_over_due_soa_documents_only
+
+    # This parameter is only applicable when “IncludePastStatementOfAccounts”
+    # parameter is set to True.
+    # @return [Integer]
+    attr_accessor :number_of_soa_documents
+
+    # True/False
+    # Optional.
+    # Default value is false.
+    # When true InvoicesSummaries list will be returned in the API output.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_account_invoices_summary
+
+    # Collecting Company Id of the selected payer. 
+    # Optional If ColCo Code is passed else Mandatory.
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # Collecting Company Id of the selected payer. 
+    # Optional If ColCo Code is passed else Mandatory.
+    # @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['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['include_monthly_invoice_trend'] = 'IncludeMonthlyInvoiceTrend'
+      @_hash['include_past_statement_of_accounts'] =
+        'IncludePastStatementOfAccounts'
+      @_hash['due_or_over_due_soa_documents_only'] =
+        'DueOrOverDueSOADocumentsOnly'
+      @_hash['number_of_soa_documents'] = 'NumberOfSOADocuments'
+      @_hash['include_account_invoices_summary'] =
+        'IncludeAccountInvoicesSummary'
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['accounts'] = 'Accounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_code
+        payer_id
+        payer_number
+        include_monthly_invoice_trend
+        include_past_statement_of_accounts
+        due_or_over_due_soa_documents_only
+        number_of_soa_documents
+        include_account_invoices_summary
+        col_co_id
+        accounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_code
+        payer_id
+        payer_number
+        include_monthly_invoice_trend
+        include_past_statement_of_accounts
+        due_or_over_due_soa_documents_only
+        number_of_soa_documents
+        include_account_invoices_summary
+        col_co_id
+      ]
+    end
+
+    def initialize(col_co_code = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   include_monthly_invoice_trend = SKIP,
+                   include_past_statement_of_accounts = SKIP,
+                   due_or_over_due_soa_documents_only = SKIP,
+                   number_of_soa_documents = SKIP,
+                   include_account_invoices_summary = SKIP,
+                   col_co_id = SKIP,
+                   accounts = 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
+      unless include_monthly_invoice_trend == SKIP
+        @include_monthly_invoice_trend =
+          include_monthly_invoice_trend
+      end
+      unless include_past_statement_of_accounts == SKIP
+        @include_past_statement_of_accounts =
+          include_past_statement_of_accounts
+      end
+      unless due_or_over_due_soa_documents_only == SKIP
+        @due_or_over_due_soa_documents_only =
+          due_or_over_due_soa_documents_only
+      end
+      @number_of_soa_documents = number_of_soa_documents unless number_of_soa_documents == SKIP
+      unless include_account_invoices_summary == SKIP
+        @include_account_invoices_summary =
+          include_account_invoices_summary
+      end
+      @col_co_id = col_co_id unless col_co_id == 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
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      include_monthly_invoice_trend =
+        hash.key?('IncludeMonthlyInvoiceTrend') ? hash['IncludeMonthlyInvoiceTrend'] : SKIP
+      include_past_statement_of_accounts =
+        hash.key?('IncludePastStatementOfAccounts') ? hash['IncludePastStatementOfAccounts'] : SKIP
+      due_or_over_due_soa_documents_only =
+        hash.key?('DueOrOverDueSOADocumentsOnly') ? hash['DueOrOverDueSOADocumentsOnly'] : SKIP
+      number_of_soa_documents =
+        hash.key?('NumberOfSOADocuments') ? hash['NumberOfSOADocuments'] : SKIP
+      include_account_invoices_summary =
+        hash.key?('IncludeAccountInvoicesSummary') ? hash['IncludeAccountInvoicesSummary'] : SKIP
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : 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.
+      StatementOfAccountRequestFilters.new(col_co_code,
+                                           payer_id,
+                                           payer_number,
+                                           include_monthly_invoice_trend,
+                                           include_past_statement_of_accounts,
+                                           due_or_over_due_soa_documents_only,
+                                           number_of_soa_documents,
+                                           include_account_invoices_summary,
+                                           col_co_id,
+                                           accounts)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/statement_of_account_resp.rb

@@ -0,0 +1,138 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # StatementOfAccountResp Model.
+  class StatementOfAccountResp < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Latest statement of the account generated for the given Payer.
+    # @return [LastStatementOfAccount]
+    attr_accessor :last_statement_of_account
+
+    # Latest statement of the account generated for the given Payer.
+    # @return [Array[MonthlyInvoiceTrend]]
+    attr_accessor :monthly_invoice_trend
+
+    # Latest statement of the account generated for the given Payer.
+    # @return [Array[PastStatementOfAccounts]]
+    attr_accessor :past_statement_of_accounts
+
+    # Latest statement of the account generated for the given Payer.
+    # @return [Array[PaymentsSinceLastSOA]]
+    attr_accessor :payments_since_last_soa
+
+    # Latest statement of the account generated for the given Payer.
+    # @return [Array[InvoicesSummaries]]
+    attr_accessor :invoices_summaries
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['last_statement_of_account'] = 'LastStatementOfAccount'
+      @_hash['monthly_invoice_trend'] = 'MonthlyInvoiceTrend'
+      @_hash['past_statement_of_accounts'] = 'PastStatementOfAccounts'
+      @_hash['payments_since_last_soa'] = 'PaymentsSinceLastSOA'
+      @_hash['invoices_summaries'] = 'InvoicesSummaries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        last_statement_of_account
+        monthly_invoice_trend
+        past_statement_of_accounts
+        payments_since_last_soa
+        invoices_summaries
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        monthly_invoice_trend
+        payments_since_last_soa
+        invoices_summaries
+      ]
+    end
+
+    def initialize(last_statement_of_account = SKIP,
+                   monthly_invoice_trend = SKIP,
+                   past_statement_of_accounts = SKIP,
+                   payments_since_last_soa = SKIP,
+                   invoices_summaries = SKIP)
+      unless last_statement_of_account == SKIP
+        @last_statement_of_account =
+          last_statement_of_account
+      end
+      @monthly_invoice_trend = monthly_invoice_trend unless monthly_invoice_trend == SKIP
+      unless past_statement_of_accounts == SKIP
+        @past_statement_of_accounts =
+          past_statement_of_accounts
+      end
+      @payments_since_last_soa = payments_since_last_soa unless payments_since_last_soa == SKIP
+      @invoices_summaries = invoices_summaries unless invoices_summaries == 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.
+      if hash['LastStatementOfAccount']
+        last_statement_of_account = LastStatementOfAccount.from_hash(hash['LastStatementOfAccount'])
+      end
+      # Parameter is an array, so we need to iterate through it
+      monthly_invoice_trend = nil
+      unless hash['MonthlyInvoiceTrend'].nil?
+        monthly_invoice_trend = []
+        hash['MonthlyInvoiceTrend'].each do |structure|
+          monthly_invoice_trend << (MonthlyInvoiceTrend.from_hash(structure) if structure)
+        end
+      end
+
+      monthly_invoice_trend = SKIP unless hash.key?('MonthlyInvoiceTrend')
+      # Parameter is an array, so we need to iterate through it
+      past_statement_of_accounts = nil
+      unless hash['PastStatementOfAccounts'].nil?
+        past_statement_of_accounts = []
+        hash['PastStatementOfAccounts'].each do |structure|
+          past_statement_of_accounts << (PastStatementOfAccounts.from_hash(structure) if structure)
+        end
+      end
+
+      past_statement_of_accounts = SKIP unless hash.key?('PastStatementOfAccounts')
+      # Parameter is an array, so we need to iterate through it
+      payments_since_last_soa = nil
+      unless hash['PaymentsSinceLastSOA'].nil?
+        payments_since_last_soa = []
+        hash['PaymentsSinceLastSOA'].each do |structure|
+          payments_since_last_soa << (PaymentsSinceLastSOA.from_hash(structure) if structure)
+        end
+      end
+
+      payments_since_last_soa = SKIP unless hash.key?('PaymentsSinceLastSOA')
+      # Parameter is an array, so we need to iterate through it
+      invoices_summaries = nil
+      unless hash['InvoicesSummaries'].nil?
+        invoices_summaries = []
+        hash['InvoicesSummaries'].each do |structure|
+          invoices_summaries << (InvoicesSummaries.from_hash(structure) if structure)
+        end
+      end
+
+      invoices_summaries = SKIP unless hash.key?('InvoicesSummaries')
+
+      # Create object from extracted values.
+      StatementOfAccountResp.new(last_statement_of_account,
+                                 monthly_invoice_trend,
+                                 past_statement_of_accounts,
+                                 payments_since_last_soa,
+                                 invoices_summaries)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/statement_of_account_response.rb

@@ -0,0 +1,80 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # StatementOfAccountResponse Model.
+  class StatementOfAccountResponse < 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[StatementOfAccountResp]]
+    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 << (StatementOfAccountResp.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+
+      # Create object from extracted values.
+      StatementOfAccountResponse.new(request_id,
+                                     status,
+                                     data)
+    end
+  end
+end