data-and-reporting-sdk 1.3.0 → 3.0.0

data/lib/shell_data_reporting_ap_is/models/account_access.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
   # AccountAccess Model.

data/lib/shell_data_reporting_ap_is/models/account_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
+  # AccountReq Model.
+  class AccountReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [AccountRequest]
+    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 = AccountRequest.from_hash(hash['Filters']) if hash['Filters']
+      page = hash['Page'] ||= 1
+      page_size = hash['PageSize'] ||= 50
+
+      # Create object from extracted values.
+      AccountReq.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/account_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
   # AccountRequest Model.
@@ -75,7 +75,7 @@ module ShellDataReportingApIs
     # @return [TrueClass | FalseClass]
     attr_accessor :invoice_points_only
 
-    # Collecting Company Id (in GFN) of the selected payer. 
+    # Collecting Company Id  of the selected payer. 
     # Optional if ColCoCode or ColCoCountryCode  is passed else Mandatory.
     # @return [Integer]
     attr_accessor :col_co_id

data/lib/shell_data_reporting_ap_is/models/account_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
+  # AccountRes Model.
+  class AccountRes < 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[AccountResponseAccountsItems]]
+    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 << (AccountResponseAccountsItems.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.
+      AccountRes.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/account_response_accounts_items.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
   # AccountResponseAccountsItems Model.

data/lib/shell_data_reporting_ap_is/models/accounts.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
   # Accounts Model.

data/lib/shell_data_reporting_ap_is/models/address.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
   # Address Model.

data/lib/shell_data_reporting_ap_is/models/associated_account.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
   # AssociatedAccount Model.

data/lib/shell_data_reporting_ap_is/models/audit_array_elements.rb

@@ -0,0 +1,71 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ShellDataReportingApIs
+  # AuditArrayElements Model.
+  class AuditArrayElements < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[AuditResponseAuditsItems]]
+    attr_accessor :audits
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['audits'] = 'Audits'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        audits
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(audits = SKIP)
+      @audits = audits unless audits == 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
+      audits = nil
+      unless hash['Audits'].nil?
+        audits = []
+        hash['Audits'].each do |structure|
+          audits << (AuditResponseAuditsItems.from_hash(structure) if structure)
+        end
+      end
+
+      audits = SKIP unless hash.key?('Audits')
+
+      # Create object from extracted values.
+      AuditArrayElements.new(audits)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} audits: #{@audits}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} audits: #{@audits.inspect}>"
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/audit_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
+  # AuditReq Model.
+  class AuditReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [AuditRequest]
+    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 = AuditRequest.from_hash(hash['Filters']) if hash['Filters']
+      page = hash['Page'] ||= 1
+      page_size = hash['PageSize'] ||= 50
+
+      # Create object from extracted values.
+      AuditReq.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/audit_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
   # AuditRequest Model.
@@ -65,20 +65,26 @@ module ShellDataReportingApIs
     # @return [Accounts]
     attr_accessor :accounts
 
-    # Page Size – Number of records to show on a page
+    # Type of requests to be fetched.
     # Optional
-    # Default value 50
-    # @return [Integer]
-    attr_accessor :page_size
-
-    # To search for requests submitted until this date.
-    # Optional 
-    # Format: yyyyMMdd 
-    # Example: 20200130
-    # If ToDate is not provided and FromDate is provided, then ToDate will be
-    # considered as current date or 30 days from FromDate, whichever is earlier.
-    # However, when both FromDate and ToDate is not provided then last 30 days
-    # will be considered for filtering.
+    # Allowed values:
+    # •    OrderCard
+    # •    CreateCardGroup
+    # •    PINReminder
+    # •    MoveCard
+    # •    UpdateCardStatus
+    # •    UpdateCardGroup
+    # •    AutoRenew
+    # •    BulkCardOrder
+    # •    BulkCardBlock
+    # •    BulkCardOrderMultiAccount
+    # •    MobilePaymentRegistration
+    # •    UpdateCompanyInfo
+    # •    BCOSummary
+    # •    BCOMultiAccountSummary
+    # •    BCBSummary
+    # •    FundTransfer
+    # •    DeliveryAddressUpdate
     # @return [Array[String]]
     attr_accessor :requested_operation
 
@@ -100,12 +106,6 @@ module ShellDataReportingApIs
     # @return [String]
     attr_accessor :search_text
 
-    # Page Number (as shown to the users)
-    # Optional
-    # Default value 1
-    # @return [Integer]
-    attr_accessor :current_page
-
     # To search for requests submitted from this date.
     # Optional
     # Maximum of X days duration allowed per search. The X value is configurable
@@ -139,11 +139,9 @@ module ShellDataReportingApIs
       @_hash['col_co_code'] = 'ColCoCode'
       @_hash['col_co_id'] = 'ColCoId'
       @_hash['accounts'] = 'Accounts'
-      @_hash['page_size'] = 'PageSize'
       @_hash['requested_operation'] = 'RequestedOperation'
       @_hash['sort_order'] = 'SortOrder'
       @_hash['search_text'] = 'SearchText'
