talon_one 3.0.1 → 4.0.0

data/lib/talon_one/api_client.rb

@@ -55,7 +55,8 @@ module TalonOne
 
       unless response.success?
         if response.timed_out?
-          fail ApiError.new('Connection timed out')
+          fail ApiError.new(:message => 'Connection timed out',
+                            :timeout => true)
         elsif response.code == 0
           # Errors from libcurl will be made visible here
           fail ApiError.new(:code => 0,

data/lib/talon_one/api_error.rb

@@ -12,13 +12,14 @@ OpenAPI Generator version: 4.3.1
 
 module TalonOne
   class ApiError < StandardError
-    attr_reader :code, :response_headers, :response_body
+    attr_reader :code, :response_headers, :response_body, :timeout
 
     # Usage examples:
     #   ApiError.new
     #   ApiError.new("message")
     #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
     #   ApiError.new(:code => 404, :message => "Not Found")
+    #   ApiError.new(:message => "Connection timed out", :timeout => true)
     def initialize(arg = nil)
       if arg.is_a? Hash
         if arg.key?(:message) || arg.key?('message')
@@ -47,9 +48,15 @@ module TalonOne
         msg = @message
       end
 
+      is_timeout = false
+      unless timeout.nil?
+        is_timeout = timeout
+      end
+
       msg += "\nHTTP status code: #{code}" if code
       msg += "\nResponse headers: #{response_headers}" if response_headers
       msg += "\nResponse body: #{response_body}" if response_body
+      msg += "\nIs timeout: #{is_timeout}"
 
       msg
     end

data/lib/talon_one/models/account_additional_cost.rb

@@ -167,7 +167,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
@@ -195,7 +195,7 @@ module TalonOne
       return false if @created.nil?
       return false if @account_id.nil?
       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?
@@ -211,7 +211,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/account_analytics.rb

@@ -71,6 +71,9 @@ module TalonOne
     # Total number of live loyalty programs in the account.
     attr_accessor :live_loyalty_programs
 
+    # The point in time when the analytics numbers were updated last.
+    attr_accessor :last_updated_at
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -92,7 +95,8 @@ module TalonOne
         :'custom_attributes' => :'customAttributes',
         :'webhooks' => :'webhooks',
         :'loyalty_programs' => :'loyaltyPrograms',
-        :'live_loyalty_programs' => :'liveLoyaltyPrograms'
+        :'live_loyalty_programs' => :'liveLoyaltyPrograms',
+        :'last_updated_at' => :'lastUpdatedAt'
       }
     end
 
@@ -117,7 +121,8 @@ module TalonOne
         :'custom_attributes' => :'Integer',
         :'webhooks' => :'Integer',
         :'loyalty_programs' => :'Integer',
-        :'live_loyalty_programs' => :'Integer'
+        :'live_loyalty_programs' => :'Integer',
+        :'last_updated_at' => :'DateTime'
       }
     end
 
@@ -217,6 +222,10 @@ module TalonOne
       if attributes.key?(:'live_loyalty_programs')
         self.live_loyalty_programs = attributes[:'live_loyalty_programs']
       end
+
+      if attributes.key?(:'last_updated_at')
+        self.last_updated_at = attributes[:'last_updated_at']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -299,6 +308,10 @@ module TalonOne
         invalid_properties.push('invalid value for "live_loyalty_programs", live_loyalty_programs cannot be nil.')
       end
 
