data-and-reporting-sdk 1.0.0

data/lib/shell_data_reporting_ap_is/models/fee_item_summary_all_of0.rb

@@ -0,0 +1,194 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # FeeItemSummaryAllOf0 Model.
+  class FeeItemSummaryAllOf0 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Fee type group in under which the Fee item is generated.
+    # @return [String]
+    attr_accessor :fee_type_group
+
+    # Fee Type Id ID  Description
+    # @return [String]
+    attr_accessor :fee_type_id
+
+    # Product Id
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # Product Code
+    # @return [String]
+    attr_accessor :product_code
+
+    # Product Name
+    # @return [String]
+    attr_accessor :product_name
+
+    # Product Group Id
+    # @return [Integer]
+    attr_accessor :product_group_id
+
+    # Product Group Name
+    # @return [String]
+    attr_accessor :product_group_name
+
+    # Total Quantity
+    # @return [Float]
+    attr_accessor :total_quantity
+
+    # Total Net amount in invoice currency
+    # @return [Float]
+    attr_accessor :total_invoice_net_amount
+
+    # Total Gross amount in invoice currency
+    # @return [Float]
+    attr_accessor :total_invoice_gross_amount
+
+    # Total VAT amount in invoice currency
+    # @return [Float]
+    attr_accessor :total_invoice_vat_amount
+
+    # ISO 4217 currency code of the country
+    # @return [String]
+    attr_accessor :invoice_currency_code
+
+    # Currency symbol of the Invoice Currency Code
+    # @return [String]
+    attr_accessor :invoice_currency_symbol
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fee_type_group'] = 'FeeTypeGroup'
+      @_hash['fee_type_id'] = 'FeeTypeId'
+      @_hash['product_id'] = 'ProductId'
+      @_hash['product_code'] = 'ProductCode'
+      @_hash['product_name'] = 'ProductName'
+      @_hash['product_group_id'] = 'ProductGroupId'
+      @_hash['product_group_name'] = 'ProductGroupName'
+      @_hash['total_quantity'] = 'TotalQuantity'
+      @_hash['total_invoice_net_amount'] = 'TotalInvoiceNetAmount'
+      @_hash['total_invoice_gross_amount'] = 'TotalInvoiceGrossAmount'
+      @_hash['total_invoice_vat_amount'] = 'TotalInvoiceVATAmount'
+      @_hash['invoice_currency_code'] = 'InvoiceCurrencyCode'
+      @_hash['invoice_currency_symbol'] = 'InvoiceCurrencySymbol'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fee_type_group
+        fee_type_id
+        product_id
+        product_code
+        product_name
+        product_group_id
+        product_group_name
+        total_quantity
+        total_invoice_net_amount
+        total_invoice_gross_amount
+        total_invoice_vat_amount
+        invoice_currency_code
+        invoice_currency_symbol
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        fee_type_group
+        fee_type_id
+        product_id
+        product_code
+        product_name
+        product_group_id
+        product_group_name
+        total_quantity
+        total_invoice_net_amount
+        total_invoice_gross_amount
+        total_invoice_vat_amount
+        invoice_currency_code
+        invoice_currency_symbol
+      ]
+    end
+
+    def initialize(fee_type_group = SKIP,
+                   fee_type_id = SKIP,
+                   product_id = SKIP,
+                   product_code = SKIP,
+                   product_name = SKIP,
+                   product_group_id = SKIP,
+                   product_group_name = SKIP,
+                   total_quantity = SKIP,
+                   total_invoice_net_amount = SKIP,
+                   total_invoice_gross_amount = SKIP,
+                   total_invoice_vat_amount = SKIP,
+                   invoice_currency_code = SKIP,
+                   invoice_currency_symbol = SKIP)
+      @fee_type_group = fee_type_group unless fee_type_group == SKIP
+      @fee_type_id = fee_type_id unless fee_type_id == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @product_code = product_code unless product_code == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @product_group_id = product_group_id unless product_group_id == SKIP
+      @product_group_name = product_group_name unless product_group_name == SKIP
+      @total_quantity = total_quantity unless total_quantity == SKIP
+      @total_invoice_net_amount = total_invoice_net_amount unless total_invoice_net_amount == SKIP
+      unless total_invoice_gross_amount == SKIP
+        @total_invoice_gross_amount =
+          total_invoice_gross_amount
+      end
+      @total_invoice_vat_amount = total_invoice_vat_amount unless total_invoice_vat_amount == SKIP
+      @invoice_currency_code = invoice_currency_code unless invoice_currency_code == SKIP
+      @invoice_currency_symbol = invoice_currency_symbol unless invoice_currency_symbol == 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.
+      fee_type_group = hash.key?('FeeTypeGroup') ? hash['FeeTypeGroup'] : SKIP
+      fee_type_id = hash.key?('FeeTypeId') ? hash['FeeTypeId'] : SKIP
+      product_id = hash.key?('ProductId') ? hash['ProductId'] : SKIP
+      product_code = hash.key?('ProductCode') ? hash['ProductCode'] : SKIP
+      product_name = hash.key?('ProductName') ? hash['ProductName'] : SKIP
+      product_group_id =
+        hash.key?('ProductGroupId') ? hash['ProductGroupId'] : SKIP
+      product_group_name =
+        hash.key?('ProductGroupName') ? hash['ProductGroupName'] : SKIP
+      total_quantity = hash.key?('TotalQuantity') ? hash['TotalQuantity'] : SKIP
+      total_invoice_net_amount =
+        hash.key?('TotalInvoiceNetAmount') ? hash['TotalInvoiceNetAmount'] : SKIP
+      total_invoice_gross_amount =
+        hash.key?('TotalInvoiceGrossAmount') ? hash['TotalInvoiceGrossAmount'] : SKIP
+      total_invoice_vat_amount =
+        hash.key?('TotalInvoiceVATAmount') ? hash['TotalInvoiceVATAmount'] : SKIP
+      invoice_currency_code =
+        hash.key?('InvoiceCurrencyCode') ? hash['InvoiceCurrencyCode'] : SKIP
+      invoice_currency_symbol =
+        hash.key?('InvoiceCurrencySymbol') ? hash['InvoiceCurrencySymbol'] : SKIP
+
+      # Create object from extracted values.
+      FeeItemSummaryAllOf0.new(fee_type_group,
+                               fee_type_id,
+                               product_id,
+                               product_code,
+                               product_name,
+                               product_group_id,
+                               product_group_name,
+                               total_quantity,
+                               total_invoice_net_amount,
+                               total_invoice_gross_amount,
+                               total_invoice_vat_amount,
+                               invoice_currency_code,
+                               invoice_currency_symbol)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/fee_rule_location.rb

