class PureCloud::MessagingSticker
Attributes
The globally unique identifier for the object.
The type of the messenger provider.
The package name of the sticker, assigned by the sticker provider.
The package Id of the sticker, assigned by the sticker provider.
The sticker Id of the sticker, assigned by the sticker provider.
The version of the sticker, assigned by the provider.
The URI for this object
The type of the sticker.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/messaging_sticker.rb, line 50 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'provider_sticker_id' => :'providerStickerId', :'provider_package_id' => :'providerPackageId', :'package_name' => :'packageName', :'messenger_type' => :'messengerType', :'sticker_type' => :'stickerType', :'provider_version' => :'providerVersion', :'uri_location' => :'uriLocation', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/messaging_sticker.rb, line 105 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?(:'providerStickerId') self.provider_sticker_id = attributes[:'providerStickerId'] end if attributes.has_key?(:'providerPackageId') self.provider_package_id = attributes[:'providerPackageId'] end if attributes.has_key?(:'packageName') self.package_name = attributes[:'packageName'] end if attributes.has_key?(:'messengerType') self.messenger_type = attributes[:'messengerType'] end if attributes.has_key?(:'stickerType') self.sticker_type = attributes[:'stickerType'] end if attributes.has_key?(:'providerVersion') self.provider_version = attributes[:'providerVersion'] end if attributes.has_key?(:'uriLocation') self.uri_location = attributes[:'uriLocation'] end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/messaging_sticker.rb, line 77 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'provider_sticker_id' => :'Integer', :'provider_package_id' => :'Integer', :'package_name' => :'String', :'messenger_type' => :'String', :'sticker_type' => :'String', :'provider_version' => :'Integer', :'uri_location' => :'String', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/messaging_sticker.rb, line 355 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && provider_sticker_id == o.provider_sticker_id && provider_package_id == o.provider_package_id && package_name == o.package_name && messenger_type == o.messenger_type && sticker_type == o.sticker_type && provider_version == o.provider_version && uri_location == o.uri_location && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/messaging_sticker.rb, line 402 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/messaging_sticker.rb, line 462 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/messaging_sticker.rb, line 383 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/messaging_sticker.rb, line 372 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/messaging_sticker.rb, line 378 def hash [id, name, provider_sticker_id, provider_package_id, package_name, messenger_type, sticker_type, provider_version, uri_location, 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/messaging_sticker.rb, line 206 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] messenger_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/messaging_sticker.rb, line 313 def messenger_type=(messenger_type) allowed_values = ["sms", "facebook", "twitter", "line", "whatsapp", "webmessaging"] if messenger_type && !allowed_values.include?(messenger_type) fail ArgumentError, "invalid value for 'messenger_type', must be one of #{allowed_values}." end @messenger_type = messenger_type end
Custom attribute writer method checking allowed values (enum). @param [Object] sticker_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/messaging_sticker.rb, line 327 def sticker_type=(sticker_type) allowed_values = ["standard", "free", "paid"] if sticker_type && !allowed_values.include?(sticker_type) fail ArgumentError, "invalid value for 'sticker_type', must be one of #{allowed_values}." end @sticker_type = sticker_type end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/messaging_sticker.rb, line 450 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/messaging_sticker.rb, line 440 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/messaging_sticker.rb, line 215 def valid? if @provider_sticker_id.nil? return false end if @messenger_type.nil? return false end allowed_values = ["sms", "facebook", "twitter", "line", "whatsapp", "webmessaging"] if @messenger_type && !allowed_values.include?(@messenger_type) return false end if @sticker_type.nil? return false end allowed_values = ["standard", "free", "paid"] if @sticker_type && !allowed_values.include?(@sticker_type) return false end end