data-and-reporting-sdk 1.0.0 → 1.1.0

data/lib/shell_data_reporting_ap_is/models/current_volume.rb

@@ -64,11 +64,8 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(fee_rule_id = SKIP,
-                   fee_rule_description = SKIP,
-                   month = SKIP,
-                   year = SKIP,
-                   total_volume = SKIP)
+    def initialize(fee_rule_id = SKIP, fee_rule_description = SKIP,
+                   month = SKIP, year = SKIP, total_volume = SKIP)
       @fee_rule_id = fee_rule_id unless fee_rule_id == SKIP
       @fee_rule_description = fee_rule_description unless fee_rule_description == SKIP
       @month = month unless month == SKIP

data/lib/shell_data_reporting_ap_is/models/customer_contract.rb

@@ -41,8 +41,7 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(partner_id = SKIP,
-                   partner_name = SKIP)
+    def initialize(partner_id = SKIP, partner_name = SKIP)
       @partner_id = partner_id unless partner_id == SKIP
       @partner_name = partner_name unless partner_name == SKIP
     end

data/lib/shell_data_reporting_ap_is/models/customer_detail_request.rb

@@ -85,11 +85,8 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(col_co_id = SKIP,
-                   col_co_code = SKIP,
-                   payer_id = SKIP,
-                   payer_number = SKIP,
-                   account_id = SKIP,
+    def initialize(col_co_id = SKIP, col_co_code = SKIP, payer_id = SKIP,
+                   payer_number = SKIP, account_id = SKIP,
                    account_number = SKIP)
       @col_co_id = col_co_id unless col_co_id == SKIP
       @col_co_code = col_co_code unless col_co_code == SKIP

data/lib/shell_data_reporting_ap_is/models/customer_detail_response.rb

@@ -54,20 +54,20 @@ module ShellDataReportingApIs
     attr_accessor :billing_address
 
     # Card group position at –
-    # •	Payer – Payer level
-    # •	Account – Account level
+    # •    Payer – Payer level
+    # •    Account – Account level
     # @return [String]
     attr_accessor :card_group_position
 
     # Card group position at –
-    # •	Payer – Payer level
-    # •	Account – Account level
+    # •    Payer – Payer level
+    # •    Account – Account level
     # @return [Address]
     attr_accessor :correspondence_address
 
     # Card group position at –
-    # •	Payer – Payer level
-    # •	Account – Account level
+    # •    Payer – Payer level
+    # •    Account – Account level
     # @return [Array[DeliveryAddresses]]
     attr_accessor :delivery_addresses
 
@@ -132,28 +132,28 @@ module ShellDataReportingApIs
 
     # Default PIN AdviceType of the customer.
     # Possible Values:
-    # 1.	Paper
-    # 2.	Email
-    # 3.	SMS
-    # 4.	None
+    # 1.    Paper
+    # 2.    Email
+    # 3.    SMS
+    # 4.    None
     # @return [Integer]
     attr_accessor :default_pin_advice_type
 
     # Default PIN AdviceType of the customer.
     # Possible Values:
-    # 1.	Paper
-    # 2.	Email
-    # 3.	SMS
-    # 4.	None
+    # 1.    Paper
+    # 2.    Email
+    # 3.    SMS
+    # 4.    None
     # @return [Array[PINAdviceTypes]]
     attr_accessor :pin_advice_types
 
     # Default PIN AdviceType of the customer.
     # Possible Values:
-    # 1.	Paper
-    # 2.	Email
-    # 3.	SMS
-    # 4.	None
+    # 1.    Paper
+    # 2.    Email
+    # 3.    SMS
+    # 4.    None
     # @return [ErrorStatus]
     attr_accessor :error
 
@@ -267,33 +267,19 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(account_id = SKIP,
-                   account_name = SKIP,
-                   account_number = SKIP,
-                   account_short_name = SKIP,
-                   account_trading_name = SKIP,
-                   allow_fleet_id_input = SKIP,
-                   band = SKIP,
-                   billing_address = SKIP,
-                   card_group_position = SKIP,
-                   correspondence_address = SKIP,
-                   delivery_addresses = SKIP,
-                   fleet_pin = SKIP,
-                   full_name = SKIP,
-                   invoice_customer_id = SKIP,
-                   invoice_customer_short_name = SKIP,
-                   is_invoice_point = SKIP,
-                   marketing_segmentation = SKIP,
-                   vat_number = SKIP,
-                   payer_id = SKIP,
-                   payer_name = SKIP,
-                   payer_number = SKIP,
-                   self_selected_pin = SKIP,
-                   status = SKIP,
-                   default_pin_advice_type = SKIP,
-                   pin_advice_types = SKIP,
-                   error = SKIP,
-                   request_id = SKIP,
+    def initialize(account_id = SKIP, account_name = SKIP,
+                   account_number = SKIP, account_short_name = SKIP,
+                   account_trading_name = SKIP, allow_fleet_id_input = SKIP,
+                   band = SKIP, billing_address = SKIP,
+                   card_group_position = SKIP, correspondence_address = SKIP,
+                   delivery_addresses = SKIP, fleet_pin = SKIP,
+                   full_name = SKIP, invoice_customer_id = SKIP,
+                   invoice_customer_short_name = SKIP, is_invoice_point = SKIP,
+                   marketing_segmentation = SKIP, vat_number = SKIP,
+                   payer_id = SKIP, payer_name = SKIP, payer_number = SKIP,
+                   self_selected_pin = SKIP, status = SKIP,
+                   default_pin_advice_type = SKIP, pin_advice_types = SKIP,
+                   error = SKIP, request_id = SKIP,
                    pin_change_allowed_by_cardholder = SKIP,
                    pin_change_allowed_from_fleet_pin = SKIP)
       @account_id = account_id unless account_id == SKIP

data/lib/shell_data_reporting_ap_is/models/customer_price_list_request.rb

@@ -132,18 +132,11 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(from_date = nil,
-                   to_date = nil,
-                   col_co_id = SKIP,
-                   col_co_code = SKIP,
-                   payer_id = SKIP,
-                   payer_number = SKIP,
-                   account_id = SKIP,
-                   account_number = SKIP,
-                   customer_specific_list = SKIP,
-                   price_list_type = SKIP,
-                   del_co_id = SKIP,
-                   include_pump_price_discounts = SKIP)
+    def initialize(from_date = nil, to_date = nil, col_co_id = SKIP,
+                   col_co_code = SKIP, payer_id = SKIP, payer_number = SKIP,
+                   account_id = SKIP, account_number = SKIP,
+                   customer_specific_list = SKIP, price_list_type = SKIP,
+                   del_co_id = SKIP, include_pump_price_discounts = SKIP)
       @col_co_id = col_co_id unless col_co_id == SKIP
       @col_co_code = col_co_code unless col_co_code == SKIP
       @payer_id = payer_id unless payer_id == SKIP

data/lib/shell_data_reporting_ap_is/models/customer_price_list_response.rb

@@ -47,9 +47,7 @@ module ShellDataReportingApIs
       []
     end
 
-    def initialize(request_id = SKIP,
-                   price_list = SKIP,
-                   error = SKIP)
+    def initialize(request_id = SKIP, price_list = SKIP, error = SKIP)
       @request_id = request_id unless request_id == SKIP
       @price_list = price_list unless price_list == SKIP
       @error = error unless error == SKIP

data/lib/shell_data_reporting_ap_is/models/default_error.rb

@@ -0,0 +1,50 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Error response
+  class DefaultError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Fault]
+    attr_accessor :fault
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fault'] = 'fault'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fault
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fault = SKIP)
+      @fault = fault unless fault == 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.
+      fault = Fault.from_hash(hash['fault']) if hash['fault']
+
+      # Create object from extracted values.
+      DefaultError.new(fault)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/default_error_fault.rb

