class PureCloud::DialerCampaignConfigChangeCampaign
Attributes
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/dialer_campaign_config_change_campaign.rb, line 90 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'date_created' => :'dateCreated', :'date_modified' => :'dateModified', :'version' => :'version', :'contact_list' => :'contactList', :'queue' => :'queue', :'dialing_mode' => :'dialingMode', :'script' => :'script', :'edge_group' => :'edgeGroup', :'site' => :'site', :'campaign_status' => :'campaignStatus', :'phone_columns' => :'phoneColumns', :'abandon_rate' => :'abandonRate', :'dnc_lists' => :'dncLists', :'callable_time_set' => :'callableTimeSet', :'call_analysis_response_set' => :'callAnalysisResponseSet', :'caller_name' => :'callerName', :'caller_address' => :'callerAddress', :'outbound_line_count' => :'outboundLineCount', :'errors' => :'errors', :'rule_sets' => :'ruleSets', :'skip_preview_disabled' => :'skipPreviewDisabled', :'preview_time_out_seconds' => :'previewTimeOutSeconds', :'single_number_preview' => :'singleNumberPreview', :'contact_sort' => :'contactSort', :'contact_sorts' => :'contactSorts', :'no_answer_timeout' => :'noAnswerTimeout', :'call_analysis_language' => :'callAnalysisLanguage', :'priority' => :'priority', :'contact_list_filters' => :'contactListFilters', :'division' => :'division', :'agent_owned_column' => :'agentOwnedColumn', :'additional_properties' => :'additionalProperties' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/dialer_campaign_config_change_campaign.rb, line 241 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?(:'contactList') self.contact_list = attributes[:'contactList'] end if attributes.has_key?(:'queue') self.queue = attributes[:'queue'] end if attributes.has_key?(:'dialingMode') self.dialing_mode = attributes[:'dialingMode'] end if attributes.has_key?(:'script') self.script = attributes[:'script'] end if attributes.has_key?(:'edgeGroup') self.edge_group = attributes[:'edgeGroup'] end if attributes.has_key?(:'site') self.site = attributes[:'site'] end if attributes.has_key?(:'campaignStatus') self.campaign_status = attributes[:'campaignStatus'] end if attributes.has_key?(:'phoneColumns') if (value = attributes[:'phoneColumns']).is_a?(Array) self.phone_columns = value end end if attributes.has_key?(:'abandonRate') self.abandon_rate = attributes[:'abandonRate'] end if attributes.has_key?(:'dncLists') if (value = attributes[:'dncLists']).is_a?(Array) self.dnc_lists = value end end if attributes.has_key?(:'callableTimeSet') self.callable_time_set = attributes[:'callableTimeSet'] end if attributes.has_key?(:'callAnalysisResponseSet') self.call_analysis_response_set = attributes[:'callAnalysisResponseSet'] end if attributes.has_key?(:'callerName') self.caller_name = attributes[:'callerName'] end if attributes.has_key?(:'callerAddress') self.caller_address = attributes[:'callerAddress'] end if attributes.has_key?(:'outboundLineCount') self.outbound_line_count = attributes[:'outboundLineCount'] end if attributes.has_key?(:'errors') if (value = attributes[:'errors']).is_a?(Array) self.errors = value end end if attributes.has_key?(:'ruleSets') if (value = attributes[:'ruleSets']).is_a?(Array) self.rule_sets = value end end if attributes.has_key?(:'skipPreviewDisabled') self.skip_preview_disabled = attributes[:'skipPreviewDisabled'] end if attributes.has_key?(:'previewTimeOutSeconds') self.preview_time_out_seconds = attributes[:'previewTimeOutSeconds'] end if attributes.has_key?(:'singleNumberPreview') self.single_number_preview = attributes[:'singleNumberPreview'] end if attributes.has_key?(:'contactSort') self.contact_sort = attributes[:'contactSort'] end if attributes.has_key?(:'contactSorts') if (value = attributes[:'contactSorts']).is_a?(Array) self.contact_sorts = value end end if attributes.has_key?(:'noAnswerTimeout') self.no_answer_timeout = attributes[:'noAnswerTimeout'] end if attributes.has_key?(:'callAnalysisLanguage') self.call_analysis_language = attributes[:'callAnalysisLanguage'] end if attributes.has_key?(:'priority') self.priority = attributes[:'priority'] end if attributes.has_key?(:'contactListFilters') if (value = attributes[:'contactListFilters']).is_a?(Array) self.contact_list_filters = value end end if attributes.has_key?(:'division') self.division = attributes[:'division'] end if attributes.has_key?(:'agentOwnedColumn') self.agent_owned_column = attributes[:'agentOwnedColumn'] end if attributes.has_key?(:'additionalProperties') self.additional_properties = attributes[:'additionalProperties'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/dialer_campaign_config_change_campaign.rb, line 165 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'date_created' => :'DateTime', :'date_modified' => :'DateTime', :'version' => :'Integer', :'contact_list' => :'DialerCampaignConfigChangeUriReference', :'queue' => :'DialerCampaignConfigChangeUriReference', :'dialing_mode' => :'String', :'script' => :'DialerCampaignConfigChangeUriReference', :'edge_group' => :'DialerCampaignConfigChangeUriReference', :'site' => :'DialerCampaignConfigChangeUriReference', :'campaign_status' => :'String', :'phone_columns' => :'Array<DialerCampaignConfigChangePhoneColumn>', :'abandon_rate' => :'Float', :'dnc_lists' => :'Array<DialerCampaignConfigChangeUriReference>', :'callable_time_set' => :'DialerCampaignConfigChangeUriReference', :'call_analysis_response_set' => :'DialerCampaignConfigChangeUriReference', :'caller_name' => :'String', :'caller_address' => :'String', :'outbound_line_count' => :'Integer', :'errors' => :'Array<DialerCampaignConfigChangeRestErrorDetail>', :'rule_sets' => :'Array<DialerCampaignConfigChangeUriReference>', :'skip_preview_disabled' => :'BOOLEAN', :'preview_time_out_seconds' => :'Integer', :'single_number_preview' => :'BOOLEAN', :'contact_sort' => :'DialerCampaignConfigChangeContactSort', :'contact_sorts' => :'Array<DialerCampaignConfigChangeContactSort>', :'no_answer_timeout' => :'Integer', :'call_analysis_language' => :'String', :'priority' => :'Integer', :'contact_list_filters' => :'Array<DialerCampaignConfigChangeUriReference>', :'division' => :'DialerCampaignConfigChangeUriReference', :'agent_owned_column' => :'String', :'additional_properties' => :'Object' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/dialer_campaign_config_change_campaign.rb, line 920 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 && contact_list == o.contact_list && queue == o.queue && dialing_mode == o.dialing_mode && script == o.script && edge_group == o.edge_group && site == o.site && campaign_status == o.campaign_status && phone_columns == o.phone_columns && abandon_rate == o.abandon_rate && dnc_lists == o.dnc_lists && callable_time_set == o.callable_time_set && call_analysis_response_set == o.call_analysis_response_set && caller_name == o.caller_name && caller_address == o.caller_address && outbound_line_count == o.outbound_line_count && errors == o.errors && rule_sets == o.rule_sets && skip_preview_disabled == o.skip_preview_disabled && preview_time_out_seconds == o.preview_time_out_seconds && single_number_preview == o.single_number_preview && contact_sort == o.contact_sort && contact_sorts == o.contact_sorts && no_answer_timeout == o.no_answer_timeout && call_analysis_language == o.call_analysis_language && priority == o.priority && contact_list_filters == o.contact_list_filters && division == o.division && agent_owned_column == o.agent_owned_column && additional_properties == o.additional_properties end
# File lib/purecloudplatformclientv2/models/dialer_campaign_config_change_campaign.rb, line 991 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/dialer_campaign_config_change_campaign.rb, line 1051 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/dialer_campaign_config_change_campaign.rb, line 972 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] campaign_status
Object to be assigned
# File lib/purecloudplatformclientv2/models/dialer_campaign_config_change_campaign.rb, line 797 def campaign_status=(campaign_status) allowed_values = ["ON", "OFF", "COMPLETE", "STOPPING", "INVALID"] if campaign_status && !allowed_values.include?(campaign_status) fail ArgumentError, "invalid value for 'campaign_status', must be one of #{allowed_values}." end @campaign_status = campaign_status end
Custom attribute writer method checking allowed values (enum). @param [Object] dialing_mode
Object to be assigned
# File lib/purecloudplatformclientv2/models/dialer_campaign_config_change_campaign.rb, line 768 def dialing_mode=(dialing_mode) allowed_values = ["AGENTLESS", "EXTERNAL", "PREVIEW", "POWER", "PREDICTIVE", "PROGRESSIVE"] if dialing_mode && !allowed_values.include?(dialing_mode) fail ArgumentError, "invalid value for 'dialing_mode', must be one of #{allowed_values}." end @dialing_mode = dialing_mode end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/dialer_campaign_config_change_campaign.rb, line 961 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/dialer_campaign_config_change_campaign.rb, line 967 def hash [id, name, date_created, date_modified, version, contact_list, queue, dialing_mode, script, edge_group, site, campaign_status, phone_columns, abandon_rate, dnc_lists, callable_time_set, call_analysis_response_set, caller_name, caller_address, outbound_line_count, errors, rule_sets, skip_preview_disabled, preview_time_out_seconds, single_number_preview, contact_sort, contact_sorts, no_answer_timeout, call_analysis_language, priority, contact_list_filters, division, agent_owned_column, additional_properties].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/dialer_campaign_config_change_campaign.rb, line 570 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/dialer_campaign_config_change_campaign.rb, line 1039 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/dialer_campaign_config_change_campaign.rb, line 1029 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/dialer_campaign_config_change_campaign.rb, line 579 def valid? allowed_values = ["AGENTLESS", "EXTERNAL", "PREVIEW", "POWER", "PREDICTIVE", "PROGRESSIVE"] if @dialing_mode && !allowed_values.include?(@dialing_mode) return false end allowed_values = ["ON", "OFF", "COMPLETE", "STOPPING", "INVALID"] if @campaign_status && !allowed_values.include?(@campaign_status) return false end end