talon_one 0.1.3 → 1.1.0

data/lib/talon_one/models/update_campaign.rb

@@ -0,0 +1,373 @@
+=begin
+#Talon.One API
+
+#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put 
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.7
+
+=end
+
+require 'date'
+
+module TalonOne
+  class UpdateCampaign
+    # A friendly name for this campaign.
+    attr_accessor :name
+
+    # A detailed description of the campaign.
+    attr_accessor :description
+
+    # Datetime when the campaign will become active.
+    attr_accessor :start_time
+
+    # Datetime when the campaign will become in-active.
+    attr_accessor :end_time
+
+    # Arbitrary properties associated with this campaign
+    attr_accessor :attributes
+
+    # A disabled or archived campaign is not evaluated for rules or coupons. 
+    attr_accessor :state
+
+    # ID of Ruleset this campaign applies on customer session evaluation.
+    attr_accessor :active_ruleset_id
+
+    # A list of tags for the campaign.
+    attr_accessor :tags
+
+    # A list of features for the campaign.
+    attr_accessor :features
+
+    attr_accessor :coupon_settings
+
+    attr_accessor :referral_settings
+
+    # The set of limits that will operate for this campaign
+    attr_accessor :limits
+
+    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',
+        :'description' => :'description',
+        :'start_time' => :'startTime',
+        :'end_time' => :'endTime',
+        :'attributes' => :'attributes',
+        :'state' => :'state',
+        :'active_ruleset_id' => :'activeRulesetId',
+        :'tags' => :'tags',
+        :'features' => :'features',
+        :'coupon_settings' => :'couponSettings',
+        :'referral_settings' => :'referralSettings',
+        :'limits' => :'limits'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'description' => :'String',
+        :'start_time' => :'DateTime',
+        :'end_time' => :'DateTime',
+        :'attributes' => :'Object',
+        :'state' => :'String',
+        :'active_ruleset_id' => :'Integer',
+        :'tags' => :'Array<String>',
+        :'features' => :'Array<String>',
+        :'coupon_settings' => :'CodeGeneratorSettings',
+        :'referral_settings' => :'CodeGeneratorSettings',
+        :'limits' => :'Array<LimitConfig>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.has_key?(:'startTime')
+        self.start_time = attributes[:'startTime']
+      end
+
+      if attributes.has_key?(:'endTime')
+        self.end_time = attributes[:'endTime']
+      end
+
+      if attributes.has_key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      end
+
+      if attributes.has_key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = 'enabled'
+      end
+
+      if attributes.has_key?(:'activeRulesetId')
+        self.active_ruleset_id = attributes[:'activeRulesetId']
+      end
+
+      if attributes.has_key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.has_key?(:'features')
+        if (value = attributes[:'features']).is_a?(Array)
+          self.features = value
+        end
+      end
+
+      if attributes.has_key?(:'couponSettings')
+        self.coupon_settings = attributes[:'couponSettings']
+      end
+
+      if attributes.has_key?(:'referralSettings')
+        self.referral_settings = attributes[:'referralSettings']
+      end
+
+      if attributes.has_key?(:'limits')
+        if (value = attributes[:'limits']).is_a?(Array)
+          self.limits = 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
+      invalid_properties = Array.new
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      if @tags.nil?
+        invalid_properties.push('invalid value for "tags", tags cannot be nil.')
+      end
+
+      if @features.nil?
+        invalid_properties.push('invalid value for "features", features cannot be nil.')
+      end
+
+      if @limits.nil?
+        invalid_properties.push('invalid value for "limits", limits cannot be nil.')
+      end
+
+      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?
+      return false if @name.nil?
+      return false if @name.to_s.length < 1
+      state_validator = EnumAttributeValidator.new('String', ['enabled', 'disabled', 'archived'])
+      return false unless state_validator.valid?(@state)
+      return false if @tags.nil?
+      return false if @features.nil?
+      return false if @limits.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ['enabled', 'disabled', 'archived'])
+      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 &&
+          name == o.name &&
+          description == o.description &&
+          start_time == o.start_time &&
+          end_time == o.end_time &&
+          attributes == o.attributes &&
+          state == o.state &&
+          active_ruleset_id == o.active_ruleset_id &&
+          tags == o.tags &&
+          features == o.features &&
+          coupon_settings == o.coupon_settings &&
+          referral_settings == o.referral_settings &&
+          limits == o.limits
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [name, description, start_time, end_time, attributes, state, active_ruleset_id, tags, features, coupon_settings, referral_settings, limits].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = TalonOne.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/talon_one/models/update_coupon.rb

@@ -0,0 +1,249 @@
+=begin
+#Talon.One API
+
+#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put 
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.7
+
+=end
+
+require 'date'
+
+module TalonOne
+  # 
+  class UpdateCoupon
+    # The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. 
+    attr_accessor :usage_limit
+
+    # Timestamp at which point the coupon becomes valid.
+    attr_accessor :start_date
+
+    # Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative.
+    attr_accessor :expiry_date
+
+    # The integration ID for this coupon's beneficiary's profile
+    attr_accessor :recipient_integration_id
+
+    # Arbitrary properties associated with this item
+    attr_accessor :attributes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'usage_limit' => :'usageLimit',
+        :'start_date' => :'startDate',
+        :'expiry_date' => :'expiryDate',
+        :'recipient_integration_id' => :'recipientIntegrationId',
+        :'attributes' => :'attributes'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'usage_limit' => :'Integer',
+        :'start_date' => :'DateTime',
+        :'expiry_date' => :'DateTime',
+        :'recipient_integration_id' => :'String',
+        :'attributes' => :'Object'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'usageLimit')
+        self.usage_limit = attributes[:'usageLimit']
+      end
+
+      if attributes.has_key?(:'startDate')
+        self.start_date = attributes[:'startDate']
+      end
+
+      if attributes.has_key?(:'expiryDate')
+        self.expiry_date = attributes[:'expiryDate']
+      end
+
+      if attributes.has_key?(:'recipientIntegrationId')
+        self.recipient_integration_id = attributes[:'recipientIntegrationId']
+      end
+
+      if attributes.has_key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      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
+      invalid_properties = Array.new
+      if !@usage_limit.nil? && @usage_limit > 999999
+        invalid_properties.push('invalid value for "usage_limit", must be smaller than or equal to 999999.')
+      end
+
+      if !@usage_limit.nil? && @usage_limit < 0
+        invalid_properties.push('invalid value for "usage_limit", must be greater than or equal to 0.')
+      end
+
+      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?
+      return false if !@usage_limit.nil? && @usage_limit > 999999
+      return false if !@usage_limit.nil? && @usage_limit < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] usage_limit Value to be assigned
+    def usage_limit=(usage_limit)
+      if !usage_limit.nil? && usage_limit > 999999
+        fail ArgumentError, 'invalid value for "usage_limit", must be smaller than or equal to 999999.'
+      end
+
+      if !usage_limit.nil? && usage_limit < 0
+        fail ArgumentError, 'invalid value for "usage_limit", must be greater than or equal to 0.'
+      end
+
+      @usage_limit = usage_limit
+    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 &&
+          usage_limit == o.usage_limit &&
+          start_date == o.start_date &&
+          expiry_date == o.expiry_date &&
+          recipient_integration_id == o.recipient_integration_id &&
+          attributes == o.attributes
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [usage_limit, start_date, expiry_date, recipient_integration_id, attributes].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = TalonOne.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end