class PureCloud::Response
Contains information about a response.
Attributes
User
that created the response
The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The globally unique identifier for the object.
The interaction type for this response.
One or more libraries response is associated with.
An optional messaging template definition for responseType.MessagingTemplate.
The response type represented by the response.
The URI for this object
Details about any text substitutions used in the texts for this response.
Metadata about the text substitutions in json schema format.
One or more texts associated with the response.
Version number required for updates.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/response.rb, line 61 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'version' => :'version', :'libraries' => :'libraries', :'texts' => :'texts', :'created_by' => :'createdBy', :'date_created' => :'dateCreated', :'interaction_type' => :'interactionType', :'substitutions' => :'substitutions', :'substitutions_schema' => :'substitutionsSchema', :'response_type' => :'responseType', :'messaging_template' => :'messagingTemplate', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/response.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?(:'version') self.version = attributes[:'version'] end if attributes.has_key?(:'libraries') if (value = attributes[:'libraries']).is_a?(Array) self.libraries = value end end if attributes.has_key?(:'texts') if (value = attributes[:'texts']).is_a?(Array) self.texts = value end end if attributes.has_key?(:'createdBy') self.created_by = attributes[:'createdBy'] end if attributes.has_key?(:'dateCreated') self.date_created = attributes[:'dateCreated'] end if attributes.has_key?(:'interactionType') self.interaction_type = attributes[:'interactionType'] end if attributes.has_key?(:'substitutions') if (value = attributes[:'substitutions']).is_a?(Array) self.substitutions = value end end if attributes.has_key?(:'substitutionsSchema') self.substitutions_schema = attributes[:'substitutionsSchema'] end if attributes.has_key?(:'responseType') self.response_type = attributes[:'responseType'] end if attributes.has_key?(:'messagingTemplate') self.messaging_template = attributes[:'messagingTemplate'] end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/response.rb, line 94 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'version' => :'Integer', :'libraries' => :'Array<DomainEntityRef>', :'texts' => :'Array<ResponseText>', :'created_by' => :'User', :'date_created' => :'DateTime', :'interaction_type' => :'String', :'substitutions' => :'Array<ResponseSubstitution>', :'substitutions_schema' => :'JsonSchemaDocument', :'response_type' => :'String', :'messaging_template' => :'MessagingTemplate', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/response.rb, line 433 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && version == o.version && libraries == o.libraries && texts == o.texts && created_by == o.created_by && date_created == o.date_created && interaction_type == o.interaction_type && substitutions == o.substitutions && substitutions_schema == o.substitutions_schema && response_type == o.response_type && messaging_template == o.messaging_template && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/response.rb, line 483 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/response.rb, line 543 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/response.rb, line 464 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/response.rb, line 453 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/response.rb, line 459 def hash [id, name, version, libraries, texts, created_by, date_created, interaction_type, substitutions, substitutions_schema, response_type, messaging_template, self_uri].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] interaction_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/response.rb, line 386 def interaction_type=(interaction_type) allowed_values = ["chat", "email", "twitter"] if interaction_type && !allowed_values.include?(interaction_type) fail ArgumentError, "invalid value for 'interaction_type', must be one of #{allowed_values}." end @interaction_type = interaction_type end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/response.rb, line 262 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] response_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/response.rb, line 410 def response_type=(response_type) allowed_values = ["MessagingTemplate", "CampaignSmsTemplate"] if response_type && !allowed_values.include?(response_type) fail ArgumentError, "invalid value for 'response_type', must be one of #{allowed_values}." end @response_type = response_type end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/response.rb, line 531 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/response.rb, line 521 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/response.rb, line 271 def valid? if @libraries.nil? return false end if @texts.nil? return false end allowed_values = ["chat", "email", "twitter"] if @interaction_type && !allowed_values.include?(@interaction_type) return false end allowed_values = ["MessagingTemplate", "CampaignSmsTemplate"] if @response_type && !allowed_values.include?(@response_type) return false end end