talon_one 5.0.0 → 7.0.0

data/lib/talon_one/models/coupon_deletion_filters.rb

@@ -0,0 +1,373 @@
+=begin
+#Talon.One API
+
+#Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` 
+
+The version of the OpenAPI document: 
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module TalonOne
+  class CouponDeletionFilters
+    # Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+    attr_accessor :created_before
+
+    # Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+    attr_accessor :created_after
+
+    # Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+    attr_accessor :starts_after
+
+    # Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+    attr_accessor :starts_before
+
+    # - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which the start date is null or in the past and the expiration date is null or in the future. - `validFuture`: Matches coupons in which the start date is set and in the future. 
+    attr_accessor :valid
+
+    # - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. 
+    attr_accessor :usable
+
+    # - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned.  **Note:** This field cannot be used in conjunction with the `usable` query parameter. 
+    attr_accessor :redeemed
+
+    # Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. 
+    attr_accessor :recipient_integration_id
+
+    # Filter results to an exact case-insensitive matching against the coupon code
+    attr_accessor :exact_match
+
+    # Filter results by the coupon code
+    attr_accessor :value
+
+    # Filter results by batches of coupons
+    attr_accessor :batch_id
+
+    # Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
+    attr_accessor :referral_id
+
+    # Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+    attr_accessor :expires_after
+
+    # Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
+    attr_accessor :expires_before
+
+    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
+      {
+        :'created_before' => :'createdBefore',
+        :'created_after' => :'createdAfter',
+        :'starts_after' => :'startsAfter',
+        :'starts_before' => :'startsBefore',
+        :'valid' => :'valid',
+        :'usable' => :'usable',
+        :'redeemed' => :'redeemed',
+        :'recipient_integration_id' => :'recipientIntegrationId',
+        :'exact_match' => :'exactMatch',
+        :'value' => :'value',
+        :'batch_id' => :'batchId',
+        :'referral_id' => :'referralId',
+        :'expires_after' => :'expiresAfter',
+        :'expires_before' => :'expiresBefore'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'created_before' => :'DateTime',
+        :'created_after' => :'DateTime',
+        :'starts_after' => :'DateTime',
+        :'starts_before' => :'DateTime',
+        :'valid' => :'String',
+        :'usable' => :'Boolean',
+        :'redeemed' => :'Boolean',
+        :'recipient_integration_id' => :'String',
+        :'exact_match' => :'Boolean',
+        :'value' => :'String',
+        :'batch_id' => :'String',
+        :'referral_id' => :'Integer',
+        :'expires_after' => :'DateTime',
+        :'expires_before' => :'DateTime'
+      }
+    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 `TalonOne::CouponDeletionFilters` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::CouponDeletionFilters`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'created_before')
+        self.created_before = attributes[:'created_before']
+      end
+
+      if attributes.key?(:'created_after')
+        self.created_after = attributes[:'created_after']
+      end
+
+      if attributes.key?(:'starts_after')
+        self.starts_after = attributes[:'starts_after']
+      end
+
+      if attributes.key?(:'starts_before')
+        self.starts_before = attributes[:'starts_before']
+      end
+
+      if attributes.key?(:'valid')
+        self.valid = attributes[:'valid']
+      end
+
+      if attributes.key?(:'usable')
+        self.usable = attributes[:'usable']
+      end
+
+      if attributes.key?(:'redeemed')
+        self.redeemed = attributes[:'redeemed']
+      end
+
+      if attributes.key?(:'recipient_integration_id')
+        self.recipient_integration_id = attributes[:'recipient_integration_id']
+      end
+
+      if attributes.key?(:'exact_match')
+        self.exact_match = attributes[:'exact_match']
+      else
+        self.exact_match = false
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.key?(:'batch_id')
+        self.batch_id = attributes[:'batch_id']
+      end
+
+      if attributes.key?(:'referral_id')
+        self.referral_id = attributes[:'referral_id']
+      end
+
+      if attributes.key?(:'expires_after')
+        self.expires_after = attributes[:'expires_after']
+      end
+
+      if attributes.key?(:'expires_before')
+        self.expires_before = attributes[:'expires_before']
+      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
+      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?
+      valid_validator = EnumAttributeValidator.new('String', ["expired", "validNow", "validFuture"])
+      return false unless valid_validator.valid?(@valid)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] valid Object to be assigned
+    def valid=(valid)
+      validator = EnumAttributeValidator.new('String', ["expired", "validNow", "validFuture"])
+      unless validator.valid?(valid)
+        fail ArgumentError, "invalid value for \"valid\", must be one of #{validator.allowable_values}."
+      end
+      @valid = valid
+    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 &&
+          created_before == o.created_before &&
+          created_after == o.created_after &&
+          starts_after == o.starts_after &&
+          starts_before == o.starts_before &&
+          valid == o.valid &&
+          usable == o.usable &&
+          redeemed == o.redeemed &&
+          recipient_integration_id == o.recipient_integration_id &&
+          exact_match == o.exact_match &&
+          value == o.value &&
+          batch_id == o.batch_id &&
+          referral_id == o.referral_id &&
+          expires_after == o.expires_after &&
+          expires_before == o.expires_before
+    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
+      [created_before, created_after, starts_after, starts_before, valid, usable, redeemed, recipient_integration_id, exact_match, value, batch_id, referral_id, expires_after, expires_before].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)
+      new.build_from_hash(attributes)
+    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.openapi_types.each_pair do |key, type|
+        if 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[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
+        TalonOne.const_get(type).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)
+        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
+
+    # 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