loyalty-sdk 0.0.1

data/lib/loyalty_ap_is/models/redemption_response_item.rb

@@ -0,0 +1,111 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # RedemptionResponseItem Model.
+  class RedemptionResponseItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique Item ID for the transaction from the partner. Used to identify the
+    # catalogue item in the Shell Loyalty Platform. Each Partner will have one
+    # or more items set up in the Shell Loyalty Platform.
+    # @return [String]
+    attr_accessor :item_id
+
+    # The quantity of the items required.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # The number of points that will be redemmed from the Shell Loyalty
+    # Platform.
+    # @return [Integer]
+    attr_accessor :points
+
+    # The reason for the points redemption. This attribute will be shown in the
+    # Transaction History feture.
+    # @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[
+        item_id
+        quantity
+        points
+        reason_for_redemption
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(item_id: SKIP, quantity: SKIP, points: SKIP,
+                   reason_for_redemption: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @item_id = item_id unless item_id == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @points = points unless points == SKIP
+      @reason_for_redemption = reason_for_redemption unless reason_for_redemption == 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.
+      item_id = hash.key?('itemId') ? hash['itemId'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      points = hash.key?('points') ? hash['points'] : SKIP
+      reason_for_redemption =
+        hash.key?('reasonForRedemption') ? hash['reasonForRedemption'] : 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.
+      RedemptionResponseItem.new(item_id: item_id,
+                                 quantity: quantity,
+                                 points: points,
+                                 reason_for_redemption: reason_for_redemption,
+                                 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/refresh_token_request.rb

@@ -0,0 +1,75 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # RefreshTokenRequest Model.
+  class RefreshTokenRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The refresh token which was provided from the exchangeAccessCode end
+    # point.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['refresh_token'] = 'refreshToken'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(refresh_token:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @refresh_token = refresh_token
+      @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.
+      refresh_token = hash.key?('refreshToken') ? hash['refreshToken'] : nil
+
+      # 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.
+      RefreshTokenRequest.new(refresh_token: refresh_token,
+                              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} refresh_token: #{@refresh_token}, 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} refresh_token: #{@refresh_token.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/refresh_token_response.rb

@@ -0,0 +1,93 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # RefreshTokenResponse Model.
+  class RefreshTokenResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :access_token
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # Indicates the number of seconds until the new access token provided in the
+    # pair expires
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'accessToken'
+      @_hash['refresh_token'] = 'refreshToken'
+      @_hash['expires_in'] = 'expiresIn'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, refresh_token:, expires_in:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @access_token = access_token
+      @refresh_token = refresh_token
+      @expires_in = expires_in
+      @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.
+      access_token = hash.key?('accessToken') ? hash['accessToken'] : nil
+      refresh_token = hash.key?('refreshToken') ? hash['refreshToken'] : nil
+      expires_in = hash.key?('expiresIn') ? hash['expiresIn'] : nil
+
+      # 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.
+      RefreshTokenResponse.new(access_token: access_token,
+                               refresh_token: refresh_token,
+                               expires_in: expires_in,
+                               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} access_token: #{@access_token}, refresh_token: #{@refresh_token},"\
+      " expires_in: #{@expires_in}, 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} access_token: #{@access_token.inspect}, refresh_token:"\
+      " #{@refresh_token.inspect}, expires_in: #{@expires_in.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/sale_item.rb

@@ -0,0 +1,262 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # SaleItem Model.
+  class SaleItem < 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 excluding VAT
+    # @return [Float]
+    attr_accessor :original_net_amount
+
+    # Original amount excluding VAT
+    # @return [SaleItemProduct]
+    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
+
+    # VAT rate of sales line
+    # @return [Array[VoucherItem]]
+    attr_accessor :voucher_items
+
+    # List of vouchers
+    # @return [Array[String]]
+    attr_accessor :vouchers
+
+    # Unit price of sale item
+    # @return [Float]
+    attr_accessor :unit_price
+
+    # Unit of measure
+    # @return [UnitMeasure]
+    attr_accessor :unit_measure
+
+    # Unit of measure
+    # @return [EvChargingDetails]
+    attr_accessor :ev
+
+    # Points earned in a transaction
+    # @return [Integer]
+    attr_accessor :points
+
+    # 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['original_net_amount'] = 'originalNetAmount'
+      @_hash['product_data'] = 'productData'
+      @_hash['quantity'] = 'quantity'
+      @_hash['vat_amount'] = 'vatAmount'
+      @_hash['vat_rate'] = 'vatRate'
+      @_hash['voucher_items'] = 'voucherItems'
+      @_hash['vouchers'] = 'vouchers'
+      @_hash['unit_price'] = 'unitPrice'
+      @_hash['unit_measure'] = 'unitMeasure'
+      @_hash['ev'] = 'EV'
+      @_hash['points'] = 'points'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        offer_lang
+        original_net_amount
+        vat_amount
+        vat_rate
+        voucher_items
+        vouchers
+        unit_price
+        unit_measure
+        ev
+        points
+      ]
+    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,
+                   original_net_amount: SKIP, vat_amount: SKIP, vat_rate: SKIP,
+                   voucher_items: SKIP, vouchers: SKIP, unit_price: SKIP,
+                   unit_measure: SKIP, ev: SKIP, points: 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
+      @original_net_amount = original_net_amount unless original_net_amount == SKIP
+      @product_data = product_data
+      @quantity = quantity
+      @vat_amount = vat_amount unless vat_amount == SKIP
+      @vat_rate = vat_rate unless vat_rate == SKIP
+      @voucher_items = voucher_items unless voucher_items == SKIP
+      @vouchers = vouchers unless vouchers == SKIP
+      @unit_price = unit_price unless unit_price == SKIP
+      @unit_measure = unit_measure unless unit_measure == SKIP
+      @ev = ev unless ev == SKIP
+      @points = points unless points == 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 = SaleItemProduct.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']
+      original_net_amount =
+        hash.key?('originalNetAmount') ? hash['originalNetAmount'] : SKIP
+      vat_amount = hash.key?('vatAmount') ? hash['vatAmount'] : SKIP
+      vat_rate = hash.key?('vatRate') ? hash['vatRate'] : 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')
+      vouchers = hash.key?('vouchers') ? hash['vouchers'] : SKIP
+      unit_price = hash.key?('unitPrice') ? hash['unitPrice'] : SKIP
+      unit_measure = hash.key?('unitMeasure') ? hash['unitMeasure'] : SKIP
+      ev = EvChargingDetails.from_hash(hash['EV']) if hash['EV']
+      points = hash.key?('points') ? hash['points'] : 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.
+      SaleItem.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,
+                   original_net_amount: original_net_amount,
+                   vat_amount: vat_amount,
+                   vat_rate: vat_rate,
+                   voucher_items: voucher_items,
+                   vouchers: vouchers,
+                   unit_price: unit_price,
+                   unit_measure: unit_measure,
+                   ev: ev,
+                   points: points,
+                   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}, original_net_amount:"\
+      " #{@original_net_amount}, product_data: #{@product_data}, quantity: #{@quantity},"\
+      " vat_amount: #{@vat_amount}, vat_rate: #{@vat_rate}, voucher_items: #{@voucher_items},"\
+      " vouchers: #{@vouchers}, unit_price: #{@unit_price}, unit_measure: #{@unit_measure}, ev:"\
+      " #{@ev}, points: #{@points}, 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}, original_net_amount: #{@original_net_amount.inspect},"\
+      " product_data: #{@product_data.inspect}, quantity: #{@quantity.inspect}, vat_amount:"\
+      " #{@vat_amount.inspect}, vat_rate: #{@vat_rate.inspect}, voucher_items:"\
+      " #{@voucher_items.inspect}, vouchers: #{@vouchers.inspect}, unit_price:"\
+      " #{@unit_price.inspect}, unit_measure: #{@unit_measure.inspect}, ev: #{@ev.inspect},"\
+      " points: #{@points.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/sale_item_product.rb

@@ -0,0 +1,135 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # SaleItemProduct Model.
+  class SaleItemProduct < 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
+
+    # 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
+
+    # Customer name of the product provided by the partner
+    # @return [String]
+    attr_accessor :additional_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['product_code'] = 'productCode'
+      @_hash['product_description'] = 'productDescription'
+      @_hash['additional_product_description'] =
+        'additionalProductDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_code
+        product_description
+        additional_product_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, name:, product_type:, product_code: SKIP,
+                   product_description: SKIP,
+                   additional_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
+      @product_code = product_code unless product_code == SKIP
+      @product_description = product_description unless product_description == SKIP
+      unless additional_product_description == SKIP
+        @additional_product_description =
+          additional_product_description
+      end
+      @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
+      product_code = hash.key?('productCode') ? hash['productCode'] : SKIP
+      product_description =
+        hash.key?('productDescription') ? hash['productDescription'] : SKIP
+      additional_product_description =
+        hash.key?('additionalProductDescription') ? hash['additionalProductDescription'] : 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.
+      SaleItemProduct.new(id: id,
+                          name: name,
+                          product_type: product_type,
+                          product_code: product_code,
+                          product_description: product_description,
+                          additional_product_description: additional_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}, product_code:"\
+      " #{@product_code}, product_description: #{@product_description},"\
+      " additional_product_description: #{@additional_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}, product_code: #{@product_code.inspect}, product_description:"\
+      " #{@product_description.inspect}, additional_product_description:"\
+      " #{@additional_product_description.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end