ifeelgoods 0.0.1

data/lib/ifeelgoods/models/redemption.rb

@@ -0,0 +1,383 @@
+=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 Redemption defines the status of a Reward delivery (user eligibility, reward selected, authentication settings, notification channels..)
+  class Redemption < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :url
+
+    attr_accessor :state
+
+    attr_accessor :order_id
+
+    attr_accessor :testing
+
+    # When a redemption is redeemed, indicates whether the code is cancelable or not
+    attr_accessor :cancelable
+
+    # When a redemption is refunded, indicates whether the code was reversed or not
+    attr_accessor :reversed
+
+    attr_accessor :client
+
+    attr_accessor :promotion
+
+    # List of authentication systems used for the campaign (eg. `[\"email\", \"sms\"]`).
+    attr_accessor :authentication_systems
+
+    attr_accessor :notification_channels
+
+    attr_accessor :activation_notification_channels
+
+    attr_accessor :can_consult
+
+    attr_accessor :reward_format
+
+    attr_accessor :reward
+
+    attr_accessor :value
+
+    attr_accessor :activation_datetime
+
+    # Redemption expiration date (when the redemption is in pending state, it may have a date after which it is no longer redeemable).
+    attr_accessor :expiration_datetime
+
+    # Available when redemption has reached a redeemed state.
+    attr_accessor :redeemed_datetime
+
+    # Available when redemption has reached a refunded state.
+    attr_accessor :refunded_datetime
+
+    attr_accessor :updated_datetime
+
+    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',
+        :'url' => :'url',
+        :'state' => :'state',
+        :'order_id' => :'order_id',
+        :'testing' => :'testing',
+        :'cancelable' => :'cancelable',
+        :'reversed' => :'reversed',
+        :'client' => :'client',
+        :'promotion' => :'promotion',
+        :'authentication_systems' => :'authentication_systems',
+        :'notification_channels' => :'notification_channels',
+        :'activation_notification_channels' => :'activation_notification_channels',
+        :'can_consult' => :'can_consult',
+        :'reward_format' => :'reward_format',
+        :'reward' => :'reward',
+        :'value' => :'value',
+        :'activation_datetime' => :'activation_datetime',
+        :'expiration_datetime' => :'expiration_datetime',
+        :'redeemed_datetime' => :'redeemed_datetime',
+        :'refunded_datetime' => :'refunded_datetime',
+        :'updated_datetime' => :'updated_datetime'
+      }
+    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',
+        :'url' => :'String',
+        :'state' => :'String',
+        :'order_id' => :'String',
+        :'testing' => :'Boolean',
+        :'cancelable' => :'Boolean',
+        :'reversed' => :'Boolean',
+        :'client' => :'PromotionDetailsClient',
+        :'promotion' => :'RedemptionPromotion',
+        :'authentication_systems' => :'Array<String>',
+        :'notification_channels' => :'Array<String>',
+        :'activation_notification_channels' => :'Array<String>',
+        :'can_consult' => :'Boolean',
+        :'reward_format' => :'RedemptionRewardFormat',
+        :'reward' => :'RedemptionReward',
+        :'value' => :'RedemptionValue',
+        :'activation_datetime' => :'Time',
+        :'expiration_datetime' => :'Time',
+        :'redeemed_datetime' => :'Time',
+        :'refunded_datetime' => :'Time',
+        :'updated_datetime' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'url',
+        :'notification_channels',
+        :'activation_notification_channels',
+        :'can_consult',
+        :'reward_format',
+        :'value',
+        :'expiration_datetime',
+        :'redeemed_datetime',
+        :'refunded_datetime',
+      ])
+    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::Redemption` 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::Redemption`. 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?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+
+      if attributes.key?(:'testing')
+        self.testing = attributes[:'testing']
+      end
+
+      if attributes.key?(:'cancelable')
+        self.cancelable = attributes[:'cancelable']
+      end
+
+      if attributes.key?(:'reversed')
+        self.reversed = attributes[:'reversed']
+      end
+
+      if attributes.key?(:'client')
+        self.client = attributes[:'client']
+      end
+
+      if attributes.key?(:'promotion')
+        self.promotion = attributes[:'promotion']
+      end
+
+      if attributes.key?(:'authentication_systems')
+        if (value = attributes[:'authentication_systems']).is_a?(Array)
+          self.authentication_systems = value
+        end
+      end
+
+      if attributes.key?(:'notification_channels')
+        if (value = attributes[:'notification_channels']).is_a?(Array)
+          self.notification_channels = value
+        end
+      end
+
+      if attributes.key?(:'activation_notification_channels')
+        if (value = attributes[:'activation_notification_channels']).is_a?(Array)
+          self.activation_notification_channels = value
+        end
+      end
+
+      if attributes.key?(:'can_consult')
+        self.can_consult = attributes[:'can_consult']
+      end
+
+      if attributes.key?(:'reward_format')
+        self.reward_format = attributes[:'reward_format']
+      end
+
+      if attributes.key?(:'reward')
+        self.reward = attributes[:'reward']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.key?(:'activation_datetime')
+        self.activation_datetime = attributes[:'activation_datetime']
+      end
+
+      if attributes.key?(:'expiration_datetime')
+        self.expiration_datetime = attributes[:'expiration_datetime']
+      end
+
+      if attributes.key?(:'redeemed_datetime')
+        self.redeemed_datetime = attributes[:'redeemed_datetime']
+      end
+
+      if attributes.key?(:'refunded_datetime')
+        self.refunded_datetime = attributes[:'refunded_datetime']
+      end
+
+      if attributes.key?(:'updated_datetime')
+        self.updated_datetime = attributes[:'updated_datetime']
+      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'
+      state_validator = EnumAttributeValidator.new('String', ["pending", "booked", "redeemed", "denied", "failed", "refunded", "blocked", "canceled", "expired"])
+      return false unless state_validator.valid?(@state)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["pending", "booked", "redeemed", "denied", "failed", "refunded", "blocked", "canceled", "expired"])
+      unless validator.valid?(state)
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      end
+      @state = state
+    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 &&
+          url == o.url &&
+          state == o.state &&
+          order_id == o.order_id &&
+          testing == o.testing &&
+          cancelable == o.cancelable &&
+          reversed == o.reversed &&
+          client == o.client &&
+          promotion == o.promotion &&
+          authentication_systems == o.authentication_systems &&
+          notification_channels == o.notification_channels &&
+          activation_notification_channels == o.activation_notification_channels &&
+          can_consult == o.can_consult &&
+          reward_format == o.reward_format &&
+          reward == o.reward &&
+          value == o.value &&
+          activation_datetime == o.activation_datetime &&
+          expiration_datetime == o.expiration_datetime &&
+          redeemed_datetime == o.redeemed_datetime &&
+          refunded_datetime == o.refunded_datetime &&
+          updated_datetime == o.updated_datetime
+    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, url, state, order_id, testing, cancelable, reversed, client, promotion, authentication_systems, notification_channels, activation_notification_channels, can_consult, reward_format, reward, value, activation_datetime, expiration_datetime, redeemed_datetime, refunded_datetime, updated_datetime].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/redemption_promotion.rb

@@ -0,0 +1,211 @@
+=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 RedemptionPromotion < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :status
+
+    attr_accessor :name
+
+    attr_accessor :state
+
+    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',
+        :'status' => :'status',
+        :'name' => :'name',
+        :'state' => :'state'
+      }
+    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' => :'Integer',
+        :'status' => :'String',
+        :'name' => :'String',
+        :'state' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'status',
+        :'name',
+        :'state'
+      ])
+    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::RedemptionPromotion` 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::RedemptionPromotion`. 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?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      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', ["enabled", "disabled", "paused", "completed"])
+      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', ["enabled", "disabled", "paused", "completed"])
+      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 &&
+          status == o.status &&
+          name == o.name &&
+          state == o.state
+    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, status, name, state].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