talon_one 10.0.0 → 11.0.0

data/lib/talon_one/models/expiring_coupons_data.rb

@@ -0,0 +1,369 @@
+=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 ExpiringCouponsData
+    # The coupon code.
+    attr_accessor :coupon_value
+
+    # Timestamp at which point the coupon was created.
+    attr_accessor :created_date
+
+    # Timestamp at which point the coupon becomes valid.
+    attr_accessor :valid_from
+
+    # Timestamp at which point the coupon expires. Coupon never expires if this is omitted, zero, or negative.
+    attr_accessor :valid_until
+
+    # The ID of the campaign to which the coupon belongs.
+    attr_accessor :campaign_id
+
+    # The Integration ID of the customer that is allowed to redeem this coupon.
+    attr_accessor :customer_profile_id
+
+    # The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. 
+    attr_accessor :usage_limit
+
+    # The number of times the coupon has been successfully redeemed.
+    attr_accessor :usage_counter
+
+    # The ID of the batch the coupon belongs to.
+    attr_accessor :batch_id
+
+    # Custom attributes associated with this coupon.
+    attr_accessor :attributes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'coupon_value' => :'CouponValue',
+        :'created_date' => :'CreatedDate',
+        :'valid_from' => :'ValidFrom',
+        :'valid_until' => :'ValidUntil',
+        :'campaign_id' => :'CampaignId',
+        :'customer_profile_id' => :'CustomerProfileId',
+        :'usage_limit' => :'UsageLimit',
+        :'usage_counter' => :'UsageCounter',
+        :'batch_id' => :'BatchId',
+        :'attributes' => :'Attributes'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'coupon_value' => :'String',
+        :'created_date' => :'DateTime',
+        :'valid_from' => :'DateTime',
+        :'valid_until' => :'DateTime',
+        :'campaign_id' => :'Integer',
+        :'customer_profile_id' => :'String',
+        :'usage_limit' => :'Integer',
+        :'usage_counter' => :'Integer',
+        :'batch_id' => :'String',
+        :'attributes' => :'Object'
+      }
+    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::ExpiringCouponsData` 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::ExpiringCouponsData`. 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?(:'coupon_value')
+        self.coupon_value = attributes[:'coupon_value']
+      end
+
+      if attributes.key?(:'created_date')
+        self.created_date = attributes[:'created_date']
+      end
+
+      if attributes.key?(:'valid_from')
+        self.valid_from = attributes[:'valid_from']
+      end
+
+      if attributes.key?(:'valid_until')
+        self.valid_until = attributes[:'valid_until']
+      end
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
+      if attributes.key?(:'customer_profile_id')
+        self.customer_profile_id = attributes[:'customer_profile_id']
+      end
+
+      if attributes.key?(:'usage_limit')
+        self.usage_limit = attributes[:'usage_limit']
+      end
+
+      if attributes.key?(:'usage_counter')
+        self.usage_counter = attributes[:'usage_counter']
+      end
+
+      if attributes.key?(:'batch_id')
+        self.batch_id = attributes[:'batch_id']
+      end
+
+      if attributes.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 @coupon_value.nil?
+        invalid_properties.push('invalid value for "coupon_value", coupon_value cannot be nil.')
+      end
+
+      if @campaign_id.nil?
+        invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
+      end
+
+      if @campaign_id < 1
+        invalid_properties.push('invalid value for "campaign_id", must be greater than or equal to 1.')
+      end
+
+      if @usage_limit.nil?
+        invalid_properties.push('invalid value for "usage_limit", usage_limit cannot be nil.')
+      end
+
+      if @usage_limit > 999999
+        invalid_properties.push('invalid value for "usage_limit", must be smaller than or equal to 999999.')
+      end
+
+      if @usage_limit < 0
+        invalid_properties.push('invalid value for "usage_limit", must be greater than or equal to 0.')
+      end
+
+      if @usage_counter.nil?
+        invalid_properties.push('invalid value for "usage_counter", usage_counter cannot be nil.')
+      end
+
+      if @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes 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 @coupon_value.nil?
+      return false if @campaign_id.nil?
+      return false if @campaign_id < 1
+      return false if @usage_limit.nil?
+      return false if @usage_limit > 999999
+      return false if @usage_limit < 0
+      return false if @usage_counter.nil?
+      return false if @attributes.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] campaign_id Value to be assigned
+    def campaign_id=(campaign_id)
+      if campaign_id.nil?
+        fail ArgumentError, 'campaign_id cannot be nil'
+      end
+
+      if campaign_id < 1
+        fail ArgumentError, 'invalid value for "campaign_id", must be greater than or equal to 1.'
+      end
+
+      @campaign_id = campaign_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] usage_limit Value to be assigned
+    def usage_limit=(usage_limit)
+      if usage_limit.nil?
+        fail ArgumentError, 'usage_limit cannot be nil'
+      end
+
+      if usage_limit > 999999
+        fail ArgumentError, 'invalid value for "usage_limit", must be smaller than or equal to 999999.'
+      end
+
+      if 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 &&
+          coupon_value == o.coupon_value &&
+          created_date == o.created_date &&
+          valid_from == o.valid_from &&
+          valid_until == o.valid_until &&
+          campaign_id == o.campaign_id &&
+          customer_profile_id == o.customer_profile_id &&
+          usage_limit == o.usage_limit &&
+          usage_counter == o.usage_counter &&
+          batch_id == o.batch_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 [Integer] Hash code
+    def hash
+      [coupon_value, created_date, valid_from, valid_until, campaign_id, customer_profile_id, usage_limit, usage_counter, batch_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 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

data/lib/talon_one/models/expiring_coupons_notification.rb

@@ -0,0 +1,277 @@
+=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 ExpiringCouponsNotification
+    attr_accessor :total_result_size
+
+    # The array of expiring coupon notifications.
+    attr_accessor :data
+
+    # The type of notification.
+    attr_accessor :notification_type
+
+    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
+      {
+        :'total_result_size' => :'TotalResultSize',
+        :'data' => :'Data',
+        :'notification_type' => :'NotificationType'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'total_result_size' => :'Integer',
+        :'data' => :'Array<ExpiringCouponsData>',
+        :'notification_type' => :'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 `TalonOne::ExpiringCouponsNotification` 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::ExpiringCouponsNotification`. 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?(:'total_result_size')
+        self.total_result_size = attributes[:'total_result_size']
+      end
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+      if attributes.key?(:'notification_type')
+        self.notification_type = attributes[:'notification_type']
+      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 @total_result_size.nil?
+        invalid_properties.push('invalid value for "total_result_size", total_result_size cannot be nil.')
+      end
+
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      end
+
+      if @notification_type.nil?
+        invalid_properties.push('invalid value for "notification_type", notification_type 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 @total_result_size.nil?
+      return false if @data.nil?
+      return false if @notification_type.nil?
+      notification_type_validator = EnumAttributeValidator.new('String', ["CouponCodeExpiring"])
+      return false unless notification_type_validator.valid?(@notification_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] notification_type Object to be assigned
+    def notification_type=(notification_type)
+      validator = EnumAttributeValidator.new('String', ["CouponCodeExpiring"])
+      unless validator.valid?(notification_type)
+        fail ArgumentError, "invalid value for \"notification_type\", must be one of #{validator.allowable_values}."
+      end
+      @notification_type = notification_type
+    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 &&
+          total_result_size == o.total_result_size &&
+          data == o.data &&
+          notification_type == o.notification_type
+    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
+      [total_result_size, data, notification_type].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

data/lib/talon_one/models/expiring_coupons_notification_policy.rb

@@ -84,6 +84,8 @@ module TalonOne
 
       if attributes.key?(:'batch_size')
         self.batch_size = attributes[:'batch_size']
+      else
+        self.batch_size = 1000
       end
     end