+      if @last_updated_at.nil?
+        invalid_properties.push('invalid value for "last_updated_at", last_updated_at cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -324,6 +337,7 @@ module TalonOne
       return false if @webhooks.nil?
       return false if @loyalty_programs.nil?
       return false if @live_loyalty_programs.nil?
+      return false if @last_updated_at.nil?
       true
     end
 
@@ -350,7 +364,8 @@ module TalonOne
           custom_attributes == o.custom_attributes &&
           webhooks == o.webhooks &&
           loyalty_programs == o.loyalty_programs &&
-          live_loyalty_programs == o.live_loyalty_programs
+          live_loyalty_programs == o.live_loyalty_programs &&
+          last_updated_at == o.last_updated_at
     end
 
     # @see the `==` method
@@ -362,7 +377,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [applications, live_applications, sandbox_applications, campaigns, active_campaigns, live_active_campaigns, coupons, active_coupons, expired_coupons, referral_codes, active_referral_codes, expired_referral_codes, active_rules, users, roles, custom_attributes, webhooks, loyalty_programs, live_loyalty_programs].hash
+      [applications, live_applications, sandbox_applications, campaigns, active_campaigns, live_active_campaigns, coupons, active_coupons, expired_coupons, referral_codes, active_referral_codes, expired_referral_codes, active_rules, users, roles, custom_attributes, webhooks, loyalty_programs, live_loyalty_programs, last_updated_at].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/account_dashboard_statistic.rb

@@ -26,9 +26,6 @@ module TalonOne
     # Aggregated statistic for account referrals.
     attr_accessor :referrals
 
-    # Aggregated statistic for the number of account API calls.
-    attr_accessor :api_calls
-
     attr_accessor :campaigns
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -38,7 +35,6 @@ module TalonOne
         :'discounts' => :'discounts',
         :'loyalty_points' => :'loyaltyPoints',
         :'referrals' => :'referrals',
-        :'api_calls' => :'apiCalls',
         :'campaigns' => :'campaigns'
       }
     end
@@ -50,7 +46,6 @@ module TalonOne
         :'discounts' => :'Array<AccountDashboardStatisticDiscount>',
         :'loyalty_points' => :'Array<AccountDashboardStatisticLoyaltyPoints>',
         :'referrals' => :'Array<AccountDashboardStatisticReferrals>',
-        :'api_calls' => :'Array<AccountDashboardStatisticApiCalls>',
         :'campaigns' => :'AccountDashboardStatisticCampaigns'
       }
     end
@@ -100,12 +95,6 @@ module TalonOne
         end
       end
 
-      if attributes.key?(:'api_calls')
-        if (value = attributes[:'api_calls']).is_a?(Array)
-          self.api_calls = value
-        end
-      end
-
       if attributes.key?(:'campaigns')
         self.campaigns = attributes[:'campaigns']
       end
@@ -138,7 +127,6 @@ module TalonOne
           discounts == o.discounts &&
           loyalty_points == o.loyalty_points &&
           referrals == o.referrals &&
-          api_calls == o.api_calls &&
           campaigns == o.campaigns
     end
 
@@ -151,7 +139,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [revenue, discounts, loyalty_points, referrals, api_calls, campaigns].hash
+      [revenue, discounts, loyalty_points, referrals, campaigns].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/account_dashboard_statistic_campaigns.rb

@@ -17,14 +17,18 @@ module TalonOne
     # Number of campaigns that are active and live (across all Applications).
     attr_accessor :live
 
-    # Campaigns with a schedule ending in 7 days or with only 10% of budget left.
+    # Campaigns scheduled to expire sometime in the next 7 days.
     attr_accessor :ending_soon
 
+    # Campaigns with less than 10% of budget left.
+    attr_accessor :low_on_budget
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'live' => :'live',
-        :'ending_soon' => :'endingSoon'
+        :'ending_soon' => :'endingSoon',
+        :'low_on_budget' => :'lowOnBudget'
       }
     end
 
@@ -32,7 +36,8 @@ module TalonOne
     def self.openapi_types
       {
         :'live' => :'Integer',
-        :'ending_soon' => :'Integer'
+        :'ending_soon' => :'Integer',
+        :'low_on_budget' => :'Integer'
       }
     end
 
@@ -64,6 +69,10 @@ module TalonOne
       if attributes.key?(:'ending_soon')
         self.ending_soon = attributes[:'ending_soon']
       end
+
+      if attributes.key?(:'low_on_budget')
+        self.low_on_budget = attributes[:'low_on_budget']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -78,6 +87,10 @@ module TalonOne
         invalid_properties.push('invalid value for "ending_soon", ending_soon cannot be nil.')
       end
 
