class PureCloud::DncListCreate
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 list of dnc.com codes to be treated as DNC
the type of dnc list being created, rds (csv file), gryphon, or dnc.com
The globally unique identifier for the object.
the status of the import process
the license number if the dncSourceType is gryphon
the loginId if the dncSourceType is dnc.com
The name of the list.
The URI for this object
the number of phone numbers in the do not call list
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/purecloud/models/dnc_list_create.rb, line 58 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', :'self_uri' => :'selfUri' } end
# File lib/purecloud/models/dnc_list_create.rb, line 107 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo} if attributes[:'id'] self.id = attributes[:'id'] end if attributes[:'name'] self.name = attributes[:'name'] end if attributes[:'dateCreated'] self.date_created = attributes[:'dateCreated'] end if attributes[:'dateModified'] self.date_modified = attributes[:'dateModified'] end if attributes[:'version'] self.version = attributes[:'version'] end if attributes[:'importStatus'] self.import_status = attributes[:'importStatus'] end if attributes[:'size'] self.size = attributes[:'size'] end if attributes[:'dncSourceType'] self.dnc_source_type = attributes[:'dncSourceType'] end if attributes[:'loginId'] self.login_id = attributes[:'loginId'] end if attributes[:'dncCodes'] if (value = attributes[:'dncCodes']).is_a?(Array) self.dnc_codes = value end end if attributes[:'licenseId'] self.license_id = attributes[:'licenseId'] end if attributes[:'selfUri'] self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloud/models/dnc_list_create.rb, line 89 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', :'self_uri' => :'String' } end
Public Instance Methods
Check equality by comparing each attribute.
# File lib/purecloud/models/dnc_list_create.rb, line 176 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 && self_uri == o.self_uri end
# File lib/purecloud/models/dnc_list_create.rb, line 223 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/purecloud/models/dnc_list_create.rb, line 283 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/purecloud/models/dnc_list_create.rb, line 204 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).
# File lib/purecloud/models/dnc_list_create.rb, line 167 def dnc_source_type=(dnc_source_type) allowed_values = ["RDS", "DNC_DOT_COM", "GRYPHON"] if dnc_source_type && !allowed_values.include?(dnc_source_type) fail "invalid value for 'dnc_source_type', must be one of #{allowed_values}" end @dnc_source_type = dnc_source_type end
@see the `==` method
# File lib/purecloud/models/dnc_list_create.rb, line 194 def eql?(o) self == o end
Calculate hash code according to all attributes.
# File lib/purecloud/models/dnc_list_create.rb, line 199 def hash [id, name, date_created, date_modified, version, import_status, size, dnc_source_type, login_id, dnc_codes, license_id, self_uri].hash end
return the object in the form of hash
# File lib/purecloud/models/dnc_list_create.rb, line 271 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/purecloud/models/dnc_list_create.rb, line 261 def to_s to_hash.to_s end