data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/search_documents_request.rb

@@ -0,0 +1,70 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # SearchDocumentsRequest Model.
+  class SearchDocumentsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [SearchDocReq]
+    attr_accessor :filters
+
+    # Specify the page of results to be returned.
+    # @return [String]
+    attr_accessor :page
+
+    # Specify the number of records to returned; Max 1000
+    # @return [String]
+    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 = SearchDocReq.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.
+      SearchDocumentsRequest.new(filters,
+                                 page,
+                                 page_size)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/search_documents_response.rb

@@ -0,0 +1,122 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # SearchDocumentsResponse Model.
+  class SearchDocumentsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # UUID (according to RFC 4122 standards) for requests and responses. This
+    # will be played back in the response from the request.
+    # @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[SearchDocumentsInvoice]]
+    attr_accessor :data
+
+    # Total number of elements corresponding to the request
+    # @return [Integer]
+    attr_accessor :total_records
+
+    # Number of elements in the page content. Will be lesser or equal to the
+    # size param.
+    # @return [Integer]
+    attr_accessor :total_records_on_page
+
+    # True if it is the first page, false otherwise
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_first_page
+
+    # True if it is the last page, false, otherwise.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_last_page
+
+    # 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['total_records'] = 'TotalRecords'
+      @_hash['total_records_on_page'] = 'TotalRecordsOnPage'
+      @_hash['is_first_page'] = 'IsFirstPage'
+      @_hash['is_last_page'] = 'IsLastPage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        data
+        total_records
+        total_records_on_page
+        is_first_page
+        is_last_page
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   status = SKIP,
+                   data = SKIP,
+                   total_records = SKIP,
+                   total_records_on_page = SKIP,
+                   is_first_page = SKIP,
+                   is_last_page = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @data = data unless data == SKIP
+      @total_records = total_records unless total_records == SKIP
+      @total_records_on_page = total_records_on_page unless total_records_on_page == SKIP
+      @is_first_page = is_first_page unless is_first_page == SKIP
+      @is_last_page = is_last_page unless is_last_page == 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 << (SearchDocumentsInvoice.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+      total_records = hash.key?('TotalRecords') ? hash['TotalRecords'] : SKIP
+      total_records_on_page =
+        hash.key?('TotalRecordsOnPage') ? hash['TotalRecordsOnPage'] : SKIP
+      is_first_page = hash.key?('IsFirstPage') ? hash['IsFirstPage'] : SKIP
+      is_last_page = hash.key?('IsLastPage') ? hash['IsLastPage'] : SKIP
+
+      # Create object from extracted values.
+      SearchDocumentsResponse.new(request_id,
+                                  status,
+                                  data,
+                                  total_records,
+                                  total_records_on_page,
+                                  is_first_page,
+                                  is_last_page)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/search_soa_req.rb

@@ -0,0 +1,197 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # SearchSOAReq Model.
+  class SearchSOAReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting Company Code of the selected payer.
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Payer Number of the selected payer.
+    # Optional if PayerId is passed else Mandatory.
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Invoice number.
+    # Optional.
+    # This input is a search criterion, if given.
+    # @return [String]
+    attr_accessor :invoice_number
+
+    # SOA searched from this date.
+    # Optional.
+    # This input is a search criterion, if given.
+    # Date format: yyyy/MM/dd
+    # @return [String]
+    attr_accessor :from_date
+
+    # Invoice date searched until this date.
+    # Optional.
+    # This input is a search criterion, if given.
+    # @return [String]
+    attr_accessor :to_date
+
+    # Invoice date search period. Valid values -
+    # Last 7 days – Issued in last 7 days.
+    # Last 30 days – Issued in last 30 days.
+    # Last 90 days – Issued in last 90 days.
+    # Optional.
+    # This input is a search criterion, if given.
+    # @return [Integer]
+    attr_accessor :period
+
+    # Date of invoicing.
+    # Optional.
+    # This input is a search criterion, if given.
+    # @return [String]
+    attr_accessor :invoice_date
+
+    # Possible options are:
+    # 1.    StatementDate ASC
+    # 2.    StatementDate DESC
+    # Optional
+    # Note:
+    # This option uses a column name with a combination of “ASC or DESC” for
+    # sorting.
+    # If only the column name is provided, it is sorted by ascending. 
+    # Sorting is allowed only ASC or DESC, If both provided in the input ASC
+    # will be taken as precedence.
+    # @return [Array[String]]
+    attr_accessor :invoice_status
+
+    # Possible options are:
+    # 1.    StatementDate ASC
+    # 2.    StatementDate DESC
+    # Optional
+    # Note:
+    # This option uses a column name with a combination of “ASC or DESC” for
+    # sorting.
+    # If only the column name is provided, it is sorted by ascending. 
+    # Sorting is allowed only ASC or DESC, If both provided in the input ASC
+    # will be taken as precedence.
+    # @return [Array[Integer]]
+    attr_accessor :sort_by
+
+    # 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.
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['invoice_number'] = 'InvoiceNumber'
+      @_hash['from_date'] = 'FromDate'
+      @_hash['to_date'] = 'ToDate'
+      @_hash['period'] = 'Period'
+      @_hash['invoice_date'] = 'InvoiceDate'
+      @_hash['invoice_status'] = 'InvoiceStatus'
+      @_hash['sort_by'] = 'SortBy'
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_code
+        payer_number
+        invoice_number
+        from_date
+        to_date
+        period
+        invoice_date
+        invoice_status
+        sort_by
+        col_co_id
+        payer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_code
+        payer_number
+        invoice_number
+        from_date
+        to_date
+        period
+        invoice_date
+        col_co_id
+        payer_id
+      ]
+    end
+
+    def initialize(col_co_code = SKIP,
+                   payer_number = SKIP,
+                   invoice_number = SKIP,
+                   from_date = SKIP,
+                   to_date = SKIP,
+                   period = SKIP,
+                   invoice_date = SKIP,
+                   invoice_status = SKIP,
+                   sort_by = SKIP,
+                   col_co_id = SKIP,
+                   payer_id = SKIP)
+      @col_co_code = col_co_code unless col_co_code == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @invoice_number = invoice_number unless invoice_number == SKIP
+      @from_date = from_date unless from_date == SKIP
+      @to_date = to_date unless to_date == SKIP
+      @period = period unless period == SKIP
+      @invoice_date = invoice_date unless invoice_date == SKIP
+      @invoice_status = invoice_status unless invoice_status == SKIP
+      @sort_by = sort_by unless sort_by == SKIP
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @payer_id = payer_id unless payer_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_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      invoice_number = hash.key?('InvoiceNumber') ? hash['InvoiceNumber'] : SKIP
+      from_date = hash.key?('FromDate') ? hash['FromDate'] : SKIP
+      to_date = hash.key?('ToDate') ? hash['ToDate'] : SKIP
+      period = hash.key?('Period') ? hash['Period'] : SKIP
+      invoice_date = hash.key?('InvoiceDate') ? hash['InvoiceDate'] : SKIP
+      invoice_status = hash.key?('InvoiceStatus') ? hash['InvoiceStatus'] : SKIP
+      sort_by = hash.key?('SortBy') ? hash['SortBy'] : SKIP
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+
+      # Create object from extracted values.
+      SearchSOAReq.new(col_co_code,
+                       payer_number,
+                       invoice_number,
+                       from_date,
+                       to_date,
+                       period,
+                       invoice_date,
+                       invoice_status,
+                       sort_by,
+                       col_co_id,
+                       payer_id)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/search_statement_of_account.rb

