loyalty-sdk 0.0.1

data/lib/loyalty_ap_is/models/offer_base.rb

@@ -0,0 +1,101 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # OfferBase Model.
+  class OfferBase < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Offer ID provided upon offer configuration
+    # @return [Integer]
+    attr_accessor :offer_id
+
+    # Unique Reference ID for the transaction from the partner. Used to identify
+    # duplicate requests.
+    # @return [String]
+    attr_accessor :reference_id
+
+    # Title of the partner's offer, given upon configuration
+    # @return [String]
+    attr_accessor :title
+
+    # Description of the partner's offer, set up upon offer configuration
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['offer_id'] = 'offerId'
+      @_hash['reference_id'] = 'referenceId'
+      @_hash['title'] = 'title'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(offer_id:, reference_id:, title:, description:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @offer_id = offer_id
+      @reference_id = reference_id
+      @title = title
+      @description = description
+      @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.
+      offer_id = hash.key?('offerId') ? hash['offerId'] : nil
+      reference_id = hash.key?('referenceId') ? hash['referenceId'] : nil
+      title = hash.key?('title') ? hash['title'] : nil
+      description = hash.key?('description') ? hash['description'] : 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.
+      OfferBase.new(offer_id: offer_id,
+                    reference_id: reference_id,
+                    title: title,
+                    description: 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} offer_id: #{@offer_id}, reference_id: #{@reference_id}, title: #{@title},"\
+      " description: #{@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} offer_id: #{@offer_id.inspect}, reference_id: #{@reference_id.inspect},"\
+      " title: #{@title.inspect}, description: #{@description.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/offer_info.rb

@@ -0,0 +1,156 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # OfferInfo Model.
+  class OfferInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discount value of the offer
+    # @return [Float]
+    attr_accessor :discount_value
+
+    # Total amount of points awarded for the given product code.
+    # @return [Integer]
+    attr_accessor :loyalty_offer_amount
+
+    # Unique ID of the voucher/coupon.
+    # @return [String]
+    attr_accessor :loyalty_offer_code
+
+    # Name of loyalty offer
+    # @return [String]
+    attr_accessor :loyalty_offer_description
+
+    # Loyalty Offer ID
+    # @return [String]
+    attr_accessor :loyalty_offer_id
+
+    # Loyalty offer type
+    # @return [String]
+    attr_accessor :loyalty_offer_type
+
+    # Loyalty Scheme code
+    # @return [String]
+    attr_accessor :loyalty_scheme_code
+
+    # Offer/reward name
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['discount_value'] = 'discountValue'
+      @_hash['loyalty_offer_amount'] = 'loyaltyOfferAmount'
+      @_hash['loyalty_offer_code'] = 'loyaltyOfferCode'
+      @_hash['loyalty_offer_description'] = 'loyaltyOfferDescription'
+      @_hash['loyalty_offer_id'] = 'loyaltyOfferID'
+      @_hash['loyalty_offer_type'] = 'loyaltyOfferType'
+      @_hash['loyalty_scheme_code'] = 'loyaltySchemeCode'
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        loyalty_offer_amount
+        loyalty_offer_code
+        loyalty_offer_description
+        loyalty_offer_type
+        loyalty_scheme_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(discount_value:, loyalty_offer_id:, reason:,
+                   loyalty_offer_amount: SKIP, loyalty_offer_code: SKIP,
+                   loyalty_offer_description: SKIP, loyalty_offer_type: SKIP,
+                   loyalty_scheme_code: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @discount_value = discount_value
+      @loyalty_offer_amount = loyalty_offer_amount unless loyalty_offer_amount == SKIP
+      @loyalty_offer_code = loyalty_offer_code unless loyalty_offer_code == SKIP
+      unless loyalty_offer_description == SKIP
+        @loyalty_offer_description =
+          loyalty_offer_description
+      end
+      @loyalty_offer_id = loyalty_offer_id
+      @loyalty_offer_type = loyalty_offer_type unless loyalty_offer_type == SKIP
+      @loyalty_scheme_code = loyalty_scheme_code unless loyalty_scheme_code == SKIP
+      @reason = reason
+      @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.
+      discount_value = hash.key?('discountValue') ? hash['discountValue'] : nil
+      loyalty_offer_id =
+        hash.key?('loyaltyOfferID') ? hash['loyaltyOfferID'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : nil
+      loyalty_offer_amount =
+        hash.key?('loyaltyOfferAmount') ? hash['loyaltyOfferAmount'] : SKIP
+      loyalty_offer_code =
+        hash.key?('loyaltyOfferCode') ? hash['loyaltyOfferCode'] : SKIP
+      loyalty_offer_description =
+        hash.key?('loyaltyOfferDescription') ? hash['loyaltyOfferDescription'] : SKIP
+      loyalty_offer_type =
+        hash.key?('loyaltyOfferType') ? hash['loyaltyOfferType'] : SKIP
+      loyalty_scheme_code =
+        hash.key?('loyaltySchemeCode') ? hash['loyaltySchemeCode'] : 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.
+      OfferInfo.new(discount_value: discount_value,
+                    loyalty_offer_id: loyalty_offer_id,
+                    reason: reason,
+                    loyalty_offer_amount: loyalty_offer_amount,
+                    loyalty_offer_code: loyalty_offer_code,
+                    loyalty_offer_description: loyalty_offer_description,
+                    loyalty_offer_type: loyalty_offer_type,
+                    loyalty_scheme_code: loyalty_scheme_code,
+                    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} discount_value: #{@discount_value}, loyalty_offer_amount:"\
+      " #{@loyalty_offer_amount}, loyalty_offer_code: #{@loyalty_offer_code},"\
+      " loyalty_offer_description: #{@loyalty_offer_description}, loyalty_offer_id:"\
+      " #{@loyalty_offer_id}, loyalty_offer_type: #{@loyalty_offer_type}, loyalty_scheme_code:"\
+      " #{@loyalty_scheme_code}, reason: #{@reason}, 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} discount_value: #{@discount_value.inspect}, loyalty_offer_amount:"\
+      " #{@loyalty_offer_amount.inspect}, loyalty_offer_code: #{@loyalty_offer_code.inspect},"\
+      " loyalty_offer_description: #{@loyalty_offer_description.inspect}, loyalty_offer_id:"\
+      " #{@loyalty_offer_id.inspect}, loyalty_offer_type: #{@loyalty_offer_type.inspect},"\
+      " loyalty_scheme_code: #{@loyalty_scheme_code.inspect}, reason: #{@reason.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/offer_language.rb

@@ -0,0 +1,100 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # OfferLanguage Model.
+  class OfferLanguage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique Id of the offer
+    # @return [String]
+    attr_accessor :id
+
+    # Title of the offer
+    # @return [String]
+    attr_accessor :title
+
+    # Description of the offer
+    # @return [String]
+    attr_accessor :description
+
+    # Custom text of the offer
+    # @return [String]
+    attr_accessor :custom_text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['title'] = 'title'
+      @_hash['description'] = 'description'
+      @_hash['custom_text'] = 'customText'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, title:, description:, custom_text:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @title = title
+      @description = description
+      @custom_text = custom_text
+      @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
+      title = hash.key?('title') ? hash['title'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      custom_text = hash.key?('customText') ? hash['customText'] : 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.
+      OfferLanguage.new(id: id,
+                        title: title,
+                        description: description,
+                        custom_text: custom_text,
+                        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}, title: #{@title}, description: #{@description}, custom_text:"\
+      " #{@custom_text}, 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}, title: #{@title.inspect}, description:"\
+      " #{@description.inspect}, custom_text: #{@custom_text.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/points_to_cash.rb

@@ -0,0 +1,99 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # PointsToCash Model.
+  class PointsToCash < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The points used for converting it to cash
+    # @return [Float]
+    attr_accessor :points_redeemed
+
+    # Total amount in cash used
+    # @return [Float]
+    attr_accessor :total_amount
+
+    # Indication if the p2c was used as a method of payment
+    # @return [TrueClass | FalseClass]
+    attr_accessor :points_to_cash_mop
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['points_redeemed'] = 'pointsRedeemed'
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['points_to_cash_mop'] = 'pointsToCashMOP'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        points_redeemed
+        total_amount
+        points_to_cash_mop
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(points_redeemed: SKIP, total_amount: SKIP,
+                   points_to_cash_mop: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @points_redeemed = points_redeemed unless points_redeemed == SKIP
+      @total_amount = total_amount unless total_amount == SKIP
+      @points_to_cash_mop = points_to_cash_mop unless points_to_cash_mop == 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.
+      points_redeemed =
+        hash.key?('pointsRedeemed') ? hash['pointsRedeemed'] : SKIP
+      total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : SKIP
+      points_to_cash_mop =
+        hash.key?('pointsToCashMOP') ? hash['pointsToCashMOP'] : 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.
+      PointsToCash.new(points_redeemed: points_redeemed,
+                       total_amount: total_amount,
+                       points_to_cash_mop: points_to_cash_mop,
+                       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} points_redeemed: #{@points_redeemed}, total_amount: #{@total_amount},"\
+      " points_to_cash_mop: #{@points_to_cash_mop}, 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} points_redeemed: #{@points_redeemed.inspect}, total_amount:"\
+      " #{@total_amount.inspect}, points_to_cash_mop: #{@points_to_cash_mop.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/product_type.rb

@@ -0,0 +1,53 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Indicating the Type of the product (Fuel, CR, CC, PARTNER, OTHER,
+  # GREEN_ENERGY).
+  class ProductType
+    PRODUCT_TYPE = [
+      # TODO: Write general description for FUEL
+      FUEL = 'FUEL'.freeze,
+
+      # TODO: Write general description for CR
+      CR = 'CR'.freeze,
+
+      # TODO: Write general description for CC
+      CC = 'CC'.freeze,
+
+      # TODO: Write general description for PARTNER
+      PARTNER = 'PARTNER'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for GREEN_ENERGY
+      GREEN_ENERGY = 'GREEN_ENERGY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PRODUCT_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = FUEL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fuel' then FUEL
+      when 'cr' then CR
+      when 'cc' then CC
+      when 'partner' then PARTNER
+      when 'other' then OTHER
+      when 'green_energy' then GREEN_ENERGY
+      else
+        default_value
+      end
+    end
+  end
+end