data-and-reporting-sdk 1.2.0 → 2.0.0

data/lib/shell_data_reporting_ap_is/models/update_odometer_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
   # UpdateOdometerResponse Model.
@@ -17,21 +17,11 @@ module ShellDataReportingApIs
     # @return [Array[UpdateOdometerReference]]
     attr_accessor :update_odometer_references
 
-    # Main reference number for tracking.
-    # @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?
       @_hash['service_reference'] = 'ServiceReference'
       @_hash['update_odometer_references'] = 'UpdateOdometerReferences'
-      @_hash['error'] = 'Error'
-      @_hash['request_id'] = 'RequestId'
       @_hash
     end
 
@@ -40,8 +30,6 @@ module ShellDataReportingApIs
       %w[
         service_reference
         update_odometer_references
-        error
-        request_id
       ]
     end
 
@@ -50,15 +38,12 @@ module ShellDataReportingApIs
       []
     end
 
-    def initialize(service_reference = SKIP, update_odometer_references = SKIP,
-                   error = SKIP, request_id = SKIP)
+    def initialize(service_reference = SKIP, update_odometer_references = SKIP)
       @service_reference = service_reference unless service_reference == SKIP
       unless update_odometer_references == SKIP
         @update_odometer_references =
           update_odometer_references
       end
-      @error = error unless error == SKIP
-      @request_id = request_id unless request_id == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -78,14 +63,24 @@ module ShellDataReportingApIs
       end
 
       update_odometer_references = SKIP unless hash.key?('UpdateOdometerReferences')
-      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
-      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
 
       # Create object from extracted values.
       UpdateOdometerResponse.new(service_reference,
-                                 update_odometer_references,
-                                 error,
-                                 request_id)
+                                 update_odometer_references)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} service_reference: #{@service_reference}, update_odometer_references:"\
+      " #{@update_odometer_references}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} service_reference: #{@service_reference.inspect},"\
+      " update_odometer_references: #{@update_odometer_references.inspect}>"
     end
   end
 end

data/lib/shell_data_reporting_ap_is/models/usage_summary.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
   # UsageSummary Model.
@@ -190,5 +190,28 @@ module ShellDataReportingApIs
                        product_group_id,
                        product_group_name)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} date: #{@date}, product_id: #{@product_id}, product_code: #{@product_code},"\
+      " product_name: #{@product_name}, is_fuel_product: #{@is_fuel_product}, site_group_id:"\
+      " #{@site_group_id}, site_group_name: #{@site_group_name}, total_volume: #{@total_volume},"\
+      " total_gross: #{@total_gross}, total_net: #{@total_net}, currency_code: #{@currency_code},"\
+      " currency_symbol: #{@currency_symbol}, product_group_id: #{@product_group_id},"\
+      " product_group_name: #{@product_group_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} date: #{@date.inspect}, product_id: #{@product_id.inspect}, product_code:"\
+      " #{@product_code.inspect}, product_name: #{@product_name.inspect}, is_fuel_product:"\
+      " #{@is_fuel_product.inspect}, site_group_id: #{@site_group_id.inspect}, site_group_name:"\
+      " #{@site_group_name.inspect}, total_volume: #{@total_volume.inspect}, total_gross:"\
+      " #{@total_gross.inspect}, total_net: #{@total_net.inspect}, currency_code:"\
+      " #{@currency_code.inspect}, currency_symbol: #{@currency_symbol.inspect}, product_group_id:"\
+      " #{@product_group_id.inspect}, product_group_name: #{@product_group_name.inspect}>"
+    end
   end
 end

data/lib/shell_data_reporting_ap_is/models/volume_based_bonus_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
+  # VolumeBasedBonusReq Model.
+  class VolumeBasedBonusReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [VolumeBasedBonusRequest]
+    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 = VolumeBasedBonusRequest.from_hash(hash['Filters']) if hash['Filters']
+
+      # Create object from extracted values.
+      VolumeBasedBonusReq.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/volume_based_bonus_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
   # VolumeBasedBonusRequest Model.
@@ -111,5 +111,22 @@ module ShellDataReportingApIs
                                   include_history,
                                   include_current_period_volume)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} col_co_id: #{@col_co_id}, col_co_code: #{@col_co_code}, payer_id:"\
