class PureCloud::PromptAssetCreate

Attributes

duration_seconds[RW]
id[RW]

The globally unique identifier for the object.

language[RW]

The prompt language.

language_default[RW]

Whether or not this resource locale is the default for the language

media_uri[RW]

URI of the resource audio

name[RW]
prompt_id[RW]

Associated prompt ID

self_uri[RW]

The URI for this object

tags[RW]
text[RW]

Text of the resource

tts_string[RW]

Text to speech of the resource

upload_status[RW]

Audio upload status

upload_uri[RW]

Upload URI for the resource audio

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/purecloudplatformclientv2/models/prompt_asset_create.rb, line 58
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'prompt_id' => :'promptId',
    
    :'language' => :'language',
    
    :'media_uri' => :'mediaUri',
    
    :'tts_string' => :'ttsString',
    
    :'text' => :'text',
    
    :'upload_status' => :'uploadStatus',
    
    :'upload_uri' => :'uploadUri',
    
    :'language_default' => :'languageDefault',
    
    :'tags' => :'tags',
    
    :'duration_seconds' => :'durationSeconds',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/prompt_asset_create.rb, line 125
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?(:'promptId')
    
    
    self.prompt_id = attributes[:'promptId']
    
  
  end

  
  if attributes.has_key?(:'language')
    
    
    self.language = attributes[:'language']
    
  
  end

  
  if attributes.has_key?(:'mediaUri')
    
    
    self.media_uri = attributes[:'mediaUri']
    
  
  end

  
  if attributes.has_key?(:'ttsString')
    
    
    self.tts_string = attributes[:'ttsString']
    
  
  end

  
  if attributes.has_key?(:'text')
    
    
    self.text = attributes[:'text']
    
  
  end

  
  if attributes.has_key?(:'uploadStatus')
    
    
    self.upload_status = attributes[:'uploadStatus']
    
  
  end

  
  if attributes.has_key?(:'uploadUri')
    
    
    self.upload_uri = attributes[:'uploadUri']
    
  
  end

  
  if attributes.has_key?(:'languageDefault')
    
    
    self.language_default = attributes[:'languageDefault']
    
  
  end

  
  if attributes.has_key?(:'tags')
    
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'durationSeconds')
    
    
    self.duration_seconds = attributes[:'durationSeconds']
    
  
  end

  
  if attributes.has_key?(:'selfUri')
    
    
    self.self_uri = attributes[:'selfUri']
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/prompt_asset_create.rb, line 91
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'prompt_id' => :'String',
    
    :'language' => :'String',
    
    :'media_uri' => :'String',
    
    :'tts_string' => :'String',
    
    :'text' => :'String',
    
    :'upload_status' => :'String',
    
    :'upload_uri' => :'String',
    
    :'language_default' => :'BOOLEAN',
    
    :'tags' => :'Hash<String, Array<String>>',
    
    :'duration_seconds' => :'Float',
    
    :'self_uri' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/prompt_asset_create.rb, line 407
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      prompt_id == o.prompt_id &&
      language == o.language &&
      media_uri == o.media_uri &&
      tts_string == o.tts_string &&
      text == o.text &&
      upload_status == o.upload_status &&
      upload_uri == o.upload_uri &&
      language_default == o.language_default &&
      tags == o.tags &&
      duration_seconds == o.duration_seconds &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/prompt_asset_create.rb, line 457
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
_to_hash(value) click to toggle source

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/prompt_asset_create.rb, line 517
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_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/prompt_asset_create.rb, line 438
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/prompt_asset_create.rb, line 427
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/prompt_asset_create.rb, line 433
def hash
  [id, name, prompt_id, language, media_uri, tts_string, text, upload_status, upload_uri, language_default, tags, duration_seconds, self_uri].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/prompt_asset_create.rb, line 255
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/prompt_asset_create.rb, line 500
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/prompt_asset_create.rb, line 505
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
to_s() click to toggle source
# File lib/purecloudplatformclientv2/models/prompt_asset_create.rb, line 495
def to_s
  to_hash.to_s
end
upload_status=(upload_status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] upload_status Object to be assigned

# File lib/purecloudplatformclientv2/models/prompt_asset_create.rb, line 369
def upload_status=(upload_status)
  allowed_values = ["created", "uploaded", "transcoded", "transcodeFailed"]
  if upload_status && !allowed_values.include?(upload_status)
    fail ArgumentError, "invalid value for 'upload_status', must be one of #{allowed_values}."
  end
  @upload_status = upload_status
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/purecloudplatformclientv2/models/prompt_asset_create.rb, line 264
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @language.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["created", "uploaded", "transcoded", "transcodeFailed"]
  if @upload_status && !allowed_values.include?(@upload_status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end