ifeelgoods 0.0.1

data/lib/ifeelgoods/models/create_redemption_request_data_value.rb

@@ -0,0 +1,148 @@
+=begin
+#Fulfillment API
+
+#Public API exposed to ifeelgoods customers.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Ifeelgoods
+  class CreateRedemptionRequestDataValue < ApiModelBase
+    # optional - only needed for \"free value\" rewards
+    attr_accessor :amount
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'amount' => :'amount'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'amount' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Ifeelgoods::CreateRedemptionRequestDataValue` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Ifeelgoods::CreateRedemptionRequestDataValue`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          amount == o.amount
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [amount].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/ifeelgoods/models/dimension.rb

@@ -0,0 +1,293 @@
+=begin
+#Fulfillment API
+
+#Public API exposed to ifeelgoods customers.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Ifeelgoods
+  # Additional structured attributes associated with a reward. Each key represents a dimension label and its value is the dimension value for that reward. Not all dimensions are present on every reward — only the ones configured for that specific product will appear.
+  class Dimension < ApiModelBase
+    # Indicates the range of values that can be used with open value reward (when free_value is true) (eg. 5..250).
+    attr_accessor :available_denominations_range
+
+    # When a custom offer has been configured for this product (eg. buy one get one, $20 off the second article, etc.).
+    attr_accessor :custom_offer
+
+    # Duration during which the reward code remains valid after delivery. Expressed as a number followed by a unit: d for days, m for months, y for years (eg. 30d for 30 days, 12m for 12 months, 1y for 1 year). Returns null if no validity period applies.
+    attr_accessor :validity_period
+
+    # List of specific monetary amounts available for this reward.
+    attr_accessor :available_denominations
+
+    # Indicates whether the reward code can be broken into smaller values.
+    attr_accessor :breakable
+
+    # Indicates whether multiple reward codes can be combined.
+    attr_accessor :cumulable
+
+    attr_accessor :denomination
+
+    # Currency of the denomination amount (eg. EUR, USD, etc.).
+    attr_accessor :denomination_currency
+
+    # Duration of a subscription or service (eg. 2 months).
+    attr_accessor :duration
+
+    # Unit of the duration dimension. Possible values: minute, hour, day, week, month, year, varying_duration.
+    attr_accessor :duration_unit
+
+    # Number of people concerned by the reward.
+    attr_accessor :people
+
+    # Virtual currency amount associated with the reward (eg. 300 points, 200 miles, etc.).
+    attr_accessor :quantity
+
+    # Unit of the quantity dimension. Possible values: points, miles, facebook_credits, minutes, movie, meal, e_magazine, e_ticket, song, lesson, box, subscription.
+    attr_accessor :quantity_unit
+
+    attr_accessor :redemption_channel
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'available_denominations_range' => :'available_denominations_range',
+        :'custom_offer' => :'custom_offer',
+        :'validity_period' => :'validity_period',
+        :'available_denominations' => :'available_denominations',
+        :'breakable' => :'breakable',
+        :'cumulable' => :'cumulable',
+        :'denomination' => :'denomination',
+        :'denomination_currency' => :'denomination_currency',
+        :'duration' => :'duration',
+        :'duration_unit' => :'duration_unit',
+        :'people' => :'people',
+        :'quantity' => :'quantity',
+        :'quantity_unit' => :'quantity_unit',
+        :'redemption_channel' => :'redemption_channel'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'available_denominations_range' => :'String',
+        :'custom_offer' => :'String',
+        :'validity_period' => :'String',
+        :'available_denominations' => :'String',
+        :'breakable' => :'String',
+        :'cumulable' => :'String',
+        :'denomination' => :'DimensionDenomination',
+        :'denomination_currency' => :'String',
+        :'duration' => :'String',
+        :'duration_unit' => :'String',
+        :'people' => :'String',
+        :'quantity' => :'String',
+        :'quantity_unit' => :'String',
+        :'redemption_channel' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'available_denominations_range',
+        :'custom_offer',
+        :'validity_period',
+        :'available_denominations',
+        :'breakable',
+        :'cumulable',
+        :'denomination',
+        :'denomination_currency',
+        :'duration',
+        :'duration_unit',
+        :'people',
+        :'quantity',
+        :'quantity_unit',
+        :'redemption_channel'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Ifeelgoods::Dimension` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Ifeelgoods::Dimension`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'available_denominations_range')
+        self.available_denominations_range = attributes[:'available_denominations_range']
+      end
+
+      if attributes.key?(:'custom_offer')
+        self.custom_offer = attributes[:'custom_offer']
+      end
+
+      if attributes.key?(:'validity_period')
+        self.validity_period = attributes[:'validity_period']
+      end
+
+      if attributes.key?(:'available_denominations')
+        self.available_denominations = attributes[:'available_denominations']
+      end
+
+      if attributes.key?(:'breakable')
+        self.breakable = attributes[:'breakable']
+      end
+
+      if attributes.key?(:'cumulable')
+        self.cumulable = attributes[:'cumulable']
+      end
+
+      if attributes.key?(:'denomination')
+        self.denomination = attributes[:'denomination']
+      end
+
+      if attributes.key?(:'denomination_currency')
+        self.denomination_currency = attributes[:'denomination_currency']
+      end
+
+      if attributes.key?(:'duration')
+        self.duration = attributes[:'duration']
+      end
+
+      if attributes.key?(:'duration_unit')
+        self.duration_unit = attributes[:'duration_unit']
+      end
+
+      if attributes.key?(:'people')
+        self.people = attributes[:'people']
+      end
+
+      if attributes.key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      end
+
+      if attributes.key?(:'quantity_unit')
+        self.quantity_unit = attributes[:'quantity_unit']
+      end
+
+      if attributes.key?(:'redemption_channel')
+        if (value = attributes[:'redemption_channel']).is_a?(Array)
+          self.redemption_channel = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          available_denominations_range == o.available_denominations_range &&
+          custom_offer == o.custom_offer &&
+          validity_period == o.validity_period &&
+          available_denominations == o.available_denominations &&
+          breakable == o.breakable &&
+          cumulable == o.cumulable &&
+          denomination == o.denomination &&
+          denomination_currency == o.denomination_currency &&
+          duration == o.duration &&
+          duration_unit == o.duration_unit &&
+          people == o.people &&
+          quantity == o.quantity &&
+          quantity_unit == o.quantity_unit &&
+          redemption_channel == o.redemption_channel
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [available_denominations_range, custom_offer, validity_period, available_denominations, breakable, cumulable, denomination, denomination_currency, duration, duration_unit, people, quantity, quantity_unit, redemption_channel].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/ifeelgoods/models/dimension_denomination.rb

@@ -0,0 +1,105 @@
+=begin
+#Fulfillment API
+
+#Public API exposed to ifeelgoods customers.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Ifeelgoods
+  # Monetary amount of the reward (eg. 10€, $20, etc.).
+  module DimensionDenomination
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'Float',
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = Ifeelgoods.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end