data-and-reporting-sdk 1.3.0 → 2.0.0

data/lib/shell_data_reporting_ap_is/models/priced_trans_summary_resp.rb

@@ -0,0 +1,116 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ShellDataReportingApIs
+  # PricedTransSummaryResp Model.
+  class PricedTransSummaryResp < 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[PricedTransSummaryResponseTransactionsSummaryItems]]
+    attr_accessor :data
+
+    # 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['warnings'] = 'Warnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        data
+        warnings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP, status = SKIP, data = SKIP,
+                   warnings = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @data = data unless data == 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 << (PricedTransSummaryResponseTransactionsSummaryItems.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+      # 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.
+      PricedTransSummaryResp.new(request_id,
+                                 status,
+                                 data,
+                                 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}, 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}, warnings: #{@warnings.inspect}>"
+    end
+  end
+end

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

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

data/lib/shell_data_reporting_ap_is/models/priced_transaction_req_v2_invoice_status_enum.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
   # Invoice status of the transactions. Mandatory Possible options:I - Invoiced,

data/lib/shell_data_reporting_ap_is/models/priced_transaction_req_v2_period_enum.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
   # Pass below one of the value as per the required transaction period 1. Last 7

data/lib/shell_data_reporting_ap_is/models/priced_transaction_req_v2_sort_order_enum.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
   # Allowed Sorting Options 1.    TransactionDateAscending 2.

data/lib/shell_data_reporting_ap_is/models/priced_transaction_request_v2.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
   # PricedTransactionRequestV2 Model.
@@ -9,10 +9,8 @@ module ShellDataReportingApIs
     SKIP = Object.new
     private_constant :SKIP
 
-    # This endpoint allows querying the transaction data (i.e. Priced, Billed
-    # and Unbilled sales items) from SFSBI. It provides a flexible search
-    # criteria and supports paging
-    # @return [PricedRequestData]
+    # TODO: Write general description for this method
+    # @return [Filters]
     attr_accessor :filters
 
     # Specify the page of results to be returned.
@@ -57,7 +55,7 @@ module ShellDataReportingApIs
       return nil unless hash
 
       # Extract variables from the hash.
-      filters = PricedRequestData.from_hash(hash['Filters']) if hash['Filters']
+      filters = Filters.from_hash(hash['Filters']) if hash['Filters']
       page = hash.key?('Page') ? hash['Page'] : SKIP
       page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
 

data/lib/shell_data_reporting_ap_is/models/priced_transaction_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
+  # PricedTransactionRes Model.
+  class PricedTransactionRes < 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[PricedTransactionResponse]]
+    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 << (PricedTransactionResponse.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.
+      PricedTransactionRes.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/priced_transaction_resp_v2_refund_flag_enum.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
   # Flag to check if there is any refund

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

data/lib/shell_data_reporting_ap_is/models/priced_transaction_response_transactions_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
   # PricedTransactionResponseTransactionsItems Model.
@@ -640,15 +640,6 @@ module ShellDataReportingApIs
     # @return [String]
     attr_accessor :transaction_type_description
 
-    # Transaction Type Description
-    # Note: - The value could be null/blank for fees item
-    # @return [ErrorStatus]
-    attr_accessor :error
-
-    # API Request Id
-    # @return [String]
-    attr_accessor :request_id
-
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -787,8 +778,6 @@ module ShellDataReportingApIs
       @_hash['customer_retail_value_total_net'] =
         'CustomerRetailValueTotalNet'
       @_hash['transaction_type_description'] = 'TransactionTypeDescription'
-      @_hash['error'] = 'Error'
-      @_hash['request_id'] = 'RequestId'
       @_hash
     end
 
@@ -919,8 +908,6 @@ module ShellDataReportingApIs
         customer_retail_value_total_gross
         customer_retail_value_total_net
         transaction_type_description
-        error
-        request_id
       ]
     end
 
@@ -1124,8 +1111,7 @@ module ShellDataReportingApIs
                    customer_retail_price_unit_gross = SKIP,
                    customer_retail_value_total_gross = SKIP,
                    customer_retail_value_total_net = SKIP,
-                   transaction_type_description = SKIP, error = SKIP,
-                   request_id = SKIP)
+                   transaction_type_description = SKIP)
       @type = type unless type == SKIP
       @card_id = card_id unless card_id == SKIP
       @card_pan = card_pan unless card_pan == SKIP
@@ -1322,8 +1308,6 @@ module ShellDataReportingApIs
         @transaction_type_description =
           transaction_type_description
       end
-      @error = error unless error == SKIP
-      @request_id = request_id unless request_id == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -1524,8 +1508,6 @@ module ShellDataReportingApIs
         hash.key?('CustomerRetailValueTotalNet') ? hash['CustomerRetailValueTotalNet'] : SKIP
       transaction_type_description =
         hash.key?('TransactionTypeDescription') ? hash['TransactionTypeDescription'] : SKIP
-      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
-      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
 
       # Create object from extracted values.
       PricedTransactionResponseTransactionsItems.new(type,
@@ -1651,9 +1633,7 @@ module ShellDataReportingApIs
                                                      customer_retail_price_unit_gross,
                                                      customer_retail_value_total_gross,
                                                      customer_retail_value_total_net,
-                                                     transaction_type_description,
-                                                     error,
-                                                     request_id)
+                                                     transaction_type_description)
     end
 
     # Validates an instance of the object from a given value.
@@ -1738,7 +1718,7 @@ module ShellDataReportingApIs
       " #{@customer_retail_price_unit_gross}, customer_retail_value_total_gross:"\
       " #{@customer_retail_value_total_gross}, customer_retail_value_total_net:"\
       " #{@customer_retail_value_total_net}, transaction_type_description:"\
-      " #{@transaction_type_description}, error: #{@error}, request_id: #{@request_id}>"
+      " #{@transaction_type_description}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
@@ -1828,8 +1808,7 @@ module ShellDataReportingApIs
       " customer_retail_price_unit_gross: #{@customer_retail_price_unit_gross.inspect},"\
       " customer_retail_value_total_gross: #{@customer_retail_value_total_gross.inspect},"\
       " customer_retail_value_total_net: #{@customer_retail_value_total_net.inspect},"\
-      " transaction_type_description: #{@transaction_type_description.inspect}, error:"\
-      " #{@error.inspect}, request_id: #{@request_id.inspect}>"
+      " transaction_type_description: #{@transaction_type_description.inspect}>"
     end
   end
 end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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