@@ -0,0 +1,153 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # FeeRuleLocation Model.
+  class FeeRuleLocation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Delco Identifier.
+    # @return [String]
+    attr_accessor :delco_id
+
+    # Country name.
+    # @return [String]
+    attr_accessor :country
+
+    # ISO Code of country.
+    # @return [String]
+    attr_accessor :country_code
+
+    # Fuel Network Identifier.
+    # @return [Integer]
+    attr_accessor :fuel_network_id
+
+    # Network Name.
+    # @return [String]
+    attr_accessor :network_name
+
+    # Site-Group ID
+    # @return [Integer]
+    attr_accessor :site_group_id
+
+    # Site-Group name.
+    # @return [String]
+    attr_accessor :site_group_name
+
+    # Site Code
+    # @return [Integer]
+    attr_accessor :site_code
+
+    # Site Identifier
+    # @return [Integer]
+    attr_accessor :site_id
+
+    # Site Name
+    # @return [String]
+    attr_accessor :site_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['delco_id'] = 'DelcoId'
+      @_hash['country'] = 'Country'
+      @_hash['country_code'] = 'CountryCode'
+      @_hash['fuel_network_id'] = 'FuelNetworkId'
+      @_hash['network_name'] = 'NetworkName'
+      @_hash['site_group_id'] = 'SiteGroupId'
+      @_hash['site_group_name'] = 'SiteGroupName'
+      @_hash['site_code'] = 'SiteCode'
+      @_hash['site_id'] = 'SiteId'
+      @_hash['site_name'] = 'SiteName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        delco_id
+        country
+        country_code
+        fuel_network_id
+        network_name
+        site_group_id
+        site_group_name
+        site_code
+        site_id
+        site_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        delco_id
+        country
+        country_code
+        fuel_network_id
+        network_name
+        site_group_id
+        site_group_name
+        site_code
+        site_id
+        site_name
+      ]
+    end
+
+    def initialize(delco_id = SKIP,
+                   country = SKIP,
+                   country_code = SKIP,
+                   fuel_network_id = SKIP,
+                   network_name = SKIP,
+                   site_group_id = SKIP,
+                   site_group_name = SKIP,
+                   site_code = SKIP,
+                   site_id = SKIP,
+                   site_name = SKIP)
+      @delco_id = delco_id unless delco_id == SKIP
+      @country = country unless country == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @fuel_network_id = fuel_network_id unless fuel_network_id == SKIP
+      @network_name = network_name unless network_name == SKIP
+      @site_group_id = site_group_id unless site_group_id == SKIP
+      @site_group_name = site_group_name unless site_group_name == SKIP
+      @site_code = site_code unless site_code == SKIP
+      @site_id = site_id unless site_id == SKIP
+      @site_name = site_name unless site_name == 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.
+      delco_id = hash.key?('DelcoId') ? hash['DelcoId'] : SKIP
+      country = hash.key?('Country') ? hash['Country'] : SKIP
+      country_code = hash.key?('CountryCode') ? hash['CountryCode'] : SKIP
+      fuel_network_id =
+        hash.key?('FuelNetworkId') ? hash['FuelNetworkId'] : SKIP
+      network_name = hash.key?('NetworkName') ? hash['NetworkName'] : SKIP
+      site_group_id = hash.key?('SiteGroupId') ? hash['SiteGroupId'] : SKIP
+      site_group_name =
+        hash.key?('SiteGroupName') ? hash['SiteGroupName'] : SKIP
+      site_code = hash.key?('SiteCode') ? hash['SiteCode'] : SKIP
+      site_id = hash.key?('SiteId') ? hash['SiteId'] : SKIP
+      site_name = hash.key?('SiteName') ? hash['SiteName'] : SKIP
+
+      # Create object from extracted values.
+      FeeRuleLocation.new(delco_id,
+                          country,
+                          country_code,
+                          fuel_network_id,
+                          network_name,
+                          site_group_id,
+                          site_group_name,
+                          site_code,
+                          site_id,
+                          site_name)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/fee_rule_product.rb

