talon_one 2.3.0 → 2.4.0

data/lib/talon_one/models/custom_effect_props.rb

@@ -0,0 +1,228 @@
+=begin
+#Talon.One API
+
+#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put 
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module TalonOne
+  # Effect containing custom payload.
+  class CustomEffectProps
+    # The type of the custom effect.
+    attr_accessor :type
+
+    # The JSON payload of the custom effect.
+    attr_accessor :payload
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'payload' => :'payload'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'payload' => :'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::CustomEffectProps` 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::CustomEffectProps`. 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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'payload')
+        self.payload = attributes[:'payload']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @payload.nil?
+        invalid_properties.push('invalid value for "payload", payload 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 @type.nil?
+      return false if @payload.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 &&
+          type == o.type &&
+          payload == o.payload
+    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
+      [type, payload].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/customer_inventory.rb

@@ -22,13 +22,16 @@ module TalonOne
 
     attr_accessor :coupons
 
+    attr_accessor :giveaways
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'profile' => :'profile',
         :'loyalty' => :'loyalty',
         :'referrals' => :'referrals',
-        :'coupons' => :'coupons'
+        :'coupons' => :'coupons',
+        :'giveaways' => :'giveaways'
       }
     end
 
@@ -38,7 +41,8 @@ module TalonOne
         :'profile' => :'CustomerProfile',
         :'loyalty' => :'Loyalty',
         :'referrals' => :'Array<Referral>',
-        :'coupons' => :'Array<Coupon>'
+        :'coupons' => :'Array<InventoryCoupon>',
+        :'giveaways' => :'Array<Giveaway>'
       }
     end
 
@@ -82,6 +86,12 @@ module TalonOne
           self.coupons = value
         end
       end
+
+      if attributes.key?(:'giveaways')
+        if (value = attributes[:'giveaways']).is_a?(Array)
+          self.giveaways = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -105,7 +115,8 @@ module TalonOne
           profile == o.profile &&
           loyalty == o.loyalty &&
           referrals == o.referrals &&
-          coupons == o.coupons
+          coupons == o.coupons &&
+          giveaways == o.giveaways
     end
 
     # @see the `==` method
@@ -117,7 +128,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [profile, loyalty, referrals, coupons].hash
+      [profile, loyalty, referrals, coupons, giveaways].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/customer_profile_integration_request_v2.rb

@@ -20,7 +20,7 @@ module TalonOne
 
     attr_accessor :audiences_changes
 
-    # Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\", \"event\" and \"ruleFailureReasons\". 
+    # Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\", \"event\", \"awardedGiveaways\", \"ruleFailureReasons\". 
     attr_accessor :response_content
 
     class EnumAttributeValidator

data/lib/talon_one/models/environment.rb

@@ -33,6 +33,21 @@ module TalonOne
     # The templates defined for this application.
     attr_accessor :templates
 
+    # The giveaways pools that the application is subscribed to.
+    attr_accessor :giveaways_pools
+
+    # The loyalty programs that the application is subscribed to.
+    attr_accessor :loyalty_programs
+
+    # The attributes that the application is subscribed to.
+    attr_accessor :attributes
+
+    # The additional costs that the application is subscribed to.
+    attr_accessor :additional_costs
+
+    # The audiences contained in the account which the application belongs to.
+    attr_accessor :audiences
+
     attr_accessor :variables
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -44,6 +59,11 @@ module TalonOne
         :'slots' => :'slots',
         :'functions' => :'functions',
         :'templates' => :'templates',
+        :'giveaways_pools' => :'giveawaysPools',
+        :'loyalty_programs' => :'loyaltyPrograms',
+        :'attributes' => :'attributes',
+        :'additional_costs' => :'additionalCosts',
+        :'audiences' => :'audiences',
         :'variables' => :'variables'
       }
     end
@@ -57,6 +77,11 @@ module TalonOne
         :'slots' => :'Array<SlotDef>',
         :'functions' => :'Array<FunctionDef>',
         :'templates' => :'Array<TemplateDef>',
+        :'giveaways_pools' => :'Array<GiveawaysPool>',
+        :'loyalty_programs' => :'Array<LoyaltyProgram>',
+        :'attributes' => :'Array<Attribute>',
+        :'additional_costs' => :'Array<AccountAdditionalCost>',
+        :'audiences' => :'Array<Audience>',
         :'variables' => :'String'
       }
     end
@@ -112,6 +137,36 @@ module TalonOne
         end
       end
 
