class PureCloud::SurveyAssignment
Attributes
The URI reference to the flow associated with this survey.
An ISO 8601 repeated interval consisting of the number of repetitions, the start datetime, and the interval (e.g. R2/2018-03-01T13:00:00Z/P1M10DT2H30M). Total duration must not exceed 90 days.
Validated email domain, required
User
together with sendingDomain used to send email, null to use no-reply
The survey form used for this survey.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/survey_assignment.rb, line 37 def self.attribute_map { :'survey_form' => :'surveyForm', :'flow' => :'flow', :'invite_time_interval' => :'inviteTimeInterval', :'sending_user' => :'sendingUser', :'sending_domain' => :'sendingDomain' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/survey_assignment.rb, line 72 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?(:'surveyForm') self.survey_form = attributes[:'surveyForm'] end if attributes.has_key?(:'flow') self.flow = attributes[:'flow'] end if attributes.has_key?(:'inviteTimeInterval') self.invite_time_interval = attributes[:'inviteTimeInterval'] end if attributes.has_key?(:'sendingUser') self.sending_user = attributes[:'sendingUser'] end if attributes.has_key?(:'sendingDomain') self.sending_domain = attributes[:'sendingDomain'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/survey_assignment.rb, line 54 def self.swagger_types { :'survey_form' => :'PublishedSurveyFormReference', :'flow' => :'DomainEntityRef', :'invite_time_interval' => :'String', :'sending_user' => :'String', :'sending_domain' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/survey_assignment.rb, line 194 def ==(o) return true if self.equal?(o) self.class == o.class && survey_form == o.survey_form && flow == o.flow && invite_time_interval == o.invite_time_interval && sending_user == o.sending_user && sending_domain == o.sending_domain end
# File lib/purecloudplatformclientv2/models/survey_assignment.rb, line 236 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/survey_assignment.rb, line 296 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/survey_assignment.rb, line 217 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/survey_assignment.rb, line 206 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/survey_assignment.rb, line 212 def hash [survey_form, flow, invite_time_interval, sending_user, sending_domain].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/survey_assignment.rb, line 128 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/survey_assignment.rb, line 284 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/survey_assignment.rb, line 274 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/survey_assignment.rb, line 137 def valid? if @sending_domain.nil? return false end end