class PureCloud::AttemptLimits
Attributes
Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The globally unique identifier for the object.
The maximum number of times a contact can be called within the resetPeriod. Required if maxAttemptsPerNumber is not defined.
The maximum number of times a phone number can be called within the resetPeriod. Required if maxAttemptsPerContact is not defined.
Configuration
for recall attempts.
After how long the number of attempts will be set back to 0. Defaults to NEVER.
The URI for this object
If the resetPeriod is TODAY, this specifies the timezone in which TODAY occurs. Required if the resetPeriod is TODAY.
Required for updates, must match the version number of the most recent update
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/attempt_limits.rb, line 54 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'date_created' => :'dateCreated', :'date_modified' => :'dateModified', :'version' => :'version', :'max_attempts_per_contact' => :'maxAttemptsPerContact', :'max_attempts_per_number' => :'maxAttemptsPerNumber', :'time_zone_id' => :'timeZoneId', :'reset_period' => :'resetPeriod', :'recall_entries' => :'recallEntries', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/attempt_limits.rb, line 113 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'dateCreated') self.date_created = attributes[:'dateCreated'] end if attributes.has_key?(:'dateModified') self.date_modified = attributes[:'dateModified'] end if attributes.has_key?(:'version') self.version = attributes[:'version'] end if attributes.has_key?(:'maxAttemptsPerContact') self.max_attempts_per_contact = attributes[:'maxAttemptsPerContact'] end if attributes.has_key?(:'maxAttemptsPerNumber') self.max_attempts_per_number = attributes[:'maxAttemptsPerNumber'] end if attributes.has_key?(:'timeZoneId') self.time_zone_id = attributes[:'timeZoneId'] end if attributes.has_key?(:'resetPeriod') self.reset_period = attributes[:'resetPeriod'] end if attributes.has_key?(:'recallEntries') if (value = attributes[:'recallEntries']).is_a?(Array) self.recall_entries = value end end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/attempt_limits.rb, line 83 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'date_created' => :'DateTime', :'date_modified' => :'DateTime', :'version' => :'Integer', :'max_attempts_per_contact' => :'Integer', :'max_attempts_per_number' => :'Integer', :'time_zone_id' => :'String', :'reset_period' => :'String', :'recall_entries' => :'Hash<String, RecallEntry>', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/attempt_limits.rb, line 354 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && date_created == o.date_created && date_modified == o.date_modified && version == o.version && max_attempts_per_contact == o.max_attempts_per_contact && max_attempts_per_number == o.max_attempts_per_number && time_zone_id == o.time_zone_id && reset_period == o.reset_period && recall_entries == o.recall_entries && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/attempt_limits.rb, line 402 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 =~ /^(true|t|yes|y|1)$/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 _model = Object.const_get("PureCloud").const_get(type).new _model.build_from_hash(value) end end
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloudplatformclientv2/models/attempt_limits.rb, line 462 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
build the object from hash
# File lib/purecloudplatformclientv2/models/attempt_limits.rb, line 383 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) else #TODO show warning in debug mode end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) else # data not found in attributes(hash), not an issue as the data can be optional end end self end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/attempt_limits.rb, line 372 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/attempt_limits.rb, line 378 def hash [id, name, date_created, date_modified, version, max_attempts_per_contact, max_attempts_per_number, time_zone_id, reset_period, recall_entries, self_uri].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/attempt_limits.rb, line 225 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] reset_period
Object to be assigned
# File lib/purecloudplatformclientv2/models/attempt_limits.rb, line 331 def reset_period=(reset_period) allowed_values = ["NEVER", "TODAY"] if reset_period && !allowed_values.include?(reset_period) fail ArgumentError, "invalid value for 'reset_period', must be one of #{allowed_values}." end @reset_period = reset_period end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/attempt_limits.rb, line 450 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
# File lib/purecloudplatformclientv2/models/attempt_limits.rb, line 440 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/purecloudplatformclientv2/models/attempt_limits.rb, line 234 def valid? allowed_values = ["NEVER", "TODAY"] if @reset_period && !allowed_values.include?(@reset_period) return false end end