talon_one 3.0.2 → 5.0.0

data/lib/talon_one/models/new_invitation.rb

@@ -15,24 +15,29 @@ require 'date'
 module TalonOne
   # Parameters for inviting a new user.
   class NewInvitation
-    # Name of the user being invited.
+    # Name of the user.
     attr_accessor :name
 
+    # Email address of the user.
     attr_accessor :email
 
-    # The `Access Control List` json defining the role of the user.  This represents the access control on the user level. Use one of the following: - normal user: `{\"Role\": 0}` - admin: `{\"Role\": 127}` 
-    attr_accessor :acl
+    # Indicates whether the user is an `admin`.
+    attr_accessor :is_admin
 
-    # An array of roleIDs to assign the new user to.
+    # A list of the IDs of the roles assigned to the user.
     attr_accessor :roles
 
+    # Indicates the access level of the user.
+    attr_accessor :acl
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'email' => :'email',
-        :'acl' => :'acl',
-        :'roles' => :'roles'
+        :'is_admin' => :'isAdmin',
+        :'roles' => :'roles',
+        :'acl' => :'acl'
       }
     end
 
@@ -41,8 +46,9 @@ module TalonOne
       {
         :'name' => :'String',
         :'email' => :'String',
-        :'acl' => :'String',
-        :'roles' => :'Array<Integer>'
+        :'is_admin' => :'Boolean',
+        :'roles' => :'Array<Integer>',
+        :'acl' => :'String'
       }
     end
 
@@ -75,8 +81,8 @@ module TalonOne
         self.email = attributes[:'email']
       end
 
-      if attributes.key?(:'acl')
-        self.acl = attributes[:'acl']
+      if attributes.key?(:'is_admin')
+        self.is_admin = attributes[:'is_admin']
       end
 
       if attributes.key?(:'roles')
@@ -84,6 +90,10 @@ module TalonOne
           self.roles = value
         end
       end
+
+      if attributes.key?(:'acl')
+        self.acl = attributes[:'acl']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -94,10 +104,6 @@ module TalonOne
         invalid_properties.push('invalid value for "email", email cannot be nil.')
       end
 
-      if @acl.nil?
-        invalid_properties.push('invalid value for "acl", acl cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -105,7 +111,6 @@ module TalonOne
     # @return true if the model is valid
     def valid?
       return false if @email.nil?
-      return false if @acl.nil?
       true
     end
 
@@ -116,8 +121,9 @@ module TalonOne
       self.class == o.class &&
           name == o.name &&
           email == o.email &&
-          acl == o.acl &&
-          roles == o.roles
+          is_admin == o.is_admin &&
+          roles == o.roles &&
+          acl == o.acl
     end
 
     # @see the `==` method
@@ -129,7 +135,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, email, acl, roles].hash
+      [name, email, is_admin, roles, acl].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/new_invite_email.rb

@@ -14,8 +14,10 @@ require 'date'
 
 module TalonOne
   class NewInviteEmail
+    # Email address of the user.
     attr_accessor :email
 
+    # Invitation token of the user.
     attr_accessor :token
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -72,18 +74,10 @@ module TalonOne
         invalid_properties.push('invalid value for "email", email cannot be nil.')
       end
 
-      if @email.to_s.length < 1
-        invalid_properties.push('invalid value for "email", the character length must be great than or equal to 1.')
-      end
-
       if @token.nil?
         invalid_properties.push('invalid value for "token", token cannot be nil.')
       end
 
-      if @token.to_s.length < 1
-        invalid_properties.push('invalid value for "token", the character length must be great than or equal to 1.')
-      end
-
       invalid_properties
     end
 
@@ -91,40 +85,10 @@ module TalonOne
     # @return true if the model is valid
     def valid?
       return false if @email.nil?
-      return false if @email.to_s.length < 1
       return false if @token.nil?
-      return false if @token.to_s.length < 1
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] email Value to be assigned
-    def email=(email)
-      if email.nil?
-        fail ArgumentError, 'email cannot be nil'
-      end
-
-      if email.to_s.length < 1
-        fail ArgumentError, 'invalid value for "email", the character length must be great than or equal to 1.'
-      end
-
-      @email = email
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] token Value to be assigned
-    def token=(token)
-      if token.nil?
-        fail ArgumentError, 'token cannot be nil'
-      end
-
-      if token.to_s.length < 1
-        fail ArgumentError, 'invalid value for "token", the character length must be great than or equal to 1.'
-      end
-
-      @token = token
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/talon_one/models/new_loyalty_program.rb

@@ -39,6 +39,18 @@ 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. 
+    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. 
+    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. 
+    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
+
     # The internal name for the Loyalty Program. This is an immutable value.
     attr_accessor :name
 
@@ -51,6 +63,28 @@ module TalonOne
     # Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. 
     attr_accessor :card_based
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -62,6 +96,10 @@ module TalonOne
         :'allow_subledger' => :'allowSubledger',
         :'users_per_card_limit' => :'usersPerCardLimit',
         :'sandbox' => :'sandbox',
+        :'tiers_expiration_policy' => :'tiersExpirationPolicy',
+        :'tiers_expire_in' => :'tiersExpireIn',
+        :'tiers_downgrade_policy' => :'tiersDowngradePolicy',
+        :'program_join_policy' => :'programJoinPolicy',
         :'name' => :'name',
         :'tiers' => :'tiers',
         :'timezone' => :'timezone',
