talon_one 9.0.0 → 11.0.0

data/lib/talon_one/models/campaign_ruleset_changed_notification_item.rb

@@ -0,0 +1,245 @@
+=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
+  # A notification regarding a campaign whose ruleset was changed.
+  class CampaignRulesetChangedNotificationItem
+    # The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] 
+    attr_accessor :event
+
+    attr_accessor :campaign
+
+    attr_accessor :old_ruleset
+
+    attr_accessor :ruleset
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'event' => :'Event',
+        :'campaign' => :'campaign',
+        :'old_ruleset' => :'oldRuleset',
+        :'ruleset' => :'ruleset'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'event' => :'String',
+        :'campaign' => :'Campaign',
+        :'old_ruleset' => :'Ruleset',
+        :'ruleset' => :'Ruleset'
+      }
+    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::CampaignRulesetChangedNotificationItem` 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::CampaignRulesetChangedNotificationItem`. 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?(:'event')
+        self.event = attributes[:'event']
+      end
+
+      if attributes.key?(:'campaign')
+        self.campaign = attributes[:'campaign']
+      end
+
+      if attributes.key?(:'old_ruleset')
+        self.old_ruleset = attributes[:'old_ruleset']
+      end
+
+      if attributes.key?(:'ruleset')
+        self.ruleset = attributes[:'ruleset']
+      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 @event.nil?
+        invalid_properties.push('invalid value for "event", event cannot be nil.')
+      end
+
+      if @campaign.nil?
+        invalid_properties.push('invalid value for "campaign", campaign 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 @event.nil?
+      return false if @campaign.nil?
+      true
+    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 &&
+          event == o.event &&
+          campaign == o.campaign &&
+          old_ruleset == o.old_ruleset &&
+          ruleset == o.ruleset
+    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
+      [event, campaign, old_ruleset, ruleset].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/campaign_set.rb

@@ -17,7 +17,7 @@ module TalonOne
     # The ID of the Application that owns this entity.
     attr_accessor :application_id
 
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # Version of the campaign set.

data/lib/talon_one/models/campaign_state_changed_notification.rb

@@ -13,35 +13,31 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # A notification regarding a campaign whose state changed.
   class CampaignStateChangedNotification
-    attr_accessor :campaign
+    # The type of the notification
+    attr_accessor :notification_type
 
-    # The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] 
-    attr_accessor :old_state
+    # The total size of the result set.
+    attr_accessor :total_result_size
 
-    # The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] 
-    attr_accessor :new_state
-
-    attr_accessor :ruleset
+    # A list of campaign notification data.
+    attr_accessor :data
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'campaign' => :'campaign',
-        :'old_state' => :'oldState',
-        :'new_state' => :'newState',
-        :'ruleset' => :'ruleset'
+        :'notification_type' => :'NotificationType',
+        :'total_result_size' => :'TotalResultSize',
+        :'data' => :'Data'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'campaign' => :'Campaign',
-        :'old_state' => :'String',
-        :'new_state' => :'String',
-        :'ruleset' => :'Ruleset'
+        :'notification_type' => :'String',
+        :'total_result_size' => :'Integer',
+        :'data' => :'Array<CampaignStateChangedNotificationItem>'
       }
     end
 
@@ -66,20 +62,18 @@ module TalonOne
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'campaign')
-        self.campaign = attributes[:'campaign']
-      end
-
-      if attributes.key?(:'old_state')
-        self.old_state = attributes[:'old_state']
+      if attributes.key?(:'notification_type')
+        self.notification_type = attributes[:'notification_type']
       end
 
-      if attributes.key?(:'new_state')
-        self.new_state = attributes[:'new_state']
+      if attributes.key?(:'total_result_size')
+        self.total_result_size = attributes[:'total_result_size']
       end
 
-      if attributes.key?(:'ruleset')
-        self.ruleset = attributes[:'ruleset']
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
       end
     end
 
