talon_one 3.0.1 → 4.0.0

data/lib/talon_one/models/message_log_response.rb

@@ -0,0 +1,264 @@
+=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
+  # Details of the response.
+  class MessageLogResponse
+    # Timestamp when the response was received.
+    attr_accessor :created_at
+
+    # Raw response data.
+    attr_accessor :response
+
+    # HTTP status code of the response.
+    attr_accessor :status
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'created_at' => :'createdAt',
+        :'response' => :'response',
+        :'status' => :'status'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'created_at' => :'DateTime',
+        :'response' => :'String',
+        :'status' => :'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::MessageLogResponse` 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::MessageLogResponse`. 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?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'response')
+        self.response = attributes[:'response']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      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 @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @response.nil?
+        invalid_properties.push('invalid value for "response", response cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+      if @response !~ pattern
+        invalid_properties.push("invalid value for \"response\", must conform to the pattern #{pattern}.")
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status 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 @created_at.nil?
+      return false if @response.nil?
+      return false if @response !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+      return false if @status.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] response Value to be assigned
+    def response=(response)
+      if response.nil?
+        fail ArgumentError, 'response cannot be nil'
+      end
+
+      pattern = Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+      if response !~ pattern
+        fail ArgumentError, "invalid value for \"response\", must conform to the pattern #{pattern}."
+      end
+
+      @response = response
+    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 &&
+          created_at == o.created_at &&
+          response == o.response &&
+          status == o.status
+    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
+      [created_at, response, status].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/new_account_sign_up.rb

@@ -15,7 +15,7 @@ require 'date'
 module TalonOne
   # 
   class NewAccountSignUp
-    # The email address associated with your account.
+    # The email address associated with the user profile.
     attr_accessor :email
 
     # The password for your account.

data/lib/talon_one/models/new_additional_cost.rb

@@ -128,7 +128,7 @@ module TalonOne
         invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
-      pattern = Regexp.new(/^[A-Za-z](\w|\s)*$/)
+      pattern = Regexp.new(/^[A-Za-z]\w*$/)
       if @name !~ pattern
         invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
       end
@@ -153,7 +153,7 @@ module TalonOne
     # @return true if the model is valid
     def valid?
       return false if @name.nil?
