talon_one 4.0.0 → 6.0.0

data/lib/talon_one/models/new_external_invitation.rb

@@ -0,0 +1,235 @@
+=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
+  # Parameters for inviting a new user from an external identity provider.
+  class NewExternalInvitation
+    # Name of the user.
+    attr_accessor :name
+
+    # List of user groups in the external identity provider.  If there are roles in Talon.One whose names match these user groups, those roles will be automatically assigned to the user upon invitation. 
+    attr_accessor :user_groups
+
+    # Email address of the user.
+    attr_accessor :email
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'user_groups' => :'userGroups',
+        :'email' => :'email'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'user_groups' => :'Array<String>',
+        :'email' => :'String'
+      }
+    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::NewExternalInvitation` 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::NewExternalInvitation`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'user_groups')
+        if (value = attributes[:'user_groups']).is_a?(Array)
+          self.user_groups = value
+        end
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      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 @email.nil?
+        invalid_properties.push('invalid value for "email", email 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 @email.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 &&
+          name == o.name &&
+          user_groups == o.user_groups &&
+          email == o.email
+    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
+      [name, user_groups, email].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_loyalty_program.rb

@@ -39,17 +39,22 @@ module TalonOne
     # Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type.
     attr_accessor :sandbox
 
-    # The policy that defines which date is used to calculate the expiration date of a customer's current tier.  - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier.  - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program. 
+    # The policy that defines when the customer joins the loyalty program.   - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points.       **Note**: The customer does not have a program join date.   - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time.   - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. 
+    attr_accessor :program_join_policy
+
+    # The policy that defines how tier expiration, used to reevaluate the customer's current tier, is determined.  - `tier_start_date`: The tier expiration is relative to when the customer joined the current tier.  - `program_join_date`: The tier expiration is relative to when the customer joined the loyalty program.  - `customer_attribute`: The tier expiration is determined by a custom customer attribute.  - `absolute_expiration`: The tier is reevaluated at the start of each tier cycle. For this policy, it is required to provide a `tierCycleStartDate`. 
     attr_accessor :tiers_expiration_policy
 
-    # The amount of time after which the tier expires.  The time format is an **integer** 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 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. 
+    # Timestamp at which the tier cycle starts for all customers in the loyalty program.  **Note**: This is only required when the tier expiration policy is set to `absolute_expiration`. 
+    attr_accessor :tier_cycle_start_date
+
+    # The amount of time after which the tier expires and is reevaluated.  The time format is an **integer** 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 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 :tiers_expire_in
 
-    # Customers's tier downgrade policy.  - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down.  - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. 
+    # The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation.  - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier.  - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. 
     attr_accessor :tiers_downgrade_policy
 
-    # The policy that defines when the customer joins the loyalty program.   - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points.       **Note**: The customer does not have a program join date.   - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time.   - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. 
-    attr_accessor :program_join_policy
+    attr_accessor :card_code_settings
 
     # The internal name for the Loyalty Program. This is an immutable value.
     attr_accessor :name
@@ -96,10 +101,12 @@ module TalonOne
         :'allow_subledger' => :'allowSubledger',
         :'users_per_card_limit' => :'usersPerCardLimit',
         :'sandbox' => :'sandbox',
+        :'program_join_policy' => :'programJoinPolicy',
         :'tiers_expiration_policy' => :'tiersExpirationPolicy',
+        :'tier_cycle_start_date' => :'tierCycleStartDate',
         :'tiers_expire_in' => :'tiersExpireIn',
         :'tiers_downgrade_policy' => :'tiersDowngradePolicy',
-        :'program_join_policy' => :'programJoinPolicy',
+        :'card_code_settings' => :'cardCodeSettings',
         :'name' => :'name',
         :'tiers' => :'tiers',
         :'timezone' => :'timezone',
@@ -118,10 +125,12 @@ module TalonOne
         :'allow_subledger' => :'Boolean',
         :'users_per_card_limit' => :'Integer',
         :'sandbox' => :'Boolean',
+        :'program_join_policy' => :'String',
         :'tiers_expiration_policy' => :'String',
+        :'tier_cycle_start_date' => :'DateTime',
         :'tiers_expire_in' => :'String',
         :'tiers_downgrade_policy' => :'String',
-        :'program_join_policy' => :'String',
+        :'card_code_settings' => :'CodeGeneratorSettings',
         :'name' => :'String',
         :'tiers' => :'Array<NewLoyaltyTier>',
         :'timezone' => :'String',
@@ -184,10 +193,18 @@ module TalonOne
         self.sandbox = attributes[:'sandbox']
       end
 
+      if attributes.key?(:'program_join_policy')
+        self.program_join_policy = attributes[:'program_join_policy']
+      end
+
       if attributes.key?(:'tiers_expiration_policy')
         self.tiers_expiration_policy = attributes[:'tiers_expiration_policy']
       end
 
+      if attributes.key?(:'tier_cycle_start_date')
+        self.tier_cycle_start_date = attributes[:'tier_cycle_start_date']
+      end
+
       if attributes.key?(:'tiers_expire_in')
         self.tiers_expire_in = attributes[:'tiers_expire_in']
       end
@@ -196,8 +213,8 @@ module TalonOne
         self.tiers_downgrade_policy = attributes[:'tiers_downgrade_policy']
       end
 
-      if attributes.key?(:'program_join_policy')
-        self.program_join_policy = attributes[:'program_join_policy']
+      if attributes.key?(:'card_code_settings')
+        self.card_code_settings = attributes[:'card_code_settings']
       end
 
       if attributes.key?(:'name')
@@ -277,12 +294,12 @@ module TalonOne
       return false if @allow_subledger.nil?
       return false if !@users_per_card_limit.nil? && @users_per_card_limit < 0
       return false if @sandbox.nil?
-      tiers_expiration_policy_validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date"])
+      program_join_policy_validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
+      return false unless program_join_policy_validator.valid?(@program_join_policy)
+      tiers_expiration_policy_validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date", "customer_attribute", "absolute_expiration"])
       return false unless tiers_expiration_policy_validator.valid?(@tiers_expiration_policy)
       tiers_downgrade_policy_validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
       return false unless tiers_downgrade_policy_validator.valid?(@tiers_downgrade_policy)
-      program_join_policy_validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
-      return false unless program_join_policy_validator.valid?(@program_join_policy)
       return false if @name.nil?
       return false if @timezone.nil?
       return false if @timezone.to_s.length < 1
@@ -300,10 +317,20 @@ module TalonOne
       @users_per_card_limit = users_per_card_limit
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] program_join_policy Object to be assigned
+    def program_join_policy=(program_join_policy)
+      validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
+      unless validator.valid?(program_join_policy)
+        fail ArgumentError, "invalid value for \"program_join_policy\", must be one of #{validator.allowable_values}."
+      end
+      @program_join_policy = program_join_policy
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] tiers_expiration_policy Object to be assigned
     def tiers_expiration_policy=(tiers_expiration_policy)
