talon_one 3.0.2 → 4.0.0

data/lib/talon_one/models/delete_user_request.rb

@@ -0,0 +1,213 @@
+=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 DeleteUserRequest
+    # The email address associated with the user profile.
+    attr_accessor :email
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'email' => :'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::DeleteUserRequest` 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::DeleteUserRequest`. 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?(:'email')
+        self.email = attributes[:'email']
+      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 @email.nil?
+        invalid_properties.push('invalid value for "email", email 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 @email.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 &&
+          email == o.email
+    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
+      [email].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/effect.rb

@@ -36,6 +36,9 @@ module TalonOne
     # The ID of the catalog item that was being evaluated when this effect was triggered.
     attr_accessor :triggered_for_catalog_item
 
+    # The index of the condition that was triggered.
+    attr_accessor :condition_index
+
     # The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects).
     attr_accessor :props
 
@@ -49,6 +52,7 @@ module TalonOne
         :'effect_type' => :'effectType',
         :'triggered_by_coupon' => :'triggeredByCoupon',
         :'triggered_for_catalog_item' => :'triggeredForCatalogItem',
+        :'condition_index' => :'conditionIndex',
         :'props' => :'props'
       }
     end
@@ -63,6 +67,7 @@ module TalonOne
         :'effect_type' => :'String',
         :'triggered_by_coupon' => :'Integer',
         :'triggered_for_catalog_item' => :'Integer',
+        :'condition_index' => :'Integer',
         :'props' => :'Object'
       }
     end
@@ -116,6 +121,10 @@ module TalonOne
         self.triggered_for_catalog_item = attributes[:'triggered_for_catalog_item']
       end
 
+      if attributes.key?(:'condition_index')
+        self.condition_index = attributes[:'condition_index']
+      end
+
       if attributes.key?(:'props')
         self.props = attributes[:'props']
       end
@@ -176,6 +185,7 @@ module TalonOne
           effect_type == o.effect_type &&
           triggered_by_coupon == o.triggered_by_coupon &&
           triggered_for_catalog_item == o.triggered_for_catalog_item &&
+          condition_index == o.condition_index &&
           props == o.props
     end
 
@@ -188,7 +198,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [campaign_id, ruleset_id, rule_index, rule_name, effect_type, triggered_by_coupon, triggered_for_catalog_item, props].hash
+      [campaign_id, ruleset_id, rule_index, rule_name, effect_type, triggered_by_coupon, triggered_for_catalog_item, condition_index, props].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/effect_entity.rb

@@ -36,6 +36,9 @@ module TalonOne
     # The ID of the catalog item that was being evaluated when this effect was triggered.
     attr_accessor :triggered_for_catalog_item
 
+    # The index of the condition that was triggered.
+    attr_accessor :condition_index
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -45,7 +48,8 @@ module TalonOne
         :'rule_name' => :'ruleName',
         :'effect_type' => :'effectType',
         :'triggered_by_coupon' => :'triggeredByCoupon',
-        :'triggered_for_catalog_item' => :'triggeredForCatalogItem'
+        :'triggered_for_catalog_item' => :'triggeredForCatalogItem',
+        :'condition_index' => :'conditionIndex'
       }
     end
 
@@ -58,7 +62,8 @@ module TalonOne
         :'rule_name' => :'String',
         :'effect_type' => :'String',
         :'triggered_by_coupon' => :'Integer',
-        :'triggered_for_catalog_item' => :'Integer'
+        :'triggered_for_catalog_item' => :'Integer',
+        :'condition_index' => :'Integer'
       }
     end
 
@@ -110,6 +115,10 @@ module TalonOne
       if attributes.key?(:'triggered_for_catalog_item')
         self.triggered_for_catalog_item = attributes[:'triggered_for_catalog_item']
       end
+
+      if attributes.key?(:'condition_index')
+        self.condition_index = attributes[:'condition_index']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -161,7 +170,8 @@ module TalonOne
           rule_name == o.rule_name &&
           effect_type == o.effect_type &&
           triggered_by_coupon == o.triggered_by_coupon &&
-          triggered_for_catalog_item == o.triggered_for_catalog_item
+          triggered_for_catalog_item == o.triggered_for_catalog_item &&
+          condition_index == o.condition_index
     end
 
     # @see the `==` method