+      " #{@payer_id}, payer_number: #{@payer_number}, include_history: #{@include_history},"\
+      " include_current_period_volume: #{@include_current_period_volume}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} col_co_id: #{@col_co_id.inspect}, col_co_code: #{@col_co_code.inspect},"\
+      " payer_id: #{@payer_id.inspect}, payer_number: #{@payer_number.inspect}, include_history:"\
+      " #{@include_history.inspect}, include_current_period_volume:"\
+      " #{@include_current_period_volume.inspect}>"
+    end
   end
 end

data/lib/shell_data_reporting_ap_is/models/volume_based_bonus_res.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
+  # VolumeBasedBonusRes Model.
+  class VolumeBasedBonusRes < 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[VolumeBasedBonusResponse]]
+    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 << (VolumeBasedBonusResponse.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.
+      VolumeBasedBonusRes.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/volume_based_bonus_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
   # VolumeBasedBonusResponse Model.
@@ -21,22 +21,12 @@ module ShellDataReportingApIs
     # @return [Array[BonusHistory]]
     attr_accessor :historical_bonus_paid
 
-    # TODO: Write general description for this method
-    # @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?
       @_hash['configuration'] = 'Configuration'
       @_hash['current_period_consumption'] = 'CurrentPeriodConsumption'
       @_hash['historical_bonus_paid'] = 'HistoricalBonusPaid'
-      @_hash['error'] = 'Error'
-      @_hash['request_id'] = 'RequestId'
       @_hash
     end
 
@@ -46,8 +36,6 @@ module ShellDataReportingApIs
         configuration
         current_period_consumption
         historical_bonus_paid
-        error
-        request_id
       ]
     end
 
@@ -57,16 +45,13 @@ module ShellDataReportingApIs
     end
 
     def initialize(configuration = SKIP, current_period_consumption = SKIP,
-                   historical_bonus_paid = SKIP, error = SKIP,
-                   request_id = SKIP)
+                   historical_bonus_paid = SKIP)
       @configuration = configuration unless configuration == SKIP
       unless current_period_consumption == SKIP
         @current_period_consumption =
           current_period_consumption
       end
       @historical_bonus_paid = historical_bonus_paid unless historical_bonus_paid == SKIP
-      @error = error unless error == SKIP
-      @request_id = request_id unless request_id == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -104,15 +89,26 @@ module ShellDataReportingApIs
       end
 
       historical_bonus_paid = SKIP unless hash.key?('HistoricalBonusPaid')
-      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
-      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
 
       # Create object from extracted values.
       VolumeBasedBonusResponse.new(configuration,
                                    current_period_consumption,
-                                   historical_bonus_paid,
-                                   error,
-                                   request_id)
+                                   historical_bonus_paid)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} configuration: #{@configuration}, current_period_consumption:"\
+      " #{@current_period_consumption}, historical_bonus_paid: #{@historical_bonus_paid}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} configuration: #{@configuration.inspect}, current_period_consumption:"\
+      " #{@current_period_consumption.inspect}, historical_bonus_paid:"\
+      " #{@historical_bonus_paid.inspect}>"
     end
   end
 end

data/lib/shell_data_reporting_ap_is/models/volume_based_pricing_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
+  # VolumeBasedPricingReq Model.
+  class VolumeBasedPricingReq < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [VolumeBasedPricingRequest]
+    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 = VolumeBasedPricingRequest.from_hash(hash['Filters']) if hash['Filters']
+
+      # Create object from extracted values.
+      VolumeBasedPricingReq.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/volume_based_pricing_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
   # VolumeBasedPricingRequest Model.
@@ -96,5 +96,20 @@ module ShellDataReportingApIs
                                     payer_number,
                                     include_history)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} col_co_id: #{@col_co_id}, col_co_code: #{@col_co_code}, payer_id:"\
+      " #{@payer_id}, payer_number: #{@payer_number}, include_history: #{@include_history}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} col_co_id: #{@col_co_id.inspect}, col_co_code: #{@col_co_code.inspect},"\
+      " payer_id: #{@payer_id.inspect}, payer_number: #{@payer_number.inspect}, include_history:"\
+      " #{@include_history.inspect}>"
+    end
   end
 end

data/lib/shell_data_reporting_ap_is/models/volume_based_pricing_res.rb

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