class PureCloud::DncList
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 division this DncList
belongs to.
The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com.
The type of the DncList
.
The globally unique identifier for the object.
The status of the import process
A gryphon license number. Required if the dncSourceType is gryphon.
A dnc.com loginId. Required if the dncSourceType is dnc.com.
The name of the DncList
.
The URI for this object
The total number of phone numbers in the DncList
.
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/dnc_list.rb, line 61 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'date_created' => :'dateCreated', :'date_modified' => :'dateModified', :'version' => :'version', :'import_status' => :'importStatus', :'size' => :'size', :'dnc_source_type' => :'dncSourceType', :'login_id' => :'loginId', :'dnc_codes' => :'dncCodes', :'license_id' => :'licenseId', :'division' => :'division', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/dnc_list.rb, line 128 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?(:'importStatus') self.import_status = attributes[:'importStatus'] end if attributes.has_key?(:'size') self.size = attributes[:'size'] end if attributes.has_key?(:'dncSourceType') self.dnc_source_type = attributes[:'dncSourceType'] end if attributes.has_key?(:'loginId') self.login_id = attributes[:'loginId'] end if attributes.has_key?(:'dncCodes') if (value = attributes[:'dncCodes']).is_a?(Array) self.dnc_codes = value end end if attributes.has_key?(:'licenseId') self.license_id = attributes[:'licenseId'] end if attributes.has_key?(:'division') self.division = attributes[:'division'] end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/dnc_list.rb, line 94 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'date_created' => :'DateTime', :'date_modified' => :'DateTime', :'version' => :'Integer', :'import_status' => :'ImportStatus', :'size' => :'Integer', :'dnc_source_type' => :'String', :'login_id' => :'String', :'dnc_codes' => :'Array<String>', :'license_id' => :'String', :'division' => :'DomainEntityRef', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/dnc_list.rb, line 415 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 && import_status == o.import_status && size == o.size && dnc_source_type == o.dnc_source_type && login_id == o.login_id && dnc_codes == o.dnc_codes && license_id == o.license_id && division == o.division && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/dnc_list.rb, line 465 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/dnc_list.rb, line 525 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/dnc_list.rb, line 446 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
Custom attribute writer method checking allowed values (enum). @param [Object] dnc_source_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/dnc_list.rb, line 377 def dnc_source_type=(dnc_source_type) allowed_values = ["rds", "dnc.com", "gryphon"] if dnc_source_type && !allowed_values.include?(dnc_source_type) fail ArgumentError, "invalid value for 'dnc_source_type', must be one of #{allowed_values}." end @dnc_source_type = dnc_source_type end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/dnc_list.rb, line 435 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/dnc_list.rb, line 441 def hash [id, name, date_created, date_modified, version, import_status, size, dnc_source_type, login_id, dnc_codes, license_id, division, 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/dnc_list.rb, line 258 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/dnc_list.rb, line 513 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/dnc_list.rb, line 503 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/dnc_list.rb, line 267 def valid? if @name.nil? return false end if @dnc_source_type.nil? return false end allowed_values = ["rds", "dnc.com", "gryphon"] if @dnc_source_type && !allowed_values.include?(@dnc_source_type) return false end end