talon_one 8.0.0 → 10.0.0

data/lib/talon_one/models/environment.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class Environment
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.
@@ -59,6 +59,9 @@ module TalonOne
     # The cart item filters belonging to the Application.
     attr_accessor :application_cart_item_filters
 
+    # The price types that this Application can use.
+    attr_accessor :price_types
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -76,7 +79,8 @@ module TalonOne
         :'additional_costs' => :'additionalCosts',
         :'audiences' => :'audiences',
         :'collections' => :'collections',
-        :'application_cart_item_filters' => :'applicationCartItemFilters'
+        :'application_cart_item_filters' => :'applicationCartItemFilters',
+        :'price_types' => :'priceTypes'
       }
     end
 
@@ -97,7 +101,8 @@ module TalonOne
         :'additional_costs' => :'Array<AccountAdditionalCost>',
         :'audiences' => :'Array<Audience>',
         :'collections' => :'Array<Collection>',
-        :'application_cart_item_filters' => :'Array<ApplicationCIF>'
+        :'application_cart_item_filters' => :'Array<ApplicationCIF>',
+        :'price_types' => :'Array<PriceType>'
       }
     end
 
@@ -203,6 +208,12 @@ module TalonOne
           self.application_cart_item_filters = value
         end
       end
+
+      if attributes.key?(:'price_types')
+        if (value = attributes[:'price_types']).is_a?(Array)
+          self.price_types = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -272,7 +283,8 @@ module TalonOne
           additional_costs == o.additional_costs &&
           audiences == o.audiences &&
           collections == o.collections &&
-          application_cart_item_filters == o.application_cart_item_filters
+          application_cart_item_filters == o.application_cart_item_filters &&
+          price_types == o.price_types
     end
 
     # @see the `==` method
@@ -284,7 +296,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, achievements, attributes, additional_costs, audiences, collections, application_cart_item_filters].hash
+      [id, created, application_id, slots, functions, templates, variables, giveaways_pools, loyalty_programs, achievements, attributes, additional_costs, audiences, collections, application_cart_item_filters, price_types].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/event.rb

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

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

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

@@ -0,0 +1,270 @@
+=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 \"extendLoyaltyPointsExpiryDate\" effect. This gets triggered when a validated rule contains the \"extend expiry date\" effect. The current expiry date gets extended by the time frame given in the effect. 
+  class ExtendLoyaltyPointsExpiryDateEffectProps
+    # ID of the loyalty program that contains these points.
+    attr_accessor :program_id
+
+    # API name of the loyalty program subledger that contains these points. added.
+    attr_accessor :sub_ledger_id
+
+    # Time frame by which the expiry date extends.  The time format is either: - immediate, or - an **integer** followed by a letter indicating the time unit.  Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. 
+    attr_accessor :extension_duration
+
+    # The list of identifiers of transactions affected affected by the extension.
+    attr_accessor :transaction_uui_ds
+
+    # Expiry date before applying the extension.
+    attr_accessor :previous_expiration_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'program_id' => :'programId',
+        :'sub_ledger_id' => :'subLedgerId',
+        :'extension_duration' => :'extensionDuration',
+        :'transaction_uui_ds' => :'transactionUUIDs',
+        :'previous_expiration_date' => :'previousExpirationDate'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'program_id' => :'Integer',
+        :'sub_ledger_id' => :'String',
+        :'extension_duration' => :'String',
+        :'transaction_uui_ds' => :'Array<String>',
+        :'previous_expiration_date' => :'DateTime'
+      }
+    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::ExtendLoyaltyPointsExpiryDateEffectProps` 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::ExtendLoyaltyPointsExpiryDateEffectProps`. 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?(:'program_id')
+        self.program_id = attributes[:'program_id']
+      end
+
+      if attributes.key?(:'sub_ledger_id')
+        self.sub_ledger_id = attributes[:'sub_ledger_id']
+      end
+
+      if attributes.key?(:'extension_duration')
+        self.extension_duration = attributes[:'extension_duration']
+      end
+
+      if attributes.key?(:'transaction_uui_ds')
+        if (value = attributes[:'transaction_uui_ds']).is_a?(Array)
+          self.transaction_uui_ds = value
+        end
+      end
+
+      if attributes.key?(:'previous_expiration_date')
+        self.previous_expiration_date = attributes[:'previous_expiration_date']
+      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 @program_id.nil?
+        invalid_properties.push('invalid value for "program_id", program_id cannot be nil.')
+      end
+
+      if @sub_ledger_id.nil?
+        invalid_properties.push('invalid value for "sub_ledger_id", sub_ledger_id cannot be nil.')
+      end
+
+      if @extension_duration.nil?
+        invalid_properties.push('invalid value for "extension_duration", extension_duration cannot be nil.')
+      end
+
+      if @previous_expiration_date.nil?
+        invalid_properties.push('invalid value for "previous_expiration_date", previous_expiration_date 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 @program_id.nil?
+      return false if @sub_ledger_id.nil?
+      return false if @extension_duration.nil?
+      return false if @previous_expiration_date.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 &&
+          program_id == o.program_id &&
+          sub_ledger_id == o.sub_ledger_id &&
+          extension_duration == o.extension_duration &&
+          transaction_uui_ds == o.transaction_uui_ds &&
+          previous_expiration_date == o.previous_expiration_date
+    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
+      [program_id, sub_ledger_id, extension_duration, transaction_uui_ds, previous_expiration_date].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/giveaway.rb

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

@@ -15,7 +15,7 @@ require 'date'
 module TalonOne
   # Giveaways pools is an entity for managing multiple similar giveaways.
   class GiveawaysPool
-    # 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/hidden_conditions_effects.rb

@@ -0,0 +1,246 @@
+=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
+  # Contains information about hidden conditions and effects in the Application.
+  class HiddenConditionsEffects
+    # List of hidden built-in effects.
+    attr_accessor :built_in_effects
+
+    # List of hidden conditions.
+    attr_accessor :conditions
+
+    # List of the IDs of hidden custom effects.
+    attr_accessor :custom_effects
+
+    # List of the IDs of hidden webhooks.
+    attr_accessor :webhooks
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'built_in_effects' => :'builtInEffects',
+        :'conditions' => :'conditions',
+        :'custom_effects' => :'customEffects',
+        :'webhooks' => :'webhooks'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'built_in_effects' => :'Array<String>',
+        :'conditions' => :'Array<String>',
+        :'custom_effects' => :'Array<Integer>',
+        :'webhooks' => :'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::HiddenConditionsEffects` 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::HiddenConditionsEffects`. 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?(:'built_in_effects')
+        if (value = attributes[:'built_in_effects']).is_a?(Array)
+          self.built_in_effects = value
+        end
+      end
+
+      if attributes.key?(:'conditions')
+        if (value = attributes[:'conditions']).is_a?(Array)
+          self.conditions = value
+        end
+      end
+
+      if attributes.key?(:'custom_effects')
+        if (value = attributes[:'custom_effects']).is_a?(Array)
+          self.custom_effects = value
+        end
+      end
+
+      if attributes.key?(:'webhooks')
+        if (value = attributes[:'webhooks']).is_a?(Array)
+          self.webhooks = 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
+      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 &&
+          built_in_effects == o.built_in_effects &&
+          conditions == o.conditions &&
+          custom_effects == o.custom_effects &&
+          webhooks == o.webhooks
+    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
+      [built_in_effects, conditions, custom_effects, webhooks].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/import.rb

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