+      if attributes.key?(:'giveaways_pools')
+        if (value = attributes[:'giveaways_pools']).is_a?(Array)
+          self.giveaways_pools = value
+        end
+      end
+
+      if attributes.key?(:'loyalty_programs')
+        if (value = attributes[:'loyalty_programs']).is_a?(Array)
+          self.loyalty_programs = value
+        end
+      end
+
+      if attributes.key?(:'attributes')
+        if (value = attributes[:'attributes']).is_a?(Array)
+          self.attributes = value
+        end
+      end
+
+      if attributes.key?(:'additional_costs')
+        if (value = attributes[:'additional_costs']).is_a?(Array)
+          self.additional_costs = value
+        end
+      end
+
+      if attributes.key?(:'audiences')
+        if (value = attributes[:'audiences']).is_a?(Array)
+          self.audiences = value
+        end
+      end
+
       if attributes.key?(:'variables')
         self.variables = attributes[:'variables']
       end
@@ -176,6 +231,11 @@ module TalonOne
           slots == o.slots &&
           functions == o.functions &&
           templates == o.templates &&
+          giveaways_pools == o.giveaways_pools &&
+          loyalty_programs == o.loyalty_programs &&
+          attributes == o.attributes &&
+          additional_costs == o.additional_costs &&
+          audiences == o.audiences &&
           variables == o.variables
     end
 
@@ -188,7 +248,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, application_id, slots, functions, templates, variables].hash
+      [id, created, application_id, slots, functions, templates, giveaways_pools, loyalty_programs, attributes, additional_costs, audiences, variables].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/export.rb

@@ -164,7 +164,7 @@ module TalonOne
       return false if @account_id.nil?
       return false if @user_id.nil?
       return false if @entity.nil?
-      entity_validator = EnumAttributeValidator.new('String', ["Coupon", "Effect", "CustomerSession"])
+      entity_validator = EnumAttributeValidator.new('String', ["Coupon", "Effect", "CustomerSession", "LoyaltyLedger", "LoyaltyLedgerLog"])
       return false unless entity_validator.valid?(@entity)
       return false if @filter.nil?
       true
@@ -173,7 +173,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] entity Object to be assigned
     def entity=(entity)
-      validator = EnumAttributeValidator.new('String', ["Coupon", "Effect", "CustomerSession"])
+      validator = EnumAttributeValidator.new('String', ["Coupon", "Effect", "CustomerSession", "LoyaltyLedger", "LoyaltyLedgerLog"])
       unless validator.valid?(entity)
         fail ArgumentError, "invalid value for \"entity\", must be one of #{validator.allowable_values}."
       end

data/lib/talon_one/models/giveaway.rb

@@ -0,0 +1,308 @@
+=begin
+#Talon.One API
+
+#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put 
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module TalonOne
+  # 
+  class Giveaway
+    # Unique ID for this entity.
+    attr_accessor :id
+
+    # The exact moment this entity was created.
+    attr_accessor :created
+
+    # The code value of this giveaway.
+    attr_accessor :code
+
+    # The ID of the pool to return giveaway codes from.
+    attr_accessor :pool_id
+
+    # Timestamp at which point the giveaway becomes valid.
+    attr_accessor :start_date
+
+    # Timestamp at which point the giveaway becomes invalid.
+    attr_accessor :end_date
+
+    # Arbitrary properties associated with this giveaway.
+    attr_accessor :attributes
+
+    # Flag indicating whether this giveaway code was given before.
+    attr_accessor :used
+
+    # The ID of the Import which created this giveaway.
+    attr_accessor :import_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'created' => :'created',
+        :'code' => :'code',
+        :'pool_id' => :'poolId',
+        :'start_date' => :'startDate',
+        :'end_date' => :'endDate',
+        :'attributes' => :'attributes',
+        :'used' => :'used',
+        :'import_id' => :'importId'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'Integer',
+        :'created' => :'DateTime',
+        :'code' => :'String',
+        :'pool_id' => :'Integer',
+        :'start_date' => :'DateTime',
+        :'end_date' => :'DateTime',
+        :'attributes' => :'Object',
+        :'used' => :'Boolean',
+        :'import_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::Giveaway` 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::Giveaway`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'created')
+        self.created = attributes[:'created']
+      end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'pool_id')
+        self.pool_id = attributes[:'pool_id']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      end
+
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      end
+
+      if attributes.key?(:'used')
+        self.used = attributes[:'used']
+      end
+
+      if attributes.key?(:'import_id')
+        self.import_id = attributes[:'import_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
+      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 @code.nil?
+        invalid_properties.push('invalid value for "code", code cannot be nil.')
+      end
+
+      if @pool_id.nil?
+        invalid_properties.push('invalid value for "pool_id", pool_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 @code.nil?
+      return false if @pool_id.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 &&
+          id == o.id &&
+          created == o.created &&
+          code == o.code &&
+          pool_id == o.pool_id &&
+          start_date == o.start_date &&
+          end_date == o.end_date &&
+          attributes == o.attributes &&
+          used == o.used &&
+          import_id == o.import_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
+      [id, created, code, pool_id, start_date, end_date, attributes, used, import_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