ifeelgoods 0.0.1

data/lib/ifeelgoods/models/reward_details.rb

@@ -0,0 +1,486 @@
+=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
+  # A Reward (aka Product SKU) is a specific denomination of a Digital or Physical Gift that can be delivered to a User. \"iTunes Code 10$ (US)\" is a Reward.
+  class RewardDetails < ApiModelBase
+    # Reward name (eg. `$10 iTunes® Code`).
+    attr_accessor :name
+
+    # Unique identifier that represents the reward (eg. `APP-ITC-10USD-US`). It must be used with the redeem APIs.
+    attr_accessor :sku
+
+    # Reward formatted value with currency (eg. `$10`).
+    attr_accessor :denomination
+
+    attr_accessor :display_value
+
+    # Indicates whether the reward should be redeemed with a value. Range can be found in dimensions.available_denominations_range.
+    attr_accessor :free_value
+
+    # Reward cost for your account (eg. `9.0`). You need to query the API with the `client_id` parameter to retrieve the acutal cost, otherwise it will return `face_value`.
+    attr_accessor :cost
+
+    # Reward cost currency (eg. `USD`, `EUR`).
+    attr_accessor :cost_currency
+
+    # Reward face value, actual reward amount (e.g. `10.00`).
+    attr_accessor :face_value
+
+    # Reward face value currency. (eg. `EUR`).
+    attr_accessor :face_value_currency
+
+    # Boolean that represent reward availability.
+    attr_accessor :in_stock
+
+    # Stock quantity. Can be `null` (if `stock_quantity` is `null`, `in_stock` is always `true`).
+    attr_accessor :stock_quantity
+
+    attr_accessor :brand
+
+    attr_accessor :product
+
+    attr_accessor :product_type
+
+    # Reward code format
+    attr_accessor :usages
+
+    # Expiration date (eg. `2023-03-31`)
+    attr_accessor :expiration_date
+
+    # Reward categories (eg. `['Games & Entertainment', 'Sports']`) (not maintained).
+    attr_accessor :categories
+
+    # Reward description.
+    attr_accessor :description
+
+    # Reward country list (eg. `[\"US\", \"CA\"]` or `[\"WW\"]` if worldwide). If the reward is not specific to a country, it will be considered as worldwide.
+    attr_accessor :country
+
+    attr_accessor :conditions_of_sale
+
+    attr_accessor :dimensions
+
+    # Reward tags (not maintained).
+    attr_accessor :tags
+
+    attr_accessor :targeting
+
+    # Reward image, without scheme (eg. `//cdn.ifeelgoods.com/image.png`).
+    attr_accessor :catalog_badge_url
+
+    # (legacy) Reward image (same as catalog_badge_url).
+    attr_accessor :catalog_card_url
+
+    # Brand logo, without scheme (eg. `//cdn.ifeelgoods.com/logo.png`).
+    attr_accessor :logo_url
+
+    # Reward 'Terms and Conditions' URL (when provided by brand, `null` otherwise).
+    attr_accessor :terms_and_conditions_url
+
+    # Reward 'Terms and Conditions'.
+    attr_accessor :terms_and_conditions
+
+    # Reward 'How to use' instructions.
+    attr_accessor :how_to_use_instructions
+
+    # Reward additional information.
+    attr_accessor :important_instructions
+
+    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
+      {
+        :'name' => :'name',
+        :'sku' => :'sku',
+        :'denomination' => :'denomination',
+        :'display_value' => :'display_value',
+        :'free_value' => :'free_value',
+        :'cost' => :'cost',
+        :'cost_currency' => :'cost_currency',
+        :'face_value' => :'face_value',
+        :'face_value_currency' => :'face_value_currency',
+        :'in_stock' => :'in_stock',
+        :'stock_quantity' => :'stock_quantity',
+        :'brand' => :'brand',
+        :'product' => :'product',
+        :'product_type' => :'product_type',
+        :'usages' => :'usages',
+        :'expiration_date' => :'expiration_date',
+        :'categories' => :'categories',
+        :'description' => :'description',
+        :'country' => :'country',
+        :'conditions_of_sale' => :'conditions_of_sale',
+        :'dimensions' => :'dimensions',
+        :'tags' => :'tags',
+        :'targeting' => :'targeting',
+        :'catalog_badge_url' => :'catalog_badge_url',
+        :'catalog_card_url' => :'catalog_card_url',
+        :'logo_url' => :'logo_url',
+        :'terms_and_conditions_url' => :'terms_and_conditions_url',
+        :'terms_and_conditions' => :'terms_and_conditions',
+        :'how_to_use_instructions' => :'how_to_use_instructions',
+        :'important_instructions' => :'important_instructions'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'sku' => :'String',
+        :'denomination' => :'String',
+        :'display_value' => :'String',
+        :'free_value' => :'Boolean',
+        :'cost' => :'Float',
+        :'cost_currency' => :'String',
+        :'face_value' => :'String',
+        :'face_value_currency' => :'String',
+        :'in_stock' => :'Boolean',
+        :'stock_quantity' => :'Integer',
+        :'brand' => :'RewardDetailsBrand',
+        :'product' => :'RewardDetailsProduct',
+        :'product_type' => :'RewardDetailsProductType',
+        :'usages' => :'Array<String>',
+        :'expiration_date' => :'String',
+        :'categories' => :'Array<String>',
+        :'description' => :'String',
+        :'country' => :'Array<String>',
+        :'conditions_of_sale' => :'String',
+        :'dimensions' => :'RewardDetailsDimensions',
+        :'tags' => :'Array<String>',
+        :'targeting' => :'RewardDetailsTargeting',
+        :'catalog_badge_url' => :'String',
+        :'catalog_card_url' => :'String',
+        :'logo_url' => :'String',
+        :'terms_and_conditions_url' => :'String',
+        :'terms_and_conditions' => :'String',
+        :'how_to_use_instructions' => :'String',
+        :'important_instructions' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'cost',
+        :'stock_quantity',
+        :'expiration_date',
+        :'description',
+        :'conditions_of_sale',
+        :'catalog_badge_url',
+        :'catalog_card_url',
+        :'logo_url',
+        :'terms_and_conditions_url',
+        :'terms_and_conditions',
+        :'how_to_use_instructions',
+        :'important_instructions'
+      ])
+    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::RewardDetails` 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::RewardDetails`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'sku')
+        self.sku = attributes[:'sku']
+      end
+
+      if attributes.key?(:'denomination')
+        self.denomination = attributes[:'denomination']
+      end
+
+      if attributes.key?(:'display_value')
+        self.display_value = attributes[:'display_value']
+      end
+
+      if attributes.key?(:'free_value')
+        self.free_value = attributes[:'free_value']
+      end
+
+      if attributes.key?(:'cost')
+        self.cost = attributes[:'cost']
+      end
+
+      if attributes.key?(:'cost_currency')
+        self.cost_currency = attributes[:'cost_currency']
+      end
+
+      if attributes.key?(:'face_value')
+        self.face_value = attributes[:'face_value']
+      end
+
+      if attributes.key?(:'face_value_currency')
+        self.face_value_currency = attributes[:'face_value_currency']
+      end
+
+      if attributes.key?(:'in_stock')
+        self.in_stock = attributes[:'in_stock']
+      end
+
+      if attributes.key?(:'stock_quantity')
+        self.stock_quantity = attributes[:'stock_quantity']
+      end
+
+      if attributes.key?(:'brand')
+        self.brand = attributes[:'brand']
+      end
+
+      if attributes.key?(:'product')
+        self.product = attributes[:'product']
+      end
+
+      if attributes.key?(:'product_type')
+        self.product_type = attributes[:'product_type']
+      end
+
+      if attributes.key?(:'usages')
+        if (value = attributes[:'usages']).is_a?(Array)
+          self.usages = value
+        end
+      end
+
+      if attributes.key?(:'expiration_date')
+        self.expiration_date = attributes[:'expiration_date']
+      end
+
+      if attributes.key?(:'categories')
+        if (value = attributes[:'categories']).is_a?(Array)
+          self.categories = value
+        end
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'country')
+        if (value = attributes[:'country']).is_a?(Array)
+          self.country = value
+        end
+      end
+
+      if attributes.key?(:'conditions_of_sale')
+        self.conditions_of_sale = attributes[:'conditions_of_sale']
+      end
+
+      if attributes.key?(:'dimensions')
+        self.dimensions = attributes[:'dimensions']
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'targeting')
+        self.targeting = attributes[:'targeting']
+      end
+
+      if attributes.key?(:'catalog_badge_url')
+        self.catalog_badge_url = attributes[:'catalog_badge_url']
+      end
+
+      if attributes.key?(:'catalog_card_url')
+        self.catalog_card_url = attributes[:'catalog_card_url']
+      end
+
+      if attributes.key?(:'logo_url')
+        self.logo_url = attributes[:'logo_url']
+      end
+
+      if attributes.key?(:'terms_and_conditions_url')
+        self.terms_and_conditions_url = attributes[:'terms_and_conditions_url']
+      end
+
+      if attributes.key?(:'terms_and_conditions')
+        self.terms_and_conditions = attributes[:'terms_and_conditions']
+      end
+
+      if attributes.key?(:'how_to_use_instructions')
+        self.how_to_use_instructions = attributes[:'how_to_use_instructions']
+      end
+
+      if attributes.key?(:'important_instructions')
+        self.important_instructions = attributes[:'important_instructions']
+      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'
+      conditions_of_sale_validator = EnumAttributeValidator.new('String', ["on_demand", "special_order_only"])
+      return false unless conditions_of_sale_validator.valid?(@conditions_of_sale)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] conditions_of_sale Object to be assigned
+    def conditions_of_sale=(conditions_of_sale)
+      validator = EnumAttributeValidator.new('String', ["on_demand", "special_order_only"])
+      unless validator.valid?(conditions_of_sale)
+        fail ArgumentError, "invalid value for \"conditions_of_sale\", must be one of #{validator.allowable_values}."
+      end
+      @conditions_of_sale = conditions_of_sale
+    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 &&
+          name == o.name &&
+          sku == o.sku &&
+          denomination == o.denomination &&
+          display_value == o.display_value &&
+          free_value == o.free_value &&
+          cost == o.cost &&
+          cost_currency == o.cost_currency &&
+          face_value == o.face_value &&
+          face_value_currency == o.face_value_currency &&
+          in_stock == o.in_stock &&
+          stock_quantity == o.stock_quantity &&
+          brand == o.brand &&
+          product == o.product &&
+          product_type == o.product_type &&
+          usages == o.usages &&
+          expiration_date == o.expiration_date &&
+          categories == o.categories &&
+          description == o.description &&
+          country == o.country &&
+          conditions_of_sale == o.conditions_of_sale &&
+          dimensions == o.dimensions &&
+          tags == o.tags &&
+          targeting == o.targeting &&
+          catalog_badge_url == o.catalog_badge_url &&
+          catalog_card_url == o.catalog_card_url &&
+          logo_url == o.logo_url &&
+          terms_and_conditions_url == o.terms_and_conditions_url &&
+          terms_and_conditions == o.terms_and_conditions &&
+          how_to_use_instructions == o.how_to_use_instructions &&
+          important_instructions == o.important_instructions
+    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
+      [name, sku, denomination, display_value, free_value, cost, cost_currency, face_value, face_value_currency, in_stock, stock_quantity, brand, product, product_type, usages, expiration_date, categories, description, country, conditions_of_sale, dimensions, tags, targeting, catalog_badge_url, catalog_card_url, logo_url, terms_and_conditions_url, terms_and_conditions, how_to_use_instructions, important_instructions].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_brand.rb

@@ -0,0 +1,213 @@
+=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
+  # Reward brand. In ifeelgoods data model, it's a kind of 'parent' for the product.
+  class RewardDetailsBrand < ApiModelBase
+    # Unique identifier that represents the brand (eg. `APP`).
+    attr_accessor :id
+
+    # Brand name (eg. `iTunes`).
+    attr_accessor :name
+
+    attr_accessor :status
+
+    # Brand URL (eg. `https://www.ifeelgoods.com`).
+    attr_accessor :url
+
+    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',
+        :'status' => :'status',
+        :'url' => :'url'
+      }
+    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',
+        :'status' => :'String',
+        :'url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'url'
+      ])
+    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::RewardDetailsBrand` 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::RewardDetailsBrand`. 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?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      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'
+      status_validator = EnumAttributeValidator.new('String', ["active", "deactivated"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["active", "deactivated"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          status == o.status &&
+          url == o.url
+    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, status, url].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