-      @_hash['current_page'] = 'CurrentPage'
       @_hash['from_date'] = 'FromDate'
       @_hash['to_date'] = 'ToDate'
       @_hash
@@ -159,11 +157,9 @@ module ShellDataReportingApIs
         col_co_code
         col_co_id
         accounts
-        page_size
         requested_operation
         sort_order
         search_text
-        current_page
         from_date
         to_date
       ]
@@ -179,7 +175,6 @@ module ShellDataReportingApIs
         col_co_id
         sort_order
         search_text
-        current_page
         from_date
         to_date
       ]
@@ -187,9 +182,8 @@ module ShellDataReportingApIs
 
     def initialize(status = SKIP, payer_number = SKIP, payer_id = SKIP,
                    account_number = SKIP, col_co_code = SKIP, col_co_id = SKIP,
-                   accounts = SKIP, page_size = SKIP,
-                   requested_operation = SKIP, sort_order = SKIP,
-                   search_text = SKIP, current_page = SKIP, from_date = SKIP,
+                   accounts = SKIP, requested_operation = SKIP,
+                   sort_order = SKIP, search_text = SKIP, from_date = SKIP,
                    to_date = SKIP)
       @status = status unless status == SKIP
       @payer_number = payer_number unless payer_number == SKIP
@@ -198,11 +192,9 @@ module ShellDataReportingApIs
       @col_co_code = col_co_code unless col_co_code == SKIP
       @col_co_id = col_co_id unless col_co_id == SKIP
       @accounts = accounts unless accounts == SKIP
-      @page_size = page_size unless page_size == SKIP
       @requested_operation = requested_operation unless requested_operation == SKIP
       @sort_order = sort_order unless sort_order == SKIP
       @search_text = search_text unless search_text == SKIP
-      @current_page = current_page unless current_page == SKIP
       @from_date = from_date unless from_date == SKIP
       @to_date = to_date unless to_date == SKIP
     end
@@ -219,12 +211,10 @@ module ShellDataReportingApIs
       col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
       col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
       accounts = Accounts.from_hash(hash['Accounts']) if hash['Accounts']
-      page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
       requested_operation =
         hash.key?('RequestedOperation') ? hash['RequestedOperation'] : SKIP
       sort_order = hash.key?('SortOrder') ? hash['SortOrder'] : SKIP
       search_text = hash.key?('SearchText') ? hash['SearchText'] : SKIP
-      current_page = hash.key?('CurrentPage') ? hash['CurrentPage'] : SKIP
       from_date = hash.key?('FromDate') ? hash['FromDate'] : SKIP
       to_date = hash.key?('ToDate') ? hash['ToDate'] : SKIP
 
@@ -236,11 +226,9 @@ module ShellDataReportingApIs
                        col_co_code,
                        col_co_id,
                        accounts,
-                       page_size,
                        requested_operation,
                        sort_order,
                        search_text,
-                       current_page,
                        from_date,
                        to_date)
     end
@@ -250,9 +238,9 @@ module ShellDataReportingApIs
       class_name = self.class.name.split('::').last
       "<#{class_name} status: #{@status}, payer_number: #{@payer_number}, payer_id: #{@payer_id},"\
       " account_number: #{@account_number}, col_co_code: #{@col_co_code}, col_co_id:"\
-      " #{@col_co_id}, accounts: #{@accounts}, page_size: #{@page_size}, requested_operation:"\
-      " #{@requested_operation}, sort_order: #{@sort_order}, search_text: #{@search_text},"\
-      " current_page: #{@current_page}, from_date: #{@from_date}, to_date: #{@to_date}>"
+      " #{@col_co_id}, accounts: #{@accounts}, requested_operation: #{@requested_operation},"\
+      " sort_order: #{@sort_order}, search_text: #{@search_text}, from_date: #{@from_date},"\
+      " to_date: #{@to_date}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -261,9 +249,9 @@ module ShellDataReportingApIs
       "<#{class_name} status: #{@status.inspect}, payer_number: #{@payer_number.inspect},"\
       " payer_id: #{@payer_id.inspect}, account_number: #{@account_number.inspect}, col_co_code:"\
       " #{@col_co_code.inspect}, col_co_id: #{@col_co_id.inspect}, accounts: #{@accounts.inspect},"\
-      " page_size: #{@page_size.inspect}, requested_operation: #{@requested_operation.inspect},"\
-      " sort_order: #{@sort_order.inspect}, search_text: #{@search_text.inspect}, current_page:"\
-      " #{@current_page.inspect}, from_date: #{@from_date.inspect}, to_date: #{@to_date.inspect}>"
+      " requested_operation: #{@requested_operation.inspect}, sort_order: #{@sort_order.inspect},"\
+      " search_text: #{@search_text.inspect}, from_date: #{@from_date.inspect}, to_date:"\
+      " #{@to_date.inspect}>"
     end
   end
 end