@@ -80,6 +118,10 @@ module TalonOne
         :'allow_subledger' => :'Boolean',
         :'users_per_card_limit' => :'Integer',
         :'sandbox' => :'Boolean',
+        :'tiers_expiration_policy' => :'String',
+        :'tiers_expire_in' => :'String',
+        :'tiers_downgrade_policy' => :'String',
+        :'program_join_policy' => :'String',
         :'name' => :'String',
         :'tiers' => :'Array<NewLoyaltyTier>',
         :'timezone' => :'String',
@@ -142,6 +184,22 @@ module TalonOne
         self.sandbox = attributes[:'sandbox']
       end
 
+      if attributes.key?(:'tiers_expiration_policy')
+        self.tiers_expiration_policy = attributes[:'tiers_expiration_policy']
+      end
+
+      if attributes.key?(:'tiers_expire_in')
+        self.tiers_expire_in = attributes[:'tiers_expire_in']
+      end
+
+      if attributes.key?(:'tiers_downgrade_policy')
+        self.tiers_downgrade_policy = attributes[:'tiers_downgrade_policy']
+      end
+
+      if attributes.key?(:'program_join_policy')
+        self.program_join_policy = attributes[:'program_join_policy']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -219,6 +277,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"])
+      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
@@ -236,6 +300,36 @@ module TalonOne
       @users_per_card_limit = users_per_card_limit
     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"])
+      unless validator.valid?(tiers_expiration_policy)
+        fail ArgumentError, "invalid value for \"tiers_expiration_policy\", must be one of #{validator.allowable_values}."
+      end
+      @tiers_expiration_policy = tiers_expiration_policy
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] tiers_downgrade_policy Object to be assigned
+    def tiers_downgrade_policy=(tiers_downgrade_policy)
+      validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
+      unless validator.valid?(tiers_downgrade_policy)
+        fail ArgumentError, "invalid value for \"tiers_downgrade_policy\", must be one of #{validator.allowable_values}."
+      end
+      @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)
@@ -263,6 +357,10 @@ module TalonOne
           allow_subledger == o.allow_subledger &&
           users_per_card_limit == o.users_per_card_limit &&
           sandbox == o.sandbox &&
+          tiers_expiration_policy == o.tiers_expiration_policy &&
+          tiers_expire_in == o.tiers_expire_in &&
+          tiers_downgrade_policy == o.tiers_downgrade_policy &&
+          program_join_policy == o.program_join_policy &&
           name == o.name &&
           tiers == o.tiers &&
           timezone == o.timezone &&
@@ -278,7 +376,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, name, tiers, timezone, card_based].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
     end
 
     # Builds the object from hash

data/lib/talon_one/models/new_notification_test.rb

@@ -0,0 +1,327 @@
+=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 NewNotificationTest
+    # The notification type.
+    attr_accessor :type
+
+    # Array of query parameters.
+    attr_accessor :_query_params
+
+    # List of API HTTP headers for the given webhook-based notification.
+    attr_accessor :headers
+
+    # API method for this notification.
+    attr_accessor :verb
+
+    # API URL for the given notification.
+    attr_accessor :url
+
+    # API payload of this notification.
+    attr_accessor :payload
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'_query_params' => :'queryParams',
+        :'headers' => :'headers',
+        :'verb' => :'verb',
+        :'url' => :'url',
+        :'payload' => :'payload'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'_query_params' => :'Hash<String, String>',
+        :'headers' => :'Hash<String, String>',
+        :'verb' => :'String',
+        :'url' => :'String',
+        :'payload' => :'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::NewNotificationTest` 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::NewNotificationTest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'_query_params')
+        if (value = attributes[:'_query_params']).is_a?(Hash)
+          self._query_params = value
+        end
+      end
+
+      if attributes.key?(:'headers')
+        if (value = attributes[:'headers']).is_a?(Hash)
+          self.headers = value
+        end
+      end
+
+      if attributes.key?(:'verb')
+        self.verb = attributes[:'verb']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'payload')
+        self.payload = attributes[:'payload']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @verb.nil?
+        invalid_properties.push('invalid value for "verb", verb cannot be nil.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
+      end
+
+      if @payload.nil?
+        invalid_properties.push('invalid value for "payload", payload cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @type.nil?
+      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"])
+      return false unless type_validator.valid?(@type)
+      return false if @verb.nil?
+      verb_validator = EnumAttributeValidator.new('String', ["POST", "PUT", "GET", "DELETE", "PATCH"])
+      return false unless verb_validator.valid?(@verb)
+      return false if @url.nil?
+      return false if @payload.nil?
+      true
+    end
+
+    # 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"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] verb Object to be assigned
+    def verb=(verb)
+      validator = EnumAttributeValidator.new('String', ["POST", "PUT", "GET", "DELETE", "PATCH"])
+      unless validator.valid?(verb)
+        fail ArgumentError, "invalid value for \"verb\", must be one of #{validator.allowable_values}."
+      end
+      @verb = verb
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          type == o.type &&
+          _query_params == o._query_params &&
+          headers == o.headers &&
+          verb == o.verb &&
+          url == o.url &&
+          payload == o.payload
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [type, _query_params, headers, verb, url, payload].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        TalonOne.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end