talon_one 9.0.0 → 10.0.0

data/lib/talon_one/models/application_customer.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class ApplicationCustomer
-    # Internal ID of this entity.
+    # The internal ID of the customer profile.
     attr_accessor :id
 
     # The time this entity was created.
@@ -29,7 +29,7 @@ module TalonOne
     # The ID of the Talon.One account that owns this profile.
     attr_accessor :account_id
 
-    # The total amount of closed sessions by a customer. A closed session is a successful purchase.
+    # The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states).
     attr_accessor :closed_sessions
 
     # The total amount of money spent by the customer **before** discounts are applied.  The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. 

data/lib/talon_one/models/application_event.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class ApplicationEvent
-    # 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/application_session.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class ApplicationSession
-    # 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/attribute.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class Attribute
-    # 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/audience.rb

@@ -17,7 +17,7 @@ module TalonOne
     # The ID of the account that owns this entity.
     attr_accessor :account_id
 
-    # 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/audience_customer.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class AudienceCustomer
-    # Internal ID of this entity.
+    # The internal ID of the customer profile.
     attr_accessor :id
 
     # The time this entity was created.
@@ -29,7 +29,7 @@ module TalonOne
     # The ID of the Talon.One account that owns this profile.
     attr_accessor :account_id
 
-    # The total amount of closed sessions by a customer. A closed session is a successful purchase.
+    # The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states).
     attr_accessor :closed_sessions
 
     # The total amount of money spent by the customer **before** discounts are applied.  The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. 

data/lib/talon_one/models/base_notification.rb

@@ -151,7 +151,7 @@ module TalonOne
       return false if @id.nil?
       return false if @id < 1
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["campaign", "loyalty_added_deducted_points", "card_added_deducted_points", "coupon", "expiring_coupons", "expiring_points", "card_expiring_points", "pending_to_active_points", "strikethrough_pricing", "tier_downgrade", "tier_upgrade", "tier_will_downgrade"])
+      type_validator = EnumAttributeValidator.new('String', ["campaign", "loyalty_added_deducted_points", "card_added_deducted_points", "loyalty_added_deducted_points_balances", "loyalty_card_added_deducted_points_balances", "coupon", "expiring_coupons", "expiring_points", "card_expiring_points", "pending_to_active_points", "strikethrough_pricing", "tier_downgrade", "tier_upgrade", "tier_will_downgrade"])
       return false unless type_validator.valid?(@type)
       true
     end
@@ -173,7 +173,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["campaign", "loyalty_added_deducted_points", "card_added_deducted_points", "coupon", "expiring_coupons", "expiring_points", "card_expiring_points", "pending_to_active_points", "strikethrough_pricing", "tier_downgrade", "tier_upgrade", "tier_will_downgrade"])
+      validator = EnumAttributeValidator.new('String', ["campaign", "loyalty_added_deducted_points", "card_added_deducted_points", "loyalty_added_deducted_points_balances", "loyalty_card_added_deducted_points_balances", "coupon", "expiring_coupons", "expiring_points", "card_expiring_points", "pending_to_active_points", "strikethrough_pricing", "tier_downgrade", "tier_upgrade", "tier_will_downgrade"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

data/lib/talon_one/models/base_notification_webhook.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class BaseNotificationWebhook
-    # 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/binding.rb

@@ -26,13 +26,29 @@ module TalonOne
     # Can be one of the following: - `string` - `number` - `boolean` 
     attr_accessor :value_type
 
+    # The minimum value allowed for this placeholder.
+    attr_accessor :min_value
+
+    # The maximum value allowed for this placeholder.
+    attr_accessor :max_value
+
+    # Id of the attribute attached to the placeholder.
+    attr_accessor :attribute_id
+
+    # Describes the placeholder field and value in the template. This description can be used when creating campaigns from this template.
+    attr_accessor :description
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'type' => :'type',
         :'expression' => :'expression',
-        :'value_type' => :'valueType'
+        :'value_type' => :'valueType',
+        :'min_value' => :'minValue',
+        :'max_value' => :'maxValue',
+        :'attribute_id' => :'attributeId',
+        :'description' => :'description'
       }
     end
 
@@ -42,7 +58,11 @@ module TalonOne
         :'name' => :'String',
         :'type' => :'String',
         :'expression' => :'Array<Object>',
-        :'value_type' => :'String'
+        :'value_type' => :'String',
+        :'min_value' => :'Float',
+        :'max_value' => :'Float',
+        :'attribute_id' => :'Integer',
+        :'description' => :'String'
       }
     end
 
@@ -84,6 +104,22 @@ module TalonOne
       if attributes.key?(:'value_type')
         self.value_type = attributes[:'value_type']
       end
+
+      if attributes.key?(:'min_value')
+        self.min_value = attributes[:'min_value']
+      end
+
+      if attributes.key?(:'max_value')
+        self.max_value = attributes[:'max_value']
+      end
+
+      if attributes.key?(:'attribute_id')
+        self.attribute_id = attributes[:'attribute_id']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -117,7 +153,11 @@ module TalonOne
           name == o.name &&
           type == o.type &&
           expression == o.expression &&
-          value_type == o.value_type
+          value_type == o.value_type &&
+          min_value == o.min_value &&
+          max_value == o.max_value &&
+          attribute_id == o.attribute_id &&
+          description == o.description
     end
 
     # @see the `==` method
@@ -129,7 +169,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, type, expression, value_type].hash
+      [name, type, expression, value_type, min_value, max_value, attribute_id, description].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/campaign_collection.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class CampaignCollection
-    # 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_collection_without_payload.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class CampaignCollectionWithoutPayload
-    # 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_deactivation_request.rb

@@ -0,0 +1,214 @@
+=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 CampaignDeactivationRequest
+    # The list of IDs of the users receiving the deactivation request emails.
+    attr_accessor :user_ids
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'user_ids' => :'userIds'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'user_ids' => :'Array<Integer>'
+      }
+    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::CampaignDeactivationRequest` 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::CampaignDeactivationRequest`. 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?(:'user_ids')
+        if (value = attributes[:'user_ids']).is_a?(Array)
+          self.user_ids = 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 @user_ids.nil?
+        invalid_properties.push('invalid value for "user_ids", user_ids 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 @user_ids.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 &&
+          user_ids == o.user_ids
+    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
+      [user_ids].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_group.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class CampaignGroup
-    # 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_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_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.