+      if @low_on_budget.nil?
+        invalid_properties.push('invalid value for "low_on_budget", low_on_budget cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -86,6 +99,7 @@ module TalonOne
     def valid?
       return false if @live.nil?
       return false if @ending_soon.nil?
+      return false if @low_on_budget.nil?
       true
     end
 
@@ -95,7 +109,8 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           live == o.live &&
-          ending_soon == o.ending_soon
+          ending_soon == o.ending_soon &&
+          low_on_budget == o.low_on_budget
     end
 
     # @see the `==` method
@@ -107,7 +122,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [live, ending_soon].hash
+      [live, ending_soon, low_on_budget].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/achievement.rb

@@ -0,0 +1,406 @@
+=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 Achievement
+    # Internal ID of this entity.
+    attr_accessor :id
+
+    # The time this entity was created.
+    attr_accessor :created
+
+    # The internal name of the achievement used in API requests.  **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. 
+    attr_accessor :name
+
+    # The display name for the achievement in the Campaign Manager.
+    attr_accessor :title
+
+    # A description of the achievement.
+    attr_accessor :description
+
+    # The required number of actions or the transactional milestone to complete the achievement.
+    attr_accessor :target
+
+    # The relative duration after which the achievement ends and resets for a particular customer profile.  **Note**: The `period` does not start when the achievement is created.  The period is a **positive real number** followed by one letter indicating the time unit.  Examples: `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 also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U`  **Note**: You can either use the round down and round up option or set an absolute period. 
+    attr_accessor :period
+
+    attr_accessor :period_end_override
+
+    # ID of the campaign, to which the achievement belongs to
+    attr_accessor :campaign_id
+
+    # ID of the user that created this achievement.
+    attr_accessor :user_id
+
+    # Name of the user that created the achievement.  **Note**: This is not available if the user has been deleted. 
+    attr_accessor :created_by
+
+    # Indicates if a customer has made progress in the achievement.
+    attr_accessor :has_progress
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'created' => :'created',
+        :'name' => :'name',
+        :'title' => :'title',
+        :'description' => :'description',
+        :'target' => :'target',
+        :'period' => :'period',
+        :'period_end_override' => :'periodEndOverride',
+        :'campaign_id' => :'campaignId',
+        :'user_id' => :'userId',
+        :'created_by' => :'createdBy',
+        :'has_progress' => :'hasProgress'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'Integer',
+        :'created' => :'DateTime',
+        :'name' => :'String',
+        :'title' => :'String',
+        :'description' => :'String',
+        :'target' => :'Float',
+        :'period' => :'String',
+        :'period_end_override' => :'TimePoint',
+        :'campaign_id' => :'Integer',
+        :'user_id' => :'Integer',
+        :'created_by' => :'String',
+        :'has_progress' => :'Boolean'
+      }
+    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::Achievement` 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::Achievement`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'target')
+        self.target = attributes[:'target']
+      end
+
+      if attributes.key?(:'period')
+        self.period = attributes[:'period']
+      end
+
+      if attributes.key?(:'period_end_override')
+        self.period_end_override = attributes[:'period_end_override']
+      end
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      end
+
+      if attributes.key?(:'created_by')
+        self.created_by = attributes[:'created_by']
+      end
+
+      if attributes.key?(:'has_progress')
+        self.has_progress = attributes[:'has_progress']
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 1000
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 1000.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z]\w+$/)
+      if @name !~ pattern
+        invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @target.nil?
+        invalid_properties.push('invalid value for "target", target cannot be nil.')
+      end
+
+      if @period.nil?
+        invalid_properties.push('invalid value for "period", period cannot be nil.')
+      end
+
+      if @campaign_id.nil?
+        invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
+      end
+
+      if @user_id.nil?
+        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
+      end
+
+      if @created_by.nil?
+        invalid_properties.push('invalid value for "created_by", created_by 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 @name.nil?
+      return false if @name.to_s.length > 1000
+      return false if @name.to_s.length < 1
+      return false if @name !~ Regexp.new(/^[a-zA-Z]\w+$/)
+      return false if @title.nil?
+      return false if @description.nil?
+      return false if @target.nil?
+      return false if @period.nil?
+      return false if @campaign_id.nil?
+      return false if @user_id.nil?
+      return false if @created_by.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 1000.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z]\w+$/)
+      if name !~ pattern
+        fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
+      end
+
+      @name = name
+    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 &&
+          name == o.name &&
+          title == o.title &&
+          description == o.description &&
+          target == o.target &&
+          period == o.period &&
+          period_end_override == o.period_end_override &&
+          campaign_id == o.campaign_id &&
+          user_id == o.user_id &&
+          created_by == o.created_by &&
+          has_progress == o.has_progress
+    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, name, title, description, target, period, period_end_override, campaign_id, user_id, created_by, has_progress].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