@@ -173,7 +183,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [campaign_id, ruleset_id, rule_index, rule_name, effect_type, triggered_by_coupon, triggered_for_catalog_item].hash
+      [campaign_id, ruleset_id, rule_index, rule_name, effect_type, triggered_by_coupon, triggered_for_catalog_item, condition_index].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/email_entity.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class EmailEntity
-    # The email address associated with your account.
+    # The email address associated with the user profile.
     attr_accessor :email
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/talon_one/models/environment.rb

@@ -42,6 +42,9 @@ module TalonOne
     # The loyalty programs that the application is subscribed to.
     attr_accessor :loyalty_programs
 
+    # The achievements, linked to the campaigns, belonging to the application.
+    attr_accessor :achievements
+
     # The attributes that the application is subscribed to.
     attr_accessor :attributes
 
@@ -66,6 +69,7 @@ module TalonOne
         :'variables' => :'variables',
         :'giveaways_pools' => :'giveawaysPools',
         :'loyalty_programs' => :'loyaltyPrograms',
+        :'achievements' => :'achievements',
         :'attributes' => :'attributes',
         :'additional_costs' => :'additionalCosts',
         :'audiences' => :'audiences',
@@ -85,6 +89,7 @@ module TalonOne
         :'variables' => :'String',
         :'giveaways_pools' => :'Array<GiveawaysPool>',
         :'loyalty_programs' => :'Array<LoyaltyProgram>',
+        :'achievements' => :'Array<Achievement>',
         :'attributes' => :'Array<Attribute>',
         :'additional_costs' => :'Array<AccountAdditionalCost>',
         :'audiences' => :'Array<Audience>',
@@ -159,6 +164,12 @@ module TalonOne
         end
       end
 
+      if attributes.key?(:'achievements')
+        if (value = attributes[:'achievements']).is_a?(Array)
+          self.achievements = value
+        end
+      end
+
       if attributes.key?(:'attributes')
         if (value = attributes[:'attributes']).is_a?(Array)
           self.attributes = value
@@ -246,6 +257,7 @@ module TalonOne
           variables == o.variables &&
           giveaways_pools == o.giveaways_pools &&
           loyalty_programs == o.loyalty_programs &&
+          achievements == o.achievements &&
           attributes == o.attributes &&
           additional_costs == o.additional_costs &&
           audiences == o.audiences &&
@@ -261,7 +273,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, application_id, slots, functions, templates, variables, giveaways_pools, loyalty_programs, attributes, additional_costs, audiences, collections].hash
+      [id, created, application_id, slots, functions, templates, variables, giveaways_pools, loyalty_programs, achievements, attributes, additional_costs, audiences, collections].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/event.rb

@@ -27,6 +27,9 @@ module TalonOne
     # ID of the customer profile set by your integration layer.  **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. 
     attr_accessor :profile_id
 
+    # The integration ID of the store. You choose this ID when you create a store.
+    attr_accessor :store_integration_id
+
     # A string representing the event. Must not be a reserved event name.
     attr_accessor :type
 
@@ -51,6 +54,7 @@ module TalonOne
         :'created' => :'created',
         :'application_id' => :'applicationId',
         :'profile_id' => :'profileId',
+        :'store_integration_id' => :'storeIntegrationId',
         :'type' => :'type',
         :'attributes' => :'attributes',
         :'session_id' => :'sessionId',
@@ -67,6 +71,7 @@ module TalonOne
         :'created' => :'DateTime',
         :'application_id' => :'Integer',
         :'profile_id' => :'String',
+        :'store_integration_id' => :'String',
         :'type' => :'String',
         :'attributes' => :'Object',
         :'session_id' => :'String',
@@ -113,6 +118,10 @@ module TalonOne
         self.profile_id = attributes[:'profile_id']
       end
 
+      if attributes.key?(:'store_integration_id')
+        self.store_integration_id = attributes[:'store_integration_id']
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
@@ -158,6 +167,14 @@ module TalonOne
         invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
       end
 
+      if !@store_integration_id.nil? && @store_integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "store_integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
+      if !@store_integration_id.nil? && @store_integration_id.to_s.length < 1
+        invalid_properties.push('invalid value for "store_integration_id", the character length must be great than or equal to 1.')
+      end
+
       if @type.nil?
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
@@ -187,6 +204,8 @@ module TalonOne
       return false if @id.nil?
       return false if @created.nil?
       return false if @application_id.nil?