@@ -13,8 +13,8 @@ module ShellDataReportingApIs
     # @return [String]
     attr_accessor :faultstring
 
-    # Details about the error
-    # @return [DefaultErrorFaultDetail]
+    # Error Description
+    # @return [Detail]
     attr_accessor :detail
 
     # A mapping from model property names to API property names.
@@ -38,8 +38,7 @@ module ShellDataReportingApIs
       []
     end
 
-    def initialize(faultstring = SKIP,
-                   detail = SKIP)
+    def initialize(faultstring = SKIP, detail = SKIP)
       @faultstring = faultstring unless faultstring == SKIP
       @detail = detail unless detail == SKIP
     end
@@ -50,7 +49,7 @@ module ShellDataReportingApIs
 
       # Extract variables from the hash.
       faultstring = hash.key?('faultstring') ? hash['faultstring'] : SKIP
-      detail = DefaultErrorFaultDetail.from_hash(hash['detail']) if hash['detail']
+      detail = Detail.from_hash(hash['detail']) if hash['detail']
 
       # Create object from extracted values.
       DefaultErrorFault.new(faultstring,

data/lib/shell_data_reporting_ap_is/models/delivery_addresses.rb

@@ -164,24 +164,13 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(address_id = SKIP,
-                   address_line1 = SKIP,
-                   address_line2 = SKIP,
-                   address_line3 = SKIP,
-                   city = SKIP,
-                   company_name = SKIP,
-                   contact_fore_name = SKIP,
-                   contact_last_name = SKIP,
-                   contact_middle_name = SKIP,
-                   contact_title = SKIP,
-                   country = SKIP,
-                   country_id = SKIP,
-                   country_iso_code = SKIP,
-                   fax = SKIP,
-                   region = SKIP,
-                   region_id = SKIP,
-                   telephone = SKIP,
-                   zip_code = SKIP,
+    def initialize(address_id = SKIP, address_line1 = SKIP,
+                   address_line2 = SKIP, address_line3 = SKIP, city = SKIP,
+                   company_name = SKIP, contact_fore_name = SKIP,
+                   contact_last_name = SKIP, contact_middle_name = SKIP,
+                   contact_title = SKIP, country = SKIP, country_id = SKIP,
+                   country_iso_code = SKIP, fax = SKIP, region = SKIP,
+                   region_id = SKIP, telephone = SKIP, zip_code = SKIP,
                    address_type = SKIP)
       @address_id = address_id unless address_id == SKIP
       @address_line1 = address_line1 unless address_line1 == SKIP

data/lib/shell_data_reporting_ap_is/models/detail.rb

@@ -0,0 +1,50 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # Detail Model.
+  class Detail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error code
+    # @return [String]
+    attr_accessor :errorcode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['errorcode'] = 'errorcode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        errorcode
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(errorcode = SKIP)
+      @errorcode = errorcode unless errorcode == 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.
+      errorcode = hash.key?('errorcode') ? hash['errorcode'] : SKIP
+
+      # Create object from extracted values.
+      Detail.new(errorcode)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/eid_access.rb

@@ -48,8 +48,7 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(col_co_id = SKIP,
-                   col_co_code = SKIP,
+    def initialize(col_co_id = SKIP, col_co_code = SKIP,
                    account_group_id = SKIP)
       @col_co_id = col_co_id unless col_co_id == SKIP
       @col_co_code = col_co_code unless col_co_code == SKIP

data/lib/shell_data_reporting_ap_is/models/eid_document.rb

@@ -24,8 +24,8 @@ module ShellDataReportingApIs
 
     # Document type.
     # Possible values:
-    # •	NAT (National)
-    # •	INT (International)
+    # •    NAT (National)
+    # •    INT (International)
     # @return [String]
     attr_accessor :document_type
 
@@ -48,10 +48,10 @@ module ShellDataReportingApIs
 
     # Document status.
     # Possible values:
-    # •	NEW
-    # •	VIEWED
-    # •	DOWNLOADED
-    # •	RESTORED
+    # •    NEW
+    # •    VIEWED
+    # •    DOWNLOADED
+    # •    RESTORED
     # @return [String]
     attr_accessor :document_status
 
@@ -107,16 +107,11 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(document_id = SKIP,
-                   account_group_id = SKIP,
-                   account_group_name = SKIP,
-                   document_type = SKIP,
-                   document_format = SKIP,
-                   document_date = SKIP,
-                   number_of_invoices = SKIP,
-                   file_size = SKIP,
-                   document_status = SKIP,
-                   document_name = SKIP)
+    def initialize(document_id = SKIP, account_group_id = SKIP,
+                   account_group_name = SKIP, document_type = SKIP,
+                   document_format = SKIP, document_date = SKIP,
+                   number_of_invoices = SKIP, file_size = SKIP,
+                   document_status = SKIP, document_name = SKIP)
       @document_id = document_id unless document_id == SKIP
       @account_group_id = account_group_id unless account_group_id == SKIP
       @account_group_name = account_group_name unless account_group_name == SKIP

data/lib/shell_data_reporting_ap_is/models/eid_document_response.rb

@@ -81,14 +81,9 @@ module ShellDataReportingApIs
       []
     end
 
-    def initialize(request_id = SKIP,
-                   status = SKIP,
-                   data = SKIP,
-                   page_size = SKIP,
-                   page = SKIP,
-                   total_pages = SKIP,
-                   total_records = SKIP,
-                   is_first_page = SKIP,
+    def initialize(request_id = SKIP, status = SKIP, data = SKIP,
+                   page_size = SKIP, page = SKIP, total_pages = SKIP,
+                   total_records = SKIP, is_first_page = SKIP,
                    is_last_page = SKIP)
       @request_id = request_id unless request_id == SKIP
       @status = status unless status == SKIP

data/lib/shell_data_reporting_ap_is/models/eid_download_req.rb

@@ -54,10 +54,8 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(col_co_code = nil,
-                   eid_list = nil,
-                   account_group_country = nil,
-                   account_group_id_list = nil)
+    def initialize(col_co_code = nil, eid_list = nil,
+                   account_group_country = nil, account_group_id_list = nil)
       @col_co_code = col_co_code
       @eid_list = eid_list
       @account_group_country = account_group_country

data/lib/shell_data_reporting_ap_is/models/eid_search_req.rb

@@ -43,18 +43,18 @@ module ShellDataReportingApIs
     # Invoice type.
     # Optional.
     # Possible values:
-    # •	NAT (National)
-    # •	INT (International)
+    # •    NAT (National)
+    # •    INT (International)
     # @return [String]
     attr_accessor :invoice_type
 
     # Status of the document. 
     # Optional.
     # Possible values:
-    # •	NEW
-    # •	VIEWED
-    # •	DOWNLOADED
-    # •	RESTORED
+    # •    NEW
+    # •    VIEWED
+    # •    DOWNLOADED
+    # •    RESTORED
     # @return [String]
     attr_accessor :invoice_status
 
@@ -107,15 +107,10 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(col_co_code = nil,
-                   account_group_country = nil,
-                   account_group_id = nil,
-                   account_group_name = SKIP,
-                   from_date = SKIP,
-                   to_date = SKIP,
-                   invoice_type = SKIP,
-                   invoice_status = SKIP,
-                   sort_by = SKIP)
+    def initialize(col_co_code = nil, account_group_country = nil,
+                   account_group_id = nil, account_group_name = SKIP,
+                   from_date = SKIP, to_date = SKIP, invoice_type = SKIP,
+                   invoice_status = SKIP, sort_by = SKIP)
       @col_co_code = col_co_code
       @account_group_country = account_group_country
       @account_group_id = account_group_id

data/lib/shell_data_reporting_ap_is/models/eid_search_request.rb

@@ -44,9 +44,7 @@ module ShellDataReportingApIs
       []
     end
 
-    def initialize(filters = SKIP,
-                   page = SKIP,
-                   page_size = SKIP)
+    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

data/lib/shell_data_reporting_ap_is/models/error_details.rb

@@ -50,9 +50,7 @@ module ShellDataReportingApIs
       []
     end
 
-    def initialize(code = SKIP,
-                   title = SKIP,
-                   detail = SKIP,
+    def initialize(code = SKIP, title = SKIP, detail = SKIP,
                    additional_info = SKIP)
       @code = code unless code == SKIP
       @title = title unless title == SKIP

data/lib/shell_data_reporting_ap_is/models/error_object.rb

@@ -0,0 +1,80 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # ErrorObject Model.
+  class ErrorObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique request identifier passed from end user. This identifier helps in
+    # tracing a transaction
+    # @return [String]
+    attr_accessor :request_id
+
+    # Indicates overall status of the request. Allowed values: SUCCES, FAILED,
+    # PARTIAL_SUCCESS
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates overall status of the request. Allowed values: SUCCES, FAILED,
+    # PARTIAL_SUCCESS
+    # @return [Array[ErrorDetails]]
+    attr_accessor :errors
+
+    # 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['errors'] = 'Errors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP, status = SKIP, errors = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @errors = errors unless errors == 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
+      errors = nil
+      unless hash['Errors'].nil?
+        errors = []
+        hash['Errors'].each do |structure|
+          errors << (ErrorDetails.from_hash(structure) if structure)
+        end
+      end
+
+      errors = SKIP unless hash.key?('Errors')
+
+      # Create object from extracted values.
+      ErrorObject.new(request_id,
+                      status,
+                      errors)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/error_status.rb

@@ -38,8 +38,7 @@ module ShellDataReportingApIs
       []
     end
 
-    def initialize(code = SKIP,
-                   description = SKIP)
+    def initialize(code = SKIP, description = SKIP)
       @code = code unless code == SKIP
       @description = description unless description == SKIP
     end
@@ -56,5 +55,15 @@ module ShellDataReportingApIs
       ErrorStatus.new(code,
                       description)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [ErrorStatus | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/shell_data_reporting_ap_is/models/error_user_access_error.rb

@@ -38,8 +38,7 @@ module ShellDataReportingApIs
       []
     end
 
-    def initialize(code = SKIP,
-                   description = SKIP)
+    def initialize(code = SKIP, description = SKIP)
       @code = code unless code == SKIP
       @description = description unless description == SKIP
     end

data/lib/shell_data_reporting_ap_is/models/exception_product.rb

@@ -43,8 +43,7 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(productid = SKIP,
-                   product_code = SKIP)
+    def initialize(productid = SKIP, product_code = SKIP)
       @productid = productid unless productid == SKIP
       @product_code = product_code unless product_code == SKIP
     end

data/lib/shell_data_reporting_ap_is/models/exception_site_location.rb

@@ -41,8 +41,7 @@ module ShellDataReportingApIs
       ]
     end
 
-    def initialize(lat = SKIP,
-                   lng = SKIP)
+    def initialize(lat = SKIP, lng = SKIP)
       @lat = lat unless lat == SKIP
       @lng = lng unless lng == SKIP
     end