@@ -0,0 +1,98 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # FeeRuleProduct Model.
+  class FeeRuleProduct < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Product Group Id
+    # @return [Integer]
+    attr_accessor :product_group_id
+
+    # Product Group name
+    # @return [String]
+    attr_accessor :product_group_name
+
+    # Client Product Code
+    # @return [String]
+    attr_accessor :product_code
+
+    # Product Id
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # Product name in English
+    # @return [String]
+    attr_accessor :product_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_group_id'] = 'ProductGroupId'
+      @_hash['product_group_name'] = 'ProductGroupName'
+      @_hash['product_code'] = 'ProductCode'
+      @_hash['product_id'] = 'ProductId'
+      @_hash['product_name'] = 'ProductName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_group_id
+        product_group_name
+        product_code
+        product_id
+        product_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        product_group_id
+        product_group_name
+        product_code
+        product_id
+        product_name
+      ]
+    end
+
+    def initialize(product_group_id = SKIP,
+                   product_group_name = SKIP,
+                   product_code = SKIP,
+                   product_id = SKIP,
+                   product_name = SKIP)
+      @product_group_id = product_group_id unless product_group_id == SKIP
+      @product_group_name = product_group_name unless product_group_name == SKIP
+      @product_code = product_code unless product_code == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @product_name = product_name unless product_name == 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.
+      product_group_id =
+        hash.key?('ProductGroupId') ? hash['ProductGroupId'] : SKIP
+      product_group_name =
+        hash.key?('ProductGroupName') ? hash['ProductGroupName'] : SKIP
+      product_code = hash.key?('ProductCode') ? hash['ProductCode'] : SKIP
+      product_id = hash.key?('ProductId') ? hash['ProductId'] : SKIP
+      product_name = hash.key?('ProductName') ? hash['ProductName'] : SKIP
+
+      # Create object from extracted values.
+      FeeRuleProduct.new(product_group_id,
+                         product_group_name,
+                         product_code,
+                         product_id,
+                         product_name)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/fee_rule_tier.rb