+      return false if !@store_integration_id.nil? && @store_integration_id.to_s.length > 1000
+      return false if !@store_integration_id.nil? && @store_integration_id.to_s.length < 1
       return false if @type.nil?
       return false if @type.to_s.length < 1
       return false if @attributes.nil?
@@ -195,6 +214,20 @@ module TalonOne
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] store_integration_id Value to be assigned
+    def store_integration_id=(store_integration_id)
+      if !store_integration_id.nil? && store_integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "store_integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      if !store_integration_id.nil? && store_integration_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "store_integration_id", the character length must be great than or equal to 1.'
+      end
+
+      @store_integration_id = store_integration_id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] type Value to be assigned
     def type=(type)
@@ -218,6 +251,7 @@ module TalonOne
           created == o.created &&
           application_id == o.application_id &&
           profile_id == o.profile_id &&
+          store_integration_id == o.store_integration_id &&
           type == o.type &&
           attributes == o.attributes &&
           session_id == o.session_id &&
@@ -235,7 +269,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, application_id, profile_id, type, attributes, session_id, effects, ledger_entries, meta].hash
+      [id, created, application_id, profile_id, store_integration_id, type, attributes, session_id, effects, ledger_entries, meta].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/event_v2.rb

@@ -18,19 +18,23 @@ module TalonOne
     # ID of the customer profile set by your integration layer.  **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. 
     attr_accessor :profile_id
 
+    # The integration ID of the store. You choose this ID when you create a store.
+    attr_accessor :store_integration_id
+
     # When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine.  These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. 
     attr_accessor :evaluable_campaign_ids
 
-    # A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event) of type `event` in the Campaign Manager. 
+    # A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager. 
     attr_accessor :type
 
-    # Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-custom-attributes).
+    # Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute).
     attr_accessor :attributes
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'profile_id' => :'profileId',
+        :'store_integration_id' => :'storeIntegrationId',
         :'evaluable_campaign_ids' => :'evaluableCampaignIds',
         :'type' => :'type',
         :'attributes' => :'attributes'
@@ -41,6 +45,7 @@ module TalonOne
     def self.openapi_types
       {
         :'profile_id' => :'String',
+        :'store_integration_id' => :'String',
         :'evaluable_campaign_ids' => :'Array<Integer>',
         :'type' => :'String',
         :'attributes' => :'Object'
@@ -72,6 +77,10 @@ module TalonOne
         self.profile_id = attributes[:'profile_id']
       end
 
+      if attributes.key?(:'store_integration_id')
+        self.store_integration_id = attributes[:'store_integration_id']
+      end
+
       if attributes.key?(:'evaluable_campaign_ids')
         if (value = attributes[:'evaluable_campaign_ids']).is_a?(Array)
           self.evaluable_campaign_ids = value
@@ -91,6 +100,14 @@ module TalonOne
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@store_integration_id.nil? && @store_integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "store_integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
+      if !@store_integration_id.nil? && @store_integration_id.to_s.length < 1
+        invalid_properties.push('invalid value for "store_integration_id", the character length must be great than or equal to 1.')
+      end
+
       if @type.nil?
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
@@ -105,11 +122,27 @@ 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 !@store_integration_id.nil? && @store_integration_id.to_s.length > 1000
+      return false if !@store_integration_id.nil? && @store_integration_id.to_s.length < 1
       return false if @type.nil?
       return false if @type.to_s.length < 1
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] store_integration_id Value to be assigned
+    def store_integration_id=(store_integration_id)
+      if !store_integration_id.nil? && store_integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "store_integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      if !store_integration_id.nil? && store_integration_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "store_integration_id", the character length must be great than or equal to 1.'
+      end
+
+      @store_integration_id = store_integration_id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] type Value to be assigned
     def type=(type)
@@ -130,6 +163,7 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           profile_id == o.profile_id &&
+          store_integration_id == o.store_integration_id &&
           evaluable_campaign_ids == o.evaluable_campaign_ids &&
           type == o.type &&
           attributes == o.attributes
@@ -144,7 +178,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [profile_id, evaluable_campaign_ids, type, attributes].hash
+      [profile_id, store_integration_id, evaluable_campaign_ids, type, attributes].hash
     end
 
     # Builds the object from hash