-      return false if @name !~ Regexp.new(/^[A-Za-z](\w|\s)*$/)
+      return false if @name !~ Regexp.new(/^[A-Za-z]\w*$/)
       return false if @title.nil?
       return false if @title !~ Regexp.new(/^[A-Za-z][A-Za-z0-9_.!~*'() -]*$/)
       return false if @description.nil?
@@ -169,7 +169,7 @@ module TalonOne
         fail ArgumentError, 'name cannot be nil'
       end
 
-      pattern = Regexp.new(/^[A-Za-z](\w|\s)*$/)
+      pattern = Regexp.new(/^[A-Za-z]\w*$/)
       if name !~ pattern
         fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
       end

data/lib/talon_one/models/new_application.rb

@@ -13,7 +13,6 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module TalonOne
-  # 
   class NewApplication
     # The name of this application.
     attr_accessor :name
@@ -36,19 +35,13 @@ module TalonOne
     # Default limits for campaigns created in this application.
     attr_accessor :limits
 
-    # Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns created in this Application. 
-    attr_accessor :campaign_priority
-
-    # The strategy used when choosing exclusive campaigns for evaluation.
-    attr_accessor :exclusive_campaigns_strategy
-
     # The default scope to apply `setDiscount` effects on if no scope was provided with the effect. 
     attr_accessor :default_discount_scope
 
     # Indicates if discounts should cascade for this Application.
     attr_accessor :enable_cascading_discounts
 
-    # Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See the [docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening). 
+    # Indicates if cart items of quantity larger than one should be separated into different items of quantity one. 
     attr_accessor :enable_flattened_cart_items
 
     attr_accessor :attributes_settings
@@ -97,8 +90,6 @@ module TalonOne
         :'case_sensitivity' => :'caseSensitivity',
         :'attributes' => :'attributes',
         :'limits' => :'limits',
-        :'campaign_priority' => :'campaignPriority',
-        :'exclusive_campaigns_strategy' => :'exclusiveCampaignsStrategy',
         :'default_discount_scope' => :'defaultDiscountScope',
         :'enable_cascading_discounts' => :'enableCascadingDiscounts',
         :'enable_flattened_cart_items' => :'enableFlattenedCartItems',
@@ -120,8 +111,6 @@ module TalonOne
         :'case_sensitivity' => :'String',
         :'attributes' => :'Object',
         :'limits' => :'Array<LimitConfig>',
-        :'campaign_priority' => :'String',
-        :'exclusive_campaigns_strategy' => :'String',
         :'default_discount_scope' => :'String',
         :'enable_cascading_discounts' => :'Boolean',
         :'enable_flattened_cart_items' => :'Boolean',
@@ -184,18 +173,6 @@ module TalonOne
         end
       end
 
-      if attributes.key?(:'campaign_priority')
-        self.campaign_priority = attributes[:'campaign_priority']
-      else
-        self.campaign_priority = 'universal'
-      end
-
-      if attributes.key?(:'exclusive_campaigns_strategy')
-        self.exclusive_campaigns_strategy = attributes[:'exclusive_campaigns_strategy']
-      else
-        self.exclusive_campaigns_strategy = 'listOrder'
-      end
-
       if attributes.key?(:'default_discount_scope')
         self.default_discount_scope = attributes[:'default_discount_scope']
       end
@@ -276,10 +253,6 @@ module TalonOne
       return false if @currency.to_s.length < 1
       case_sensitivity_validator = EnumAttributeValidator.new('String', ["sensitive", "insensitive-uppercase", "insensitive-lowercase"])
       return false unless case_sensitivity_validator.valid?(@case_sensitivity)
-      campaign_priority_validator = EnumAttributeValidator.new('String', ["universal", "stackable", "exclusive"])
-      return false unless campaign_priority_validator.valid?(@campaign_priority)
-      exclusive_campaigns_strategy_validator = EnumAttributeValidator.new('String', ["listOrder", "lowestDiscount", "highestDiscount"])
-      return false unless exclusive_campaigns_strategy_validator.valid?(@exclusive_campaigns_strategy)
       default_discount_scope_validator = EnumAttributeValidator.new('String', ["sessionTotal", "cartItems", "additionalCosts"])
       return false unless default_discount_scope_validator.valid?(@default_discount_scope)
       default_discount_additional_cost_per_item_scope_validator = EnumAttributeValidator.new('String', ["price", "itemTotal", "additionalCosts"])
@@ -340,26 +313,6 @@ module TalonOne
       @case_sensitivity = case_sensitivity
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] campaign_priority Object to be assigned
-    def campaign_priority=(campaign_priority)
-      validator = EnumAttributeValidator.new('String', ["universal", "stackable", "exclusive"])
-      unless validator.valid?(campaign_priority)
-        fail ArgumentError, "invalid value for \"campaign_priority\", must be one of #{validator.allowable_values}."
-      end
-      @campaign_priority = campaign_priority
-    end
-
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] exclusive_campaigns_strategy Object to be assigned
-    def exclusive_campaigns_strategy=(exclusive_campaigns_strategy)
-      validator = EnumAttributeValidator.new('String', ["listOrder", "lowestDiscount", "highestDiscount"])
-      unless validator.valid?(exclusive_campaigns_strategy)
-        fail ArgumentError, "invalid value for \"exclusive_campaigns_strategy\", must be one of #{validator.allowable_values}."
-      end
-      @exclusive_campaigns_strategy = exclusive_campaigns_strategy
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] default_discount_scope Object to be assigned
     def default_discount_scope=(default_discount_scope)
@@ -403,8 +356,6 @@ module TalonOne
           case_sensitivity == o.case_sensitivity &&
           attributes == o.attributes &&
           limits == o.limits &&
-          campaign_priority == o.campaign_priority &&
-          exclusive_campaigns_strategy == o.exclusive_campaigns_strategy &&
           default_discount_scope == o.default_discount_scope &&
           enable_cascading_discounts == o.enable_cascading_discounts &&
           enable_flattened_cart_items == o.enable_flattened_cart_items &&
@@ -424,7 +375,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, timezone, currency, case_sensitivity, attributes, limits, campaign_priority, exclusive_campaigns_strategy, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox, enable_partial_discounts, default_discount_additional_cost_per_item_scope, key].hash
+      [name, description, timezone, currency, case_sensitivity, attributes, limits, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox, enable_partial_discounts, default_discount_additional_cost_per_item_scope, key].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/new_application_api_key.rb

@@ -15,15 +15,21 @@ require 'date'
 module TalonOne
   # 
   class NewApplicationAPIKey
-    # Title for API Key.
+    # Title of the API key.
     attr_accessor :title
 
-    # The date the API key expired.
+    # The date the API key expires.
     attr_accessor :expires
 
     # The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. 
     attr_accessor :platform
 
+    # The API key type. Can be empty or `staging`.  Staging API keys can only be used for dry requests with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint, [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint, and [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint.  When using the _Update customer profile_ endpoint with a staging API key, the query parameter `runRuleEngine` must be `true`. 
+    attr_accessor :type
+
+    # A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date. 
+    attr_accessor :time_offset
+
     # ID of the API Key.
     attr_accessor :id
 
@@ -70,6 +76,8 @@ module TalonOne
         :'title' => :'title',
         :'expires' => :'expires',
         :'platform' => :'platform',