@@ -0,0 +1,74 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # FeeRuleTier Model.
+  class FeeRuleTier < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Minimum consumption configured in the tier.
+    # @return [Integer]
+    attr_accessor :tier_minimum
+
+    # Bonus value for the tier.
+    # @return [Float]
+    attr_accessor :value
+
+    # Maximum consumption configured in the tier.
+    # @return [Integer]
+    attr_accessor :tier_maximum
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tier_minimum'] = 'TierMinimum'
+      @_hash['value'] = 'Value'
+      @_hash['tier_maximum'] = 'TierMaximum'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tier_minimum
+        value
+        tier_maximum
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        tier_minimum
+        value
+        tier_maximum
+      ]
+    end
+
+    def initialize(tier_minimum = SKIP,
+                   value = SKIP,
+                   tier_maximum = SKIP)
+      @tier_minimum = tier_minimum unless tier_minimum == SKIP
+      @value = value unless value == SKIP
+      @tier_maximum = tier_maximum unless tier_maximum == 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.
+      tier_minimum = hash.key?('TierMinimum') ? hash['TierMinimum'] : SKIP
+      value = hash.key?('Value') ? hash['Value'] : SKIP
+      tier_maximum = hash.key?('TierMaximum') ? hash['TierMaximum'] : SKIP
+
+      # Create object from extracted values.
+      FeeRuleTier.new(tier_minimum,
+                      value,
+                      tier_maximum)
+    end
+  end
+end

data/lib/shell_data_reporting_ap_is/models/fee_summary_response.rb

@@ -0,0 +1,85 @@
+# shell_data_reporting_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellDataReportingApIs
+  # FeeSummaryResponse Model.
+  class FeeSummaryResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[FeeItemSummaryAllOf0]]
+    attr_accessor :fee_items_summary
+
+    # A unique request id in GUID format. The value is written to the Shell API
+    # Platform audit log for end to end traceability of a request. If a value is
+    # not provided by an API client, then a GUID is automatically populated by
+    # the Shell API Platform and returned in the API response.
+    # @return [String]
+    attr_accessor :request_id
+
+    # A unique request id in GUID format. The value is written to the Shell API
+    # Platform audit log for end to end traceability of a request. If a value is
+    # not provided by an API client, then a GUID is automatically populated by
+    # the Shell API Platform and returned in the API response.
+    # @return [ErrorStatus]
+    attr_accessor :error
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fee_items_summary'] = 'FeeItemsSummary'
+      @_hash['request_id'] = 'RequestId'
+      @_hash['error'] = 'Error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fee_items_summary
+        request_id
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fee_items_summary = SKIP,
+                   request_id = SKIP,
+                   error = SKIP)
+      @fee_items_summary = fee_items_summary unless fee_items_summary == SKIP
+      @request_id = request_id unless request_id == SKIP
+      @error = error unless error == 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
+      fee_items_summary = nil
+      unless hash['FeeItemsSummary'].nil?
+        fee_items_summary = []
+        hash['FeeItemsSummary'].each do |structure|
+          fee_items_summary << (FeeItemSummaryAllOf0.from_hash(structure) if structure)
+        end
+      end
+
+      fee_items_summary = SKIP unless hash.key?('FeeItemsSummary')
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
+
+      # Create object from extracted values.
+      FeeSummaryResponse.new(fee_items_summary,
+                             request_id,
+                             error)
+    end
+  end
+end