@@ -87,16 +81,12 @@ module TalonOne
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @campaign.nil?
-        invalid_properties.push('invalid value for "campaign", campaign cannot be nil.')
-      end
-
-      if @old_state.nil?
-        invalid_properties.push('invalid value for "old_state", old_state cannot be nil.')
+      if @notification_type.nil?
+        invalid_properties.push('invalid value for "notification_type", notification_type cannot be nil.')
       end
 
-      if @new_state.nil?
-        invalid_properties.push('invalid value for "new_state", new_state cannot be nil.')
+      if @total_result_size.nil?
+        invalid_properties.push('invalid value for "total_result_size", total_result_size cannot be nil.')
       end
 
       invalid_properties
@@ -105,9 +95,8 @@ module TalonOne
     # 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 @campaign.nil?
-      return false if @old_state.nil?
-      return false if @new_state.nil?
+      return false if @notification_type.nil?
+      return false if @total_result_size.nil?
       true
     end
 
@@ -116,10 +105,9 @@ module TalonOne
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          campaign == o.campaign &&
-          old_state == o.old_state &&
-          new_state == o.new_state &&
-          ruleset == o.ruleset
+          notification_type == o.notification_type &&
+          total_result_size == o.total_result_size &&
+          data == o.data
     end
 
     # @see the `==` method
@@ -131,7 +119,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [campaign, old_state, new_state, ruleset].hash
+      [notification_type, total_result_size, data].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/campaign_state_changed_notification_item.rb

@@ -0,0 +1,266 @@
+=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
+  # A notification regarding a campaign whose state changed.
+  class CampaignStateChangedNotificationItem
+    # The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] 
+    attr_accessor :event
+
+    attr_accessor :campaign
+
+    # The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] 
+    attr_accessor :old_state
+
+    # The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] 
+    attr_accessor :new_state
+
+    attr_accessor :ruleset
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'event' => :'Event',
+        :'campaign' => :'campaign',
+        :'old_state' => :'oldState',
+        :'new_state' => :'newState',
+        :'ruleset' => :'ruleset'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'event' => :'String',
+        :'campaign' => :'Campaign',
+        :'old_state' => :'String',
+        :'new_state' => :'String',
+        :'ruleset' => :'Ruleset'
+      }
+    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::CampaignStateChangedNotificationItem` 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::CampaignStateChangedNotificationItem`. 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?(:'event')
+        self.event = attributes[:'event']
+      end
+
+      if attributes.key?(:'campaign')
+        self.campaign = attributes[:'campaign']
+      end
+
+      if attributes.key?(:'old_state')
+        self.old_state = attributes[:'old_state']
+      end
+
+      if attributes.key?(:'new_state')
+        self.new_state = attributes[:'new_state']
+      end
+
+      if attributes.key?(:'ruleset')
+        self.ruleset = attributes[:'ruleset']
+      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 @event.nil?
+        invalid_properties.push('invalid value for "event", event cannot be nil.')
+      end
+
+      if @campaign.nil?
+        invalid_properties.push('invalid value for "campaign", campaign cannot be nil.')
+      end
+
+      if @old_state.nil?
+        invalid_properties.push('invalid value for "old_state", old_state cannot be nil.')
+      end
+
+      if @new_state.nil?
+        invalid_properties.push('invalid value for "new_state", new_state 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 @event.nil?
+      return false if @campaign.nil?
+      return false if @old_state.nil?
+      return false if @new_state.nil?
+      true
+    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 &&
+          event == o.event &&
+          campaign == o.campaign &&
+          old_state == o.old_state &&
+          new_state == o.new_state &&
+          ruleset == o.ruleset
+    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
+      [event, campaign, old_state, new_state, ruleset].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/campaign_store_budget.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class CampaignStoreBudget
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.

data/lib/talon_one/models/campaign_template.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class CampaignTemplate
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.