class PureCloud::CampaignSequence
Attributes
The ordered list of Campaigns that this CampaignSequence
will run.
A zero-based index indicating which Campaign
this CampaignSequence
is currently on.
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.
Indicates if a sequence should repeat from the beginning after the last campaign completes. Default is false.
The URI for this object
The current status of the CampaignSequence
. A CampaignSequence
can be turned 'on' or 'off'.
A message indicating if and why a CampaignSequence
has stopped unexpectedly.
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/campaign_sequence.rb, line 54 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'date_created' => :'dateCreated', :'date_modified' => :'dateModified', :'version' => :'version', :'campaigns' => :'campaigns', :'current_campaign' => :'currentCampaign', :'status' => :'status', :'stop_message' => :'stopMessage', :'repeat' => :'repeat', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/campaign_sequence.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?(:'campaigns') if (value = attributes[:'campaigns']).is_a?(Array) self.campaigns = value end end if attributes.has_key?(:'currentCampaign') self.current_campaign = attributes[:'currentCampaign'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'stopMessage') self.stop_message = attributes[:'stopMessage'] end if attributes.has_key?(:'repeat') self.repeat = attributes[:'repeat'] end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/campaign_sequence.rb, line 83 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'date_created' => :'DateTime', :'date_modified' => :'DateTime', :'version' => :'Integer', :'campaigns' => :'Array<DomainEntityRef>', :'current_campaign' => :'Integer', :'status' => :'String', :'stop_message' => :'String', :'repeat' => :'BOOLEAN', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/campaign_sequence.rb, line 369 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 && campaigns == o.campaigns && current_campaign == o.current_campaign && status == o.status && stop_message == o.stop_message && repeat == o.repeat && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/campaign_sequence.rb, line 417 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/campaign_sequence.rb, line 477 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/campaign_sequence.rb, line 398 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/campaign_sequence.rb, line 387 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/campaign_sequence.rb, line 393 def hash [id, name, date_created, date_modified, version, campaigns, current_campaign, status, stop_message, repeat, 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/campaign_sequence.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] status Object to be assigned
# File lib/purecloudplatformclientv2/models/campaign_sequence.rb, line 341 def status=(status) allowed_values = ["on", "off", "complete"] if status && !allowed_values.include?(status) fail ArgumentError, "invalid value for 'status', must be one of #{allowed_values}." end @status = status end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/campaign_sequence.rb, line 465 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/campaign_sequence.rb, line 455 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/campaign_sequence.rb, line 234 def valid? if @campaigns.nil? return false end if @current_campaign.nil? return false end if @status.nil? return false end allowed_values = ["on", "off", "complete"] if @status && !allowed_values.include?(@status) return false end end