data-and-reporting-sdk 1.3.0 → 2.0.0

data/lib/shell_data_reporting_ap_is/models/payer_req.rb

@@ -0,0 +1,84 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ShellDataReportingApIs
+  # PayerReq Model.
+  class PayerReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PayerRequest]
+    attr_accessor :filters
+
+    # Page Number (as shown to the users)
+    # @return [Integer]
+    attr_accessor :page
+
+    # Page Size – Number of records to show on a 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
+      %w[
+        page
+        page_size
+      ]
+    end
+
+    def initialize(filters = SKIP, page = 1, page_size = 50)
+      @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 = PayerRequest.from_hash(hash['Filters']) if hash['Filters']
+      page = hash['Page'] ||= 1
+      page_size = hash['PageSize'] ||= 50
+
+      # Create object from extracted values.
+      PayerReq.new(filters,
+                   page,
+                   page_size)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} filters: #{@filters}, page: #{@page}, page_size: #{@page_size}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} filters: #{@filters.inspect}, page: #{@page.inspect}, page_size:"\
+      " #{@page_size.inspect}>"
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/payer_request.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # PayerRequest Model.
@@ -33,20 +33,6 @@ module ShellDataReportingApIs
     # @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?
@@ -54,8 +40,6 @@ module ShellDataReportingApIs
       @_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
 
@@ -66,8 +50,6 @@ module ShellDataReportingApIs
         return_basic_details_only
         include_addresses
         include_bonus_parameters
-        current_page
-        page_size
       ]
     end
 
@@ -77,8 +59,7 @@ module ShellDataReportingApIs
     end
 
     def initialize(payers = SKIP, return_basic_details_only = false,
-                   include_addresses = false, include_bonus_parameters = false,
-                   current_page = SKIP, page_size = SKIP)
+                   include_addresses = false, include_bonus_parameters = false)
       @payers = payers unless payers == SKIP
       unless return_basic_details_only == SKIP
         @return_basic_details_only =
@@ -86,8 +67,6 @@ module ShellDataReportingApIs
       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.
@@ -108,16 +87,12 @@ module ShellDataReportingApIs
       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)
+                       include_bonus_parameters)
     end
 
     # Provides a human-readable string representation of the object.
@@ -125,8 +100,7 @@ module ShellDataReportingApIs
       class_name = self.class.name.split('::').last
       "<#{class_name} payers: #{@payers}, return_basic_details_only:"\
       " #{@return_basic_details_only}, include_addresses: #{@include_addresses},"\
-      " include_bonus_parameters: #{@include_bonus_parameters}, current_page: #{@current_page},"\
-      " page_size: #{@page_size}>"
+      " include_bonus_parameters: #{@include_bonus_parameters}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -134,8 +108,7 @@ module ShellDataReportingApIs
       class_name = self.class.name.split('::').last
       "<#{class_name} payers: #{@payers.inspect}, return_basic_details_only:"\
       " #{@return_basic_details_only.inspect}, include_addresses: #{@include_addresses.inspect},"\
-      " include_bonus_parameters: #{@include_bonus_parameters.inspect}, current_page:"\
-      " #{@current_page.inspect}, page_size: #{@page_size.inspect}>"
+      " include_bonus_parameters: #{@include_bonus_parameters.inspect}>"
     end
   end
 end

data/lib/shell_data_reporting_ap_is/models/payer_res.rb

