ifeelgoods 0.0.1

data/lib/ifeelgoods/models/reward_details_dimensions.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 RewardDetailsDimensions < 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::RewardDetailsDimensions` 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::RewardDetailsDimensions`. 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/reward_details_product.rb

@@ -0,0 +1,222 @@
+=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 RewardDetailsProduct < ApiModelBase
+    # Unique identifier for the product (eg. `APP-ITC`).
+    attr_accessor :id
+
+    # The product name (eg. `iTunes Code`).
+    attr_accessor :name
+
+    # Indicates whether the product can be delivered as PDF or not.
+    attr_accessor :deliverable_as_pdf
+
+    # Indicates product VAT rate.
+    attr_accessor :vat_rate
+
+    # Indicates product VAT rule (BUU or BUM).
+    attr_accessor :vat_rule
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'deliverable_as_pdf' => :'deliverable_as_pdf',
+        :'vat_rate' => :'vat_rate',
+        :'vat_rule' => :'vat_rule'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'deliverable_as_pdf' => :'Boolean',
+        :'vat_rate' => :'Float',
+        :'vat_rule' => :'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::RewardDetailsProduct` 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::RewardDetailsProduct`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'deliverable_as_pdf')
+        self.deliverable_as_pdf = attributes[:'deliverable_as_pdf']
+      end
+
+      if attributes.key?(:'vat_rate')
+        self.vat_rate = attributes[:'vat_rate']
+      end
+
+      if attributes.key?(:'vat_rule')
+        self.vat_rule = attributes[:'vat_rule']
+      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'
+      vat_rule_validator = EnumAttributeValidator.new('String', ["BUU", "BUM"])
+      return false unless vat_rule_validator.valid?(@vat_rule)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] vat_rule Object to be assigned
+    def vat_rule=(vat_rule)
+      validator = EnumAttributeValidator.new('String', ["BUU", "BUM"])
+      unless validator.valid?(vat_rule)
+        fail ArgumentError, "invalid value for \"vat_rule\", must be one of #{validator.allowable_values}."
+      end
+      @vat_rule = vat_rule
+    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 &&
+          id == o.id &&
+          name == o.name &&
+          deliverable_as_pdf == o.deliverable_as_pdf &&
+          vat_rate == o.vat_rate &&
+          vat_rule == o.vat_rule
+    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
+      [id, name, deliverable_as_pdf, vat_rate, vat_rule].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