-      validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date"])
+      validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date", "customer_attribute", "absolute_expiration"])
       unless validator.valid?(tiers_expiration_policy)
         fail ArgumentError, "invalid value for \"tiers_expiration_policy\", must be one of #{validator.allowable_values}."
       end
@@ -320,16 +347,6 @@ module TalonOne
       @tiers_downgrade_policy = tiers_downgrade_policy
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] program_join_policy Object to be assigned
-    def program_join_policy=(program_join_policy)
-      validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
-      unless validator.valid?(program_join_policy)
-        fail ArgumentError, "invalid value for \"program_join_policy\", must be one of #{validator.allowable_values}."
-      end
-      @program_join_policy = program_join_policy
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] timezone Value to be assigned
     def timezone=(timezone)
@@ -357,10 +374,12 @@ module TalonOne
           allow_subledger == o.allow_subledger &&
           users_per_card_limit == o.users_per_card_limit &&
           sandbox == o.sandbox &&
+          program_join_policy == o.program_join_policy &&
           tiers_expiration_policy == o.tiers_expiration_policy &&
+          tier_cycle_start_date == o.tier_cycle_start_date &&
           tiers_expire_in == o.tiers_expire_in &&
           tiers_downgrade_policy == o.tiers_downgrade_policy &&