@@ -0,0 +1,158 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ShellDataReportingApIs
+  # PayerRes Model.
+  class PayerRes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the request. This will be played back in the
+    # response from the request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # Status of the request
+    # @return [String]
+    attr_accessor :status
+
+    # Status of the request
+    # @return [Array[PayerDetails]]
+    attr_accessor :data
+
+    # Current Page
+    # @return [Integer]
+    attr_accessor :page
+
+    # Total row count matched for the given input criteria
+    # @return [Integer]
+    attr_accessor :total_records
+
+    # 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
+
+    # Page Size – Number of records to show on current page.
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # A list of Warning entity. 
+    # This entity will hold the details of the scheduled System Outages of any
+    # dependent applications of this service.
+    # Note: If there is no scheduled outage information available, in the
+    # configuration in AMS, for this service, this parameter won’t be present in
+    # output.
+    # @return [Array[Warning]]
+    attr_accessor :warnings
+
+    # 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['warnings'] = 'Warnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        data
+        page
+        total_records
+        total_pages
+        page_size
+        warnings
+      ]
+    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,
+                   warnings = 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
+      @warnings = warnings unless warnings == 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 << (PayerDetails.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
+      # Parameter is an array, so we need to iterate through it
+      warnings = nil
+      unless hash['Warnings'].nil?
+        warnings = []
+        hash['Warnings'].each do |structure|
+          warnings << (Warning.from_hash(structure) if structure)
+        end
+      end
+
+      warnings = SKIP unless hash.key?('Warnings')
+
+      # Create object from extracted values.
+      PayerRes.new(request_id,
+                   status,
+                   data,
+                   page,
+                   total_records,
+                   total_pages,
+                   page_size,
+                   warnings)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id}, status: #{@status}, data: #{@data}, page:"\
+      " #{@page}, total_records: #{@total_records}, total_pages: #{@total_pages}, page_size:"\
+      " #{@page_size}, warnings: #{@warnings}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id.inspect}, status: #{@status.inspect}, data:"\
+      " #{@data.inspect}, page: #{@page.inspect}, total_records: #{@total_records.inspect},"\
+      " total_pages: #{@total_pages.inspect}, page_size: #{@page_size.inspect}, warnings:"\
+      " #{@warnings.inspect}>"
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/payers.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # Payers Model.

data/lib/shell_data_reporting_ap_is/models/payments_since_last_soa.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # List of payments made by the customer after the latest Statement of Account.

data/lib/shell_data_reporting_ap_is/models/pin_advice_types.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # PINAdviceTypes Model.

data/lib/shell_data_reporting_ap_is/models/price_list.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # PriceList Model.

data/lib/shell_data_reporting_ap_is/models/price_trans_summary_req.rb

@@ -0,0 +1,62 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ShellDataReportingApIs
+  # PriceTransSummaryReq Model.
+  class PriceTransSummaryReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PriceTransSummaryRequest]
+    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 = PriceTransSummaryRequest.from_hash(hash['Filters']) if hash['Filters']
+
+      # Create object from extracted values.
+      PriceTransSummaryReq.new(filters)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} filters: #{@filters}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} filters: #{@filters.inspect}>"
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/price_trans_summary_request.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # PriceTransSummaryRequest Model.

data/lib/shell_data_reporting_ap_is/models/price_transaction_req.rb

@@ -0,0 +1,84 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ShellDataReportingApIs
+  # PriceTransactionReq Model.
+  class PriceTransactionReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PriceTransactionRequest]
+    attr_accessor :filters
+
+    # Page Number (as shown to the users)
+    # @return [Integer]
+    attr_accessor :page
+
+    # Page Size – Number of records to show on a 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
+      %w[
+        page
+        page_size
+      ]
+    end
+
+    def initialize(filters = SKIP, page = 1, page_size = 50)
+      @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 = PriceTransactionRequest.from_hash(hash['Filters']) if hash['Filters']
+      page = hash['Page'] ||= 1
+      page_size = hash['PageSize'] ||= 50
+
+      # Create object from extracted values.
+      PriceTransactionReq.new(filters,
+                              page,
+                              page_size)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} filters: #{@filters}, page: #{@page}, page_size: #{@page_size}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} filters: #{@filters.inspect}, page: #{@page.inspect}, page_size:"\
+      " #{@page_size.inspect}>"
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/price_transaction_request.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # PriceTransactionRequest Model.

data/lib/shell_data_reporting_ap_is/models/priced_request_data.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # This endpoint allows querying the transaction data (i.e. Priced, Billed and
@@ -19,8 +19,7 @@ module ShellDataReportingApIs
     # @return [Integer]
     attr_accessor :col_co_id
 
-    # Invoice status of the transactions. Mandatory Possible options:I -
-    # Invoiced, U – Un-Invoiced, A – All
+    # The Collecting Company Id in the Shell Card Platform.
     # @return [PricedTransactionReqV2InvoiceStatusEnum]
     attr_accessor :invoice_status
 
@@ -120,10 +119,7 @@ module ShellDataReportingApIs
     # @return [String]
     attr_accessor :to_date
 
-    # Pass below one of the value as per the required transaction period
-    # 1. Last 7 Days
-    # 2. Last 30 Days
-    # 3. Last 90 Days
+    # To transaction delivery date
     # @return [PricedTransactionReqV2PeriodEnum]
     attr_accessor :period
 

data/lib/shell_data_reporting_ap_is/models/priced_response_data.rb

@@ -1,7 +1,7 @@
 # shell_data_reporting_ap_is
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module ShellDataReportingApIs
   # PricedResponseData Model.