+        :'type' => :'type',
+        :'time_offset' => :'timeOffset',
         :'id' => :'id',
         :'created_by' => :'createdBy',
         :'account_id' => :'accountID',
@@ -85,6 +93,8 @@ module TalonOne
         :'title' => :'String',
         :'expires' => :'DateTime',
         :'platform' => :'String',
+        :'type' => :'String',
+        :'time_offset' => :'Integer',
         :'id' => :'Integer',
         :'created_by' => :'Integer',
         :'account_id' => :'Integer',
@@ -127,6 +137,14 @@ module TalonOne
         self.platform = attributes[:'platform']
       end
 
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'time_offset')
+        self.time_offset = attributes[:'time_offset']
+      end
+
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
@@ -196,8 +214,10 @@ module TalonOne
     def valid?
       return false if @title.nil?
       return false if @expires.nil?
-      platform_validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent", "iterable", "customer_engagement", "customer_data", "salesforce"])
+      platform_validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent", "iterable", "customer_engagement", "customer_data", "salesforce", "emarsys"])
       return false unless platform_validator.valid?(@platform)
+      type_validator = EnumAttributeValidator.new('String', ["staging"])
+      return false unless type_validator.valid?(@type)
       return false if @id.nil?
       return false if @created_by.nil?
       return false if @account_id.nil?
@@ -210,13 +230,23 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] platform Object to be assigned
     def platform=(platform)
-      validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent", "iterable", "customer_engagement", "customer_data", "salesforce"])
+      validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent", "iterable", "customer_engagement", "customer_data", "salesforce", "emarsys"])
       unless validator.valid?(platform)
         fail ArgumentError, "invalid value for \"platform\", must be one of #{validator.allowable_values}."
       end
       @platform = platform
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["staging"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -225,6 +255,8 @@ module TalonOne
           title == o.title &&
           expires == o.expires &&
           platform == o.platform &&
+          type == o.type &&
+          time_offset == o.time_offset &&
           id == o.id &&
           created_by == o.created_by &&
           account_id == o.account_id &&
@@ -242,7 +274,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, expires, platform, id, created_by, account_id, application_id, created, key].hash
+      [title, expires, platform, type, time_offset, id, created_by, account_id, application_id, created, key].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/new_attribute.rb

@@ -248,7 +248,7 @@ module TalonOne
     # @return true if the model is valid
     def valid?
       return false if @entity.nil?
-      entity_validator = EnumAttributeValidator.new('String', ["Account", "Application", "Campaign", "CustomerProfile", "CustomerSession", "CartItem", "Coupon", "Event", "Giveaway", "Referral"])
+      entity_validator = EnumAttributeValidator.new('String', ["Account", "Application", "Campaign", "CustomerProfile", "CustomerSession", "CartItem", "Coupon", "Event", "Giveaway", "Referral", "Store"])
       return false unless entity_validator.valid?(@entity)
       return false if @name.nil?
       return false if @name !~ Regexp.new(/^[A-Za-z]\w*$/)
@@ -266,7 +266,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', ["Account", "Application", "Campaign", "CustomerProfile", "CustomerSession", "CartItem", "Coupon", "Event", "Giveaway", "Referral"])
+      validator = EnumAttributeValidator.new('String', ["Account", "Application", "Campaign", "CustomerProfile", "CustomerSession", "CartItem", "Coupon", "Event", "Giveaway", "Referral", "Store"])
       unless validator.valid?(entity)
         fail ArgumentError, "invalid value for \"entity\", must be one of #{validator.allowable_values}."
       end

data/lib/talon_one/models/new_base_notification.rb

@@ -17,12 +17,16 @@ module TalonOne
   class NewBaseNotification
     attr_accessor :policy
 
+    # Indicates whether the notification is activated.
+    attr_accessor :enabled
+
     attr_accessor :webhook
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'policy' => :'policy',
+        :'enabled' => :'enabled',
         :'webhook' => :'webhook'
       }
     end
@@ -31,6 +35,7 @@ module TalonOne
     def self.openapi_types
       {
         :'policy' => :'Object',
+        :'enabled' => :'Boolean',
         :'webhook' => :'NewNotificationWebhook'
       }
     end
@@ -60,6 +65,12 @@ module TalonOne
         self.policy = attributes[:'policy']
       end
 
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = true
+      end
+
       if attributes.key?(:'webhook')
         self.webhook = attributes[:'webhook']
       end
@@ -94,6 +105,7 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           policy == o.policy &&
+          enabled == o.enabled &&
           webhook == o.webhook
     end
 
@@ -106,7 +118,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [policy, webhook].hash
+      [policy, enabled, webhook].hash
     end
 
     # Builds the object from hash