class YousignClient::ProcedureConfigReminder
Attributes
Number of days between each reminder. The date of the creation of the procedure is used to define the date of the reminder. For example, if you set 2 and the procedure is created at 2017-01-01T15:03:01, the first reminder will be sent at 2017-01-03T15:03:01.
Limit of reminders sent.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/yousign_client/models/procedure_config_reminder.rb, line 26 def self.attribute_map { :'interval' => :'interval', :'limit' => :'limit', :'config' => :'config' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/yousign_client/models/procedure_config_reminder.rb, line 45 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'interval') self.interval = attributes[:'interval'] else self.interval = 1 end if attributes.has_key?(:'limit') self.limit = attributes[:'limit'] else self.limit = 5 end if attributes.has_key?(:'config') self.config = attributes[:'config'] end end
Attribute type mapping.
# File lib/yousign_client/models/procedure_config_reminder.rb, line 35 def self.swagger_types { :'interval' => :'Integer', :'limit' => :'Integer', :'config' => :'ProcedureConfigReminderConfig' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/yousign_client/models/procedure_config_reminder.rb, line 131 def ==(o) return true if self.equal?(o) self.class == o.class && interval == o.interval && limit == o.limit && config == o.config end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/yousign_client/models/procedure_config_reminder.rb, line 175 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 temp_model = YousignClient.const_get(type).new temp_model.build_from_hash(value) end 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
# File lib/yousign_client/models/procedure_config_reminder.rb, line 241 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/yousign_client/models/procedure_config_reminder.rb, line 154 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_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
@see the `==` method @param [Object] Object to be compared
# File lib/yousign_client/models/procedure_config_reminder.rb, line 141 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/yousign_client/models/procedure_config_reminder.rb, line 147 def hash [interval, limit, config].hash end
Custom attribute writer method with validation @param [Object] interval Value to be assigned
# File lib/yousign_client/models/procedure_config_reminder.rb, line 103 def interval=(interval) if interval.nil? fail ArgumentError, 'interval cannot be nil' end if interval < 1 fail ArgumentError, 'invalid value for "interval", must be greater than or equal to 1.' end @interval = interval end
Custom attribute writer method with validation @param [Object] limit Value to be assigned
# File lib/yousign_client/models/procedure_config_reminder.rb, line 117 def limit=(limit) if !limit.nil? && limit > 90 fail ArgumentError, 'invalid value for "limit", must be smaller than or equal to 90.' end if !limit.nil? && limit < 1 fail ArgumentError, 'invalid value for "limit", must be greater than or equal to 1.' end @limit = limit end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/yousign_client/models/procedure_config_reminder.rb, line 70 def list_invalid_properties invalid_properties = Array.new if @interval.nil? invalid_properties.push('invalid value for "interval", interval cannot be nil.') end if @interval < 1 invalid_properties.push('invalid value for "interval", must be greater than or equal to 1.') end if !@limit.nil? && @limit > 90 invalid_properties.push('invalid value for "limit", must be smaller than or equal to 90.') end if !@limit.nil? && @limit < 1 invalid_properties.push('invalid value for "limit", must be greater than or equal to 1.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/yousign_client/models/procedure_config_reminder.rb, line 227 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/yousign_client/models/procedure_config_reminder.rb, line 215 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/yousign_client/models/procedure_config_reminder.rb, line 93 def valid? return false if @interval.nil? return false if @interval < 1 return false if !@limit.nil? && @limit > 90 return false if !@limit.nil? && @limit < 1 true end