talon_one 3.0.2 → 4.0.0

data/lib/talon_one/models/remove_from_audience_effect_props.rb

@@ -0,0 +1,238 @@
+=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
+  # The properties specific to the \"removeFromAudience\" effect. This gets triggered whenever a validated rule contains a \"removeFromAudience\" effect.
+  class RemoveFromAudienceEffectProps
+    # The internal ID of the audience.
+    attr_accessor :audience_id
+
+    # The name of the audience.
+    attr_accessor :audience_name
+
+    # The ID of the customer profile in the third-party integration platform.
+    attr_accessor :profile_integration_id
+
+    # The internal ID of the customer profile.
+    attr_accessor :profile_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'audience_id' => :'audienceId',
+        :'audience_name' => :'audienceName',
+        :'profile_integration_id' => :'profileIntegrationId',
+        :'profile_id' => :'profileId'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'audience_id' => :'Integer',
+        :'audience_name' => :'String',
+        :'profile_integration_id' => :'String',
+        :'profile_id' => :'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::RemoveFromAudienceEffectProps` 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::RemoveFromAudienceEffectProps`. 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?(:'audience_id')
+        self.audience_id = attributes[:'audience_id']
+      end
+
+      if attributes.key?(:'audience_name')
+        self.audience_name = attributes[:'audience_name']
+      end
+
+      if attributes.key?(:'profile_integration_id')
+        self.profile_integration_id = attributes[:'profile_integration_id']
+      end
+
+      if attributes.key?(:'profile_id')
+        self.profile_id = attributes[:'profile_id']
+      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?
+      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 &&
+          audience_id == o.audience_id &&
+          audience_name == o.audience_name &&
+          profile_integration_id == o.profile_integration_id &&
+          profile_id == o.profile_id
+    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
+      [audience_id, audience_name, profile_integration_id, profile_id].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/returned_cart_item.rb

@@ -17,7 +17,7 @@ module TalonOne
     # The index of the cart item in the provided customer session's `cartItems` property.
     attr_accessor :position
 
-    # Number of cart items to return. It is only available when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) is enabled. If cart item flattening is disabled, the cart item can only be returned in its entirety. 
+    # Number of cart items to return. 
     attr_accessor :quantity
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/talon_one/models/role.rb

@@ -27,7 +27,7 @@ module TalonOne
     # The ID of the account that owns this entity.
     attr_accessor :account_id
 
-    # The ID of the [Campaign Group](https://docs.talon.one/docs/product/account/managing-campaign-groups) this role was created for. 
+    # The ID of the [Campaign Group](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this role was created for. 
     attr_accessor :campaign_group_id
 
     # Name of the role.

data/lib/talon_one/models/role_assign.rb

@@ -15,10 +15,10 @@ require 'date'
 module TalonOne
   # 
   class RoleAssign
-    # An array of userIDs.
+    # An array of user IDs.
     attr_accessor :users
 
-    # An array of roleIDs.
+    # An array of role IDs.
     attr_accessor :roles
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/talon_one/models/role_v2.rb

@@ -13,27 +13,40 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
+  # 
   class RoleV2
+    # Internal ID of this entity.
+    attr_accessor :id
+
+    # The time this entity was created.
+    attr_accessor :created
+
+    # The time this entity was last modified.
+    attr_accessor :modified
+
+    # The ID of the account that owns this entity.
+    attr_accessor :account_id
+
     # Name of the role.
     attr_accessor :name
 
     # Description of the role.
     attr_accessor :description
 
-    # Indicates whether the role grants admin permissions.
-    attr_accessor :is_admin
-
     attr_accessor :permissions
 
-    # An array of user identifiers.
+    # A list of user IDs the role is assigned to.
     attr_accessor :members
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'id' => :'id',
+        :'created' => :'created',
+        :'modified' => :'modified',
+        :'account_id' => :'accountId',
         :'name' => :'name',
         :'description' => :'description',
-        :'is_admin' => :'isAdmin',
         :'permissions' => :'permissions',
         :'members' => :'members'
       }
@@ -42,9 +55,12 @@ module TalonOne
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'id' => :'Integer',
+        :'created' => :'DateTime',
+        :'modified' => :'DateTime',
+        :'account_id' => :'Integer',
         :'name' => :'String',
         :'description' => :'String',
-        :'is_admin' => :'Boolean',
         :'permissions' => :'RoleV2Permissions',
         :'members' => :'Array<Integer>'
       }
@@ -71,6 +87,22 @@ module TalonOne
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'created')
+        self.created = attributes[:'created']
+      end
+
+      if attributes.key?(:'modified')
+        self.modified = attributes[:'modified']
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -79,10 +111,6 @@ module TalonOne
         self.description = attributes[:'description']
       end
 
-      if attributes.key?(:'is_admin')
-        self.is_admin = attributes[:'is_admin']
-      end
-
       if attributes.key?(:'permissions')
         self.permissions = attributes[:'permissions']
       end
@@ -98,12 +126,32 @@ module TalonOne
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @created.nil?
+        invalid_properties.push('invalid value for "created", created cannot be nil.')
+      end
+
+      if @modified.nil?
+        invalid_properties.push('invalid value for "modified", modified cannot be nil.')
+      end
+
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id 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 @id.nil?
+      return false if @created.nil?
+      return false if @modified.nil?
+      return false if @account_id.nil?
       true
     end
 
@@ -112,9 +160,12 @@ module TalonOne
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          id == o.id &&
+          created == o.created &&
+          modified == o.modified &&
+          account_id == o.account_id &&
           name == o.name &&
           description == o.description &&
-          is_admin == o.is_admin &&
           permissions == o.permissions &&
           members == o.members
     end
@@ -128,7 +179,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, is_admin, permissions, members].hash
+      [id, created, modified, account_id, name, description, permissions, members].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/role_v2_application_details.rb

@@ -14,21 +14,25 @@ require 'date'
 
 module TalonOne
   class RoleV2ApplicationDetails
-    # Name of the Application-level permission set.
+    # Name of the Application-related permission set for the given Application.
     attr_accessor :application
 
-    # Name of the campaign-level permission set.
+    # Name of the campaign-related permission set for the given Application.
     attr_accessor :campaign
 
-    # Name of the draft campaign-level permission set.
+    # Name of the draft campaign-related permission set for the given Application.
     attr_accessor :draft_campaign
 
+    # Name of the tools-related permission set.
+    attr_accessor :tools
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'application' => :'application',
         :'campaign' => :'campaign',
-        :'draft_campaign' => :'draftCampaign'
+        :'draft_campaign' => :'draftCampaign',
+        :'tools' => :'tools'
       }
     end
 
@@ -37,7 +41,8 @@ module TalonOne
       {
         :'application' => :'String',
         :'campaign' => :'String',
-        :'draft_campaign' => :'String'
+        :'draft_campaign' => :'String',
+        :'tools' => :'String'
       }
     end
 
@@ -73,6 +78,10 @@ module TalonOne
       if attributes.key?(:'draft_campaign')
         self.draft_campaign = attributes[:'draft_campaign']
       end
+
+      if attributes.key?(:'tools')
+        self.tools = attributes[:'tools']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -95,7 +104,8 @@ module TalonOne
       self.class == o.class &&
           application == o.application &&
           campaign == o.campaign &&
-          draft_campaign == o.draft_campaign
+          draft_campaign == o.draft_campaign &&
+          tools == o.tools
     end
 
     # @see the `==` method
@@ -107,7 +117,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [application, campaign, draft_campaign].hash
+      [application, campaign, draft_campaign, tools].hash
     end
 
     # Builds the object from hash