loyalty-sdk 0.0.1

data/lib/loyalty_ap_is/models/redeemed_item.rb

@@ -0,0 +1,221 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # RedeemedItem Model.
+  class RedeemedItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Description - currently not in use
+    # @return [String]
+    attr_accessor :description
+
+    # Total amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Indicates the Type of the transaction detail row (award, redemption,
+    # transfer, voucher, refund or central award).
+    # @return [TransactionDetailType]
+    attr_accessor :detail_type
+
+    # Discount amount of sales line
+    # @return [Float]
+    attr_accessor :discount_amount
+
+    # Discount amount of sales line
+    # @return [Array[OfferInfo]]
+    attr_accessor :offer_infos
+
+    # Discount amount of sales line
+    # @return [OfferLanguage]
+    attr_accessor :offer_lang
+
+    # Original amount of sales line
+    # @return [Float]
+    attr_accessor :original_amount
+
+    # Original amount of sales line
+    # @return [RedeemedItemProduct]
+    attr_accessor :product_data
+
+    # Quantity of product
+    # @return [Float]
+    attr_accessor :quantity
+
+    # Value added tax
+    # @return [Float]
+    attr_accessor :vat_amount
+
+    # VAT rate of sales line
+    # @return [Float]
+    attr_accessor :vat_rate
+
+    # Number of points redeemed. Applicable for redeemedItems and not for
+    # saleItems
+    # @return [Integer]
+    attr_accessor :points
+
+    # List of vouchers
+    # @return [Array[String]]
+    attr_accessor :vouchers
+
+    # List of vouchers
+    # @return [Array[VoucherItem]]
+    attr_accessor :voucher_items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['amount'] = 'amount'
+      @_hash['detail_type'] = 'detailType'
+      @_hash['discount_amount'] = 'discountAmount'
+      @_hash['offer_infos'] = 'offerInfos'
+      @_hash['offer_lang'] = 'offerLang'
+      @_hash['original_amount'] = 'originalAmount'
+      @_hash['product_data'] = 'productData'
+      @_hash['quantity'] = 'quantity'
+      @_hash['vat_amount'] = 'vatAmount'
+      @_hash['vat_rate'] = 'vatRate'
+      @_hash['points'] = 'points'
+      @_hash['vouchers'] = 'vouchers'
+      @_hash['voucher_items'] = 'voucherItems'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        offer_lang
+        vat_amount
+        vat_rate
+        points
+        vouchers
+        voucher_items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, detail_type:, discount_amount:, offer_infos:,
+                   original_amount:, product_data:, quantity:,
+                   description: SKIP, offer_lang: SKIP, vat_amount: SKIP,
+                   vat_rate: SKIP, points: SKIP, vouchers: SKIP,
+                   voucher_items: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @description = description unless description == SKIP
+      @amount = amount
+      @detail_type = detail_type
+      @discount_amount = discount_amount
+      @offer_infos = offer_infos
+      @offer_lang = offer_lang unless offer_lang == SKIP
+      @original_amount = original_amount
+      @product_data = product_data
+      @quantity = quantity
+      @vat_amount = vat_amount unless vat_amount == SKIP
+      @vat_rate = vat_rate unless vat_rate == SKIP
+      @points = points unless points == SKIP
+      @vouchers = vouchers unless vouchers == SKIP
+      @voucher_items = voucher_items unless voucher_items == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      detail_type = hash.key?('detailType') ? hash['detailType'] : nil
+      discount_amount =
+        hash.key?('discountAmount') ? hash['discountAmount'] : nil
+      # Parameter is an array, so we need to iterate through it
+      offer_infos = nil
+      unless hash['offerInfos'].nil?
+        offer_infos = []
+        hash['offerInfos'].each do |structure|
+          offer_infos << (OfferInfo.from_hash(structure) if structure)
+        end
+      end
+
+      offer_infos = nil unless hash.key?('offerInfos')
+      original_amount =
+        hash.key?('originalAmount') ? hash['originalAmount'] : nil
+      product_data = RedeemedItemProduct.from_hash(hash['productData']) if hash['productData']
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      offer_lang = OfferLanguage.from_hash(hash['offerLang']) if hash['offerLang']
+      vat_amount = hash.key?('vatAmount') ? hash['vatAmount'] : SKIP
+      vat_rate = hash.key?('vatRate') ? hash['vatRate'] : SKIP
+      points = hash.key?('points') ? hash['points'] : SKIP
+      vouchers = hash.key?('vouchers') ? hash['vouchers'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      voucher_items = nil
+      unless hash['voucherItems'].nil?
+        voucher_items = []
+        hash['voucherItems'].each do |structure|
+          voucher_items << (VoucherItem.from_hash(structure) if structure)
+        end
+      end
+
+      voucher_items = SKIP unless hash.key?('voucherItems')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      RedeemedItem.new(amount: amount,
+                       detail_type: detail_type,
+                       discount_amount: discount_amount,
+                       offer_infos: offer_infos,
+                       original_amount: original_amount,
+                       product_data: product_data,
+                       quantity: quantity,
+                       description: description,
+                       offer_lang: offer_lang,
+                       vat_amount: vat_amount,
+                       vat_rate: vat_rate,
+                       points: points,
+                       vouchers: vouchers,
+                       voucher_items: voucher_items,
+                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description}, amount: #{@amount}, detail_type:"\
+      " #{@detail_type}, discount_amount: #{@discount_amount}, offer_infos: #{@offer_infos},"\
+      " offer_lang: #{@offer_lang}, original_amount: #{@original_amount}, product_data:"\
+      " #{@product_data}, quantity: #{@quantity}, vat_amount: #{@vat_amount}, vat_rate:"\
+      " #{@vat_rate}, points: #{@points}, vouchers: #{@vouchers}, voucher_items:"\
+      " #{@voucher_items}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description.inspect}, amount: #{@amount.inspect},"\
+      " detail_type: #{@detail_type.inspect}, discount_amount: #{@discount_amount.inspect},"\
+      " offer_infos: #{@offer_infos.inspect}, offer_lang: #{@offer_lang.inspect}, original_amount:"\
+      " #{@original_amount.inspect}, product_data: #{@product_data.inspect}, quantity:"\
+      " #{@quantity.inspect}, vat_amount: #{@vat_amount.inspect}, vat_rate: #{@vat_rate.inspect},"\
+      " points: #{@points.inspect}, vouchers: #{@vouchers.inspect}, voucher_items:"\
+      " #{@voucher_items.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/redeemed_item_product.rb

@@ -0,0 +1,131 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # RedeemedItemProduct Model.
+  class RedeemedItemProduct < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique Id of the product
+    # @return [String]
+    attr_accessor :id
+
+    # Name of the product
+    # @return [String]
+    attr_accessor :name
+
+    # Indicating the Type of the product (Fuel, CR, CC, PARTNER, OTHER,
+    # GREEN_ENERGY).
+    # @return [ProductType]
+    attr_accessor :product_type
+
+    # Reason for redemption of points as mentioned by the partner.
+    # reasonForRedemption to be populated only for redeemedItems (not for
+    # saleItems) when productType = PARTNER.
+    # @return [String]
+    attr_accessor :reason_for_redemption
+
+    # Product code of gift item (euroShell Forward Code). To be populated with 3
+    # digit Euroshell product code.
+    # @return [String]
+    attr_accessor :product_code
+
+    # Product code of gift item (euroShell Forward Code). To be populated with 3
+    # digit Euroshell product code.
+    # @return [String]
+    attr_accessor :product_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['product_type'] = 'productType'
+      @_hash['reason_for_redemption'] = 'reasonForRedemption'
+      @_hash['product_code'] = 'productCode'
+      @_hash['product_description'] = 'productDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason_for_redemption
+        product_code
+        product_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, name:, product_type:, reason_for_redemption: SKIP,
+                   product_code: SKIP, product_description: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @name = name
+      @product_type = product_type
+      @reason_for_redemption = reason_for_redemption unless reason_for_redemption == SKIP
+      @product_code = product_code unless product_code == SKIP
+      @product_description = product_description unless product_description == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      product_type = hash.key?('productType') ? hash['productType'] : nil
+      reason_for_redemption =
+        hash.key?('reasonForRedemption') ? hash['reasonForRedemption'] : SKIP
+      product_code = hash.key?('productCode') ? hash['productCode'] : SKIP
+      product_description =
+        hash.key?('productDescription') ? hash['productDescription'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      RedeemedItemProduct.new(id: id,
+                              name: name,
+                              product_type: product_type,
+                              reason_for_redemption: reason_for_redemption,
+                              product_code: product_code,
+                              product_description: product_description,
+                              additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, name: #{@name}, product_type: #{@product_type},"\
+      " reason_for_redemption: #{@reason_for_redemption}, product_code: #{@product_code},"\
+      " product_description: #{@product_description}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, name: #{@name.inspect}, product_type:"\
+      " #{@product_type.inspect}, reason_for_redemption: #{@reason_for_redemption.inspect},"\
+      " product_code: #{@product_code.inspect}, product_description:"\
+      " #{@product_description.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/redemption_item.rb

@@ -0,0 +1,109 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # RedemptionItem Model.
+  class RedemptionItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The itemID identifies the catalogue item in the loyalty system. Shell will
+    # set these up and share the IDs with the partner.
+    # @return [String]
+    attr_accessor :item_id
+
+    # Number of items redeemed on the user's behalf. If the quantity is not
+    # specified, the system will assume a default quantity of 1. This is not
+    # used for the calculation of points, but only for displaying to the user.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # Total number of points to be redeemed from the Shell Loyalty Platform for
+    # this item.
+    # @return [Integer]
+    attr_accessor :points
+
+    # Reason for the points redemption. This attribute will be shown to the
+    # customer via app/web channel under Transaction History.
+    # @return [String]
+    attr_accessor :reason_for_redemption
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['item_id'] = 'itemId'
+      @_hash['quantity'] = 'quantity'
+      @_hash['points'] = 'points'
+      @_hash['reason_for_redemption'] = 'reasonForRedemption'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        quantity
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(item_id:, points:, reason_for_redemption:, quantity: 1,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @item_id = item_id
+      @quantity = quantity unless quantity == SKIP
+      @points = points
+      @reason_for_redemption = reason_for_redemption
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      item_id = hash.key?('itemId') ? hash['itemId'] : nil
+      points = hash.key?('points') ? hash['points'] : nil
+      reason_for_redemption =
+        hash.key?('reasonForRedemption') ? hash['reasonForRedemption'] : nil
+      quantity = hash['quantity'] ||= 1
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      RedemptionItem.new(item_id: item_id,
+                         points: points,
+                         reason_for_redemption: reason_for_redemption,
+                         quantity: quantity,
+                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_id: #{@item_id}, quantity: #{@quantity}, points: #{@points},"\
+      " reason_for_redemption: #{@reason_for_redemption}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_id: #{@item_id.inspect}, quantity: #{@quantity.inspect}, points:"\
+      " #{@points.inspect}, reason_for_redemption: #{@reason_for_redemption.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/redemption_request.rb

@@ -0,0 +1,107 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # RedemptionRequest Model.
+  class RedemptionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The SSO uuid of the user signed in with Shell credentials.
+    # Format: 32 hexadecimal digits grouped the following way:
+    # xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+    # See: https://www.wikiwand.com/en/Universally_unique_identifier#/Format
+    # @return [UUID | String]
+    attr_accessor :uuid
+
+    # A unique ID for the transaction from the partner. Used to identify
+    # duplicate requests.
+    # @return [String]
+    attr_accessor :reference_id
+
+    # Specifies the number of points to be redeemed from the user's point
+    # balance and the reason for redemption, which will also be shown to the
+    # user. Mutiple redemption items can be submitted in a single API request.
+    # @return [Array[RedemptionItem]]
+    attr_accessor :redemption_req_array
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uuid'] = 'uuid'
+      @_hash['reference_id'] = 'referenceId'
+      @_hash['redemption_req_array'] = 'redemptionReqArray'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uuid:, reference_id:, redemption_req_array:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @uuid = uuid
+      @reference_id = reference_id
+      @redemption_req_array = redemption_req_array
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      uuid = hash.key?('uuid') ? hash['uuid'] : nil
+      reference_id = hash.key?('referenceId') ? hash['referenceId'] : nil
+      # Parameter is an array, so we need to iterate through it
+      redemption_req_array = nil
+      unless hash['redemptionReqArray'].nil?
+        redemption_req_array = []
+        hash['redemptionReqArray'].each do |structure|
+          redemption_req_array << (RedemptionItem.from_hash(structure) if structure)
+        end
+      end
+
+      redemption_req_array = nil unless hash.key?('redemptionReqArray')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      RedemptionRequest.new(uuid: uuid,
+                            reference_id: reference_id,
+                            redemption_req_array: redemption_req_array,
+                            additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} uuid: #{@uuid}, reference_id: #{@reference_id}, redemption_req_array:"\
+      " #{@redemption_req_array}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} uuid: #{@uuid.inspect}, reference_id: #{@reference_id.inspect},"\
+      " redemption_req_array: #{@redemption_req_array.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/redemption_response.rb

@@ -0,0 +1,118 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # RedemptionResponse Model.
+  class RedemptionResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique Reference ID for the transaction, generated by the partner.
+    # @return [String]
+    attr_accessor :reference_id
+
+    # The time and date of the redemption transaction.
+    # @return [String]
+    attr_accessor :transaction_date_time
+
+    # The user's current loyalty point balance after the requested items have
+    # been redeemed.
+    # @return [String]
+    attr_accessor :updated_point_balance
+
+    # This array requests the points to be redeemed from the users point balance
+    # for the items requested. The same information will be shown to the user.
+    # Multiple items can be redeemed in a single API request.
+    # @return [Array[RedemptionResponseItem]]
+    attr_accessor :redemption_req_array
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reference_id'] = 'referenceId'
+      @_hash['transaction_date_time'] = 'transactionDateTime'
+      @_hash['updated_point_balance'] = 'updatedPointBalance'
+      @_hash['redemption_req_array'] = 'redemptionReqArray'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reference_id:, transaction_date_time:,
+                   updated_point_balance:, redemption_req_array:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @reference_id = reference_id
+      @transaction_date_time = transaction_date_time
+      @updated_point_balance = updated_point_balance
+      @redemption_req_array = redemption_req_array
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reference_id = hash.key?('referenceId') ? hash['referenceId'] : nil
+      transaction_date_time =
+        hash.key?('transactionDateTime') ? hash['transactionDateTime'] : nil
+      updated_point_balance =
+        hash.key?('updatedPointBalance') ? hash['updatedPointBalance'] : nil
+      # Parameter is an array, so we need to iterate through it
+      redemption_req_array = nil
+      unless hash['redemptionReqArray'].nil?
+        redemption_req_array = []
+        hash['redemptionReqArray'].each do |structure|
+          redemption_req_array << (RedemptionResponseItem.from_hash(structure) if structure)
+        end
+      end
+
+      redemption_req_array = nil unless hash.key?('redemptionReqArray')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      RedemptionResponse.new(reference_id: reference_id,
+                             transaction_date_time: transaction_date_time,
+                             updated_point_balance: updated_point_balance,
+                             redemption_req_array: redemption_req_array,
+                             additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reference_id: #{@reference_id}, transaction_date_time:"\
+      " #{@transaction_date_time}, updated_point_balance: #{@updated_point_balance},"\
+      " redemption_req_array: #{@redemption_req_array}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reference_id: #{@reference_id.inspect}, transaction_date_time:"\
+      " #{@transaction_date_time.inspect}, updated_point_balance:"\
+      " #{@updated_point_balance.inspect}, redemption_req_array: #{@redemption_req_array.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end