=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 # Points to add. class AddLoyaltyPoints # Amount of loyalty points. attr_accessor :points # Name / reason for the point addition. attr_accessor :name # The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months 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 and months. Signifies the end of the day, week, or month. If passed, `validUntil` should be omitted. attr_accessor :validity_duration # Date and time when points should expire. The value should be provided in RFC 3339 format. If passed, `validityDuration` should be omitted. attr_accessor :valid_until # The amount of time before the points are considered valid. The time format is either: - `immediate` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months 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 and months. Signifies the end of the day, week, or month. attr_accessor :pending_duration # Date and time after the points are considered valid. The value should be provided in RFC 3339 format. If passed, `pendingDuration` should be omitted. attr_accessor :pending_until # ID of the subledger the points are added to. If there is no existing subledger with this ID, the subledger is created automatically. attr_accessor :subledger_id # ID of the Application that is connected to the loyalty program. It is displayed in your Talon.One deployment URL. attr_accessor :application_id # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'points' => :'points', :'name' => :'name', :'validity_duration' => :'validityDuration', :'valid_until' => :'validUntil', :'pending_duration' => :'pendingDuration', :'pending_until' => :'pendingUntil', :'subledger_id' => :'subledgerId', :'application_id' => :'applicationId' } end # Attribute type mapping. def self.openapi_types { :'points' => :'Float', :'name' => :'String', :'validity_duration' => :'String', :'valid_until' => :'DateTime', :'pending_duration' => :'String', :'pending_until' => :'DateTime', :'subledger_id' => :'String', :'application_id' => :'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::AddLoyaltyPoints` 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::AddLoyaltyPoints`. 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?(:'points') self.points = attributes[:'points'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'validity_duration') self.validity_duration = attributes[:'validity_duration'] end if attributes.key?(:'valid_until') self.valid_until = attributes[:'valid_until'] end if attributes.key?(:'pending_duration') self.pending_duration = attributes[:'pending_duration'] end if attributes.key?(:'pending_until') self.pending_until = attributes[:'pending_until'] end if attributes.key?(:'subledger_id') self.subledger_id = attributes[:'subledger_id'] end if attributes.key?(:'application_id') self.application_id = attributes[:'application_id'] 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 @points.nil? invalid_properties.push('invalid value for "points", points cannot be nil.') end if @points > 999999999999.99 invalid_properties.push('invalid value for "points", must be smaller than or equal to 999999999999.99.') end if @points <= 0 invalid_properties.push('invalid value for "points", must be greater than 0.') 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 @points.nil? return false if @points > 999999999999.99 return false if @points <= 0 true end # Custom attribute writer method with validation # @param [Object] points Value to be assigned def points=(points) if points.nil? fail ArgumentError, 'points cannot be nil' end if points > 999999999999.99 fail ArgumentError, 'invalid value for "points", must be smaller than or equal to 999999999999.99.' end if points <= 0 fail ArgumentError, 'invalid value for "points", must be greater than 0.' end @points = points 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 && points == o.points && name == o.name && validity_duration == o.validity_duration && valid_until == o.valid_until && pending_duration == o.pending_duration && pending_until == o.pending_until && subledger_id == o.subledger_id && application_id == o.application_id 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 [points, name, validity_duration, valid_until, pending_duration, pending_until, subledger_id, application_id].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<(?.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?.+?), (?.+)>\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