@@ -0,0 +1,220 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # SearchStatementOfAccount Model.
+  class SearchStatementOfAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Statement of account identifier
+    # @return [Integer]
+    attr_accessor :statement_of_account_id
+
+    # Statement of account reference
+    # @return [String]
+    attr_accessor :so_a_reference_number
+
+    # Date on which the SOA was generated.
+    # Format: yyyyMMdd
+    # @return [String]
+    attr_accessor :statement_date
+
+    # Payment customer id of the customer.
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payment customer number.
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Invoiced amount and due for payment
+    # @return [Float]
+    attr_accessor :amount_due
+
+    # Invoiced amount and overdue for payment.
+    # @return [Float]
+    attr_accessor :amount_overdue
+
+    # ISO code of SOA currency.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # Symbol of SOA currency. 
+    # Example: €
+    # @return [String]
+    attr_accessor :currency_symbol
+
+    # Due date for payment. Format: yyyyMMdd
+    # Note: 
+    # •	Clients to convert this to appropriate DateTime type.
+    # •	SoA due date is considered as the latest due date of the invoices within
+    # the SoA
+    # @return [String]
+    attr_accessor :due_date
+
+    # ISO code of the country i.e., UK, DE, MY, etc.
+    # This is the value of the first invoice within the SoA. It may not be same
+    # for all the invoices within the SoA.
+    # @return [String]
+    attr_accessor :invoiced_on_behalf_of
+
+    # Status of the document. Valid values –
+    # 1.	Paid – Fully paid all Invoices with in the SOA.
+    # 2.	Overdue – At least one invoice payment due date is less than current
+    # date with in the SOA.
+    # 3.	Due – At least one invoice is due for payment and is within the due
+    # date. There is no invoice overdue for payment.
+    # @return [String]
+    attr_accessor :status
+
+    # Total gross amount in customer currency.
+    # @return [Float]
+    attr_accessor :gross_amount_customer_currency
+
+    # Document reference number fetched
+    # @return [String]
+    attr_accessor :document_reference_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['statement_of_account_id'] = 'StatementOfAccountId'
+      @_hash['so_a_reference_number'] = 'SoAReferenceNumber'
+      @_hash['statement_date'] = 'StatementDate'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['amount_due'] = 'AmountDue'
+      @_hash['amount_overdue'] = 'AmountOverdue'
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['currency_symbol'] = 'CurrencySymbol'
+      @_hash['due_date'] = 'DueDate'
+      @_hash['invoiced_on_behalf_of'] = 'InvoicedOnBehalfOf'
+      @_hash['status'] = 'Status'
+      @_hash['gross_amount_customer_currency'] = 'GrossAmountCustomerCurrency'
+      @_hash['document_reference_number'] = 'DocumentReferenceNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        statement_of_account_id
+        so_a_reference_number
+        statement_date
+        payer_id
+        payer_number
+        amount_due
+        amount_overdue
+        currency_code
+        currency_symbol
+        due_date
+        invoiced_on_behalf_of
+        status
+        gross_amount_customer_currency
+        document_reference_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        statement_of_account_id
+        so_a_reference_number
+        statement_date
+        payer_id
+        payer_number
+        amount_due
+        amount_overdue
+        currency_code
+        currency_symbol
+        due_date
+        invoiced_on_behalf_of
+        status
+        gross_amount_customer_currency
+        document_reference_number
+      ]
+    end
+
+    def initialize(statement_of_account_id = SKIP,
+                   so_a_reference_number = SKIP,
+                   statement_date = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   amount_due = SKIP,
+                   amount_overdue = SKIP,
+                   currency_code = SKIP,
+                   currency_symbol = SKIP,
+                   due_date = SKIP,
+                   invoiced_on_behalf_of = SKIP,
+                   status = SKIP,
+                   gross_amount_customer_currency = SKIP,
+                   document_reference_number = SKIP)
+      @statement_of_account_id = statement_of_account_id unless statement_of_account_id == SKIP
+      @so_a_reference_number = so_a_reference_number unless so_a_reference_number == SKIP
+      @statement_date = statement_date unless statement_date == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @amount_due = amount_due unless amount_due == SKIP
+      @amount_overdue = amount_overdue unless amount_overdue == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @currency_symbol = currency_symbol unless currency_symbol == SKIP
+      @due_date = due_date unless due_date == SKIP
+      @invoiced_on_behalf_of = invoiced_on_behalf_of unless invoiced_on_behalf_of == SKIP
+      @status = status unless status == SKIP
+      unless gross_amount_customer_currency == SKIP
+        @gross_amount_customer_currency =
+          gross_amount_customer_currency
+      end
+      unless document_reference_number == SKIP
+        @document_reference_number =
+          document_reference_number
+      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.
+      statement_of_account_id =
+        hash.key?('StatementOfAccountId') ? hash['StatementOfAccountId'] : SKIP
+      so_a_reference_number =
+        hash.key?('SoAReferenceNumber') ? hash['SoAReferenceNumber'] : SKIP
+      statement_date = hash.key?('StatementDate') ? hash['StatementDate'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      amount_due = hash.key?('AmountDue') ? hash['AmountDue'] : SKIP
+      amount_overdue = hash.key?('AmountOverdue') ? hash['AmountOverdue'] : SKIP
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
+      currency_symbol =
+        hash.key?('CurrencySymbol') ? hash['CurrencySymbol'] : SKIP
+      due_date = hash.key?('DueDate') ? hash['DueDate'] : SKIP
+      invoiced_on_behalf_of =
+        hash.key?('InvoicedOnBehalfOf') ? hash['InvoicedOnBehalfOf'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      gross_amount_customer_currency =
+        hash.key?('GrossAmountCustomerCurrency') ? hash['GrossAmountCustomerCurrency'] : SKIP
+      document_reference_number =
+        hash.key?('DocumentReferenceNumber') ? hash['DocumentReferenceNumber'] : SKIP
+
+      # Create object from extracted values.
+      SearchStatementOfAccount.new(statement_of_account_id,
+                                   so_a_reference_number,
+                                   statement_date,
+                                   payer_id,
+                                   payer_number,
+                                   amount_due,
+                                   amount_overdue,
+                                   currency_code,
+                                   currency_symbol,
+                                   due_date,
+                                   invoiced_on_behalf_of,
+                                   status,
+                                   gross_amount_customer_currency,
+                                   document_reference_number)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/search_statement_of_account_request.rb

@@ -0,0 +1,70 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # SearchStatementOfAccountRequest Model.
+  class SearchStatementOfAccountRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [SearchSOAReq]
+    attr_accessor :filters
+
+    # Page number
+    # @return [Integer]
+    attr_accessor :page
+
+    # Number of records in page
+    # @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 = SearchSOAReq.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.
+      SearchStatementOfAccountRequest.new(filters,
+                                          page,
+                                          page_size)
+    end
+  end
+end