-          program_join_policy == o.program_join_policy &&
+          card_code_settings == o.card_code_settings &&
           name == o.name &&
           tiers == o.tiers &&
           timezone == o.timezone &&
@@ -376,7 +395,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, tiers_expiration_policy, tiers_expire_in, tiers_downgrade_policy, program_join_policy, name, tiers, timezone, card_based].hash
+      [title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, program_join_policy, tiers_expiration_policy, tier_cycle_start_date, tiers_expire_in, tiers_downgrade_policy, card_code_settings, name, tiers, timezone, card_based].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/new_notification_test.rb

@@ -155,7 +155,7 @@ module TalonOne
     # @return true if the model is valid
     def valid?
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["campaign", "loyalty_added_deducted_points", "coupon", "expiring_coupons", "expiring_points", "pending_to_active_points", "strikethrough_pricing", "tier_downgrade", "tier_upgrade", "tier_will_downgrade", "card_expiring_points"])
+      type_validator = EnumAttributeValidator.new('String', ["campaign", "loyalty_added_deducted_points", "card_added_deducted_points", "coupon", "expiring_coupons", "expiring_points", "pending_to_active_points", "strikethrough_pricing", "tier_downgrade", "tier_upgrade", "tier_will_downgrade", "card_expiring_points"])
       return false unless type_validator.valid?(@type)
       return false if @verb.nil?
       verb_validator = EnumAttributeValidator.new('String', ["POST", "PUT", "GET", "DELETE", "PATCH"])
@@ -168,7 +168,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["campaign", "loyalty_added_deducted_points", "coupon", "expiring_coupons", "expiring_points", "pending_to_active_points", "strikethrough_pricing", "tier_downgrade", "tier_upgrade", "tier_will_downgrade", "card_expiring_points"])
+      validator = EnumAttributeValidator.new('String', ["campaign", "loyalty_added_deducted_points", "card_added_deducted_points", "coupon", "expiring_coupons", "expiring_points", "pending_to_active_points", "strikethrough_pricing", "tier_downgrade", "tier_upgrade", "tier_will_downgrade", "card_expiring_points"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

data/lib/talon_one/models/new_outgoing_integration_webhook.rb

@@ -17,6 +17,9 @@ module TalonOne
     # Webhook title.
     attr_accessor :title
 
+    # A description of the webhook.
+    attr_accessor :description
+
     # IDs of the Applications to which a webhook must be linked.
     attr_accessor :application_ids
 
@@ -24,6 +27,7 @@ module TalonOne
     def self.attribute_map
       {
         :'title' => :'title',
+        :'description' => :'description',
         :'application_ids' => :'applicationIds'
       }
     end
@@ -32,6 +36,7 @@ module TalonOne
     def self.openapi_types
       {
         :'title' => :'String',
+        :'description' => :'String',
         :'application_ids' => :'Array<Integer>'
       }
     end
@@ -61,6 +66,10 @@ module TalonOne
         self.title = attributes[:'title']
       end
 
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.key?(:'application_ids')
         if (value = attributes[:'application_ids']).is_a?(Array)
           self.application_ids = value
@@ -97,6 +106,7 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           title == o.title &&
+          description == o.description &&
           application_ids == o.application_ids
     end
 
@@ -109,7 +119,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, application_ids].hash
+      [title, description, application_ids].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/new_referral.rb

@@ -18,7 +18,7 @@ module TalonOne
     # Timestamp at which point the referral code becomes valid.
     attr_accessor :start_date
 
-    # Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative.
+    # Expiration date of the referral code. Referral never expires if this is omitted.
     attr_accessor :expiry_date
 
     # The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. 

data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb

@@ -18,7 +18,7 @@ module TalonOne
     # Timestamp at which point the referral code becomes valid.
     attr_accessor :start_date
 
-    # Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative.
+    # Expiration date of the referral code. Referral never expires if this is omitted.
     attr_accessor :expiry_date
 
     # The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.