Class: PureCloud::SystemPromptAsset

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/system_prompt_asset.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SystemPromptAsset

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 90

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?(:'durationSeconds')
    self.duration_seconds = attributes[:'durationSeconds']
  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?(:'uploadUri')
    self.upload_uri = attributes[:'uploadUri']
  end

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

  if attributes.has_key?(:'hasDefault')
    self.has_default = attributes[:'hasDefault']
  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?(:'selfUri')
    self.self_uri = attributes[:'selfUri']
  end

end

Instance Attribute Details

#duration_seconds ⇒ Object

Returns the value of attribute duration_seconds.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 31

def duration_seconds
  @duration_seconds
end

#has_default ⇒ Object

Returns the value of attribute has_default.



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 41

def has_default
  @has_default
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 22

def id
  @id
end

#language ⇒ Object

The asset resource language



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 29

def language
  @language
end

#language_default ⇒ Object

Returns the value of attribute language_default.



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 43

def language_default
  @language_default
end

#media_uri ⇒ Object

Returns the value of attribute media_uri.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 33

def media_uri
  @media_uri
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 24

def name
  @name
end

#prompt_id ⇒ Object

Returns the value of attribute prompt_id.



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 26

def prompt_id
  @prompt_id
end

#self_uri ⇒ Object

The URI for this object



48
49
50
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 48

def self_uri
  @self_uri
end

#tags ⇒ Object

Returns the value of attribute tags.



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 45

def tags
  @tags
end

#tts_string ⇒ Object

Returns the value of attribute tts_string.



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 35

def tts_string
  @tts_string
end

#upload_status ⇒ Object

Returns the value of attribute upload_status.



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 39

def upload_status
  @upload_status
end

#upload_uri ⇒ Object

Returns the value of attribute upload_uri.



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 37

def upload_uri
  @upload_uri
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 51

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'prompt_id' => :'promptId',
    :'language' => :'language',
    :'duration_seconds' => :'durationSeconds',
    :'media_uri' => :'mediaUri',
    :'tts_string' => :'ttsString',
    :'upload_uri' => :'uploadUri',
    :'upload_status' => :'uploadStatus',
    :'has_default' => :'hasDefault',
    :'language_default' => :'languageDefault',
    :'tags' => :'tags',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 70

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'prompt_id' => :'String',
    :'language' => :'String',
    :'duration_seconds' => :'Float',
    :'media_uri' => :'String',
    :'tts_string' => :'String',
    :'upload_uri' => :'String',
    :'upload_status' => :'String',
    :'has_default' => :'BOOLEAN',
    :'language_default' => :'BOOLEAN',
    :'tags' => :'Hash<String, Array<String>>',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 184

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 &&
      duration_seconds == o.duration_seconds &&
      media_uri == o.media_uri &&
      tts_string == o.tts_string &&
      upload_uri == o.upload_uri &&
      upload_status == o.upload_status &&
      has_default == o.has_default &&
      language_default == o.language_default &&
      tags == o.tags &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 234

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) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 294

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) ⇒ Object

build the object from hash



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 215

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


204
205
206
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



210
211
212
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 210

def hash
  [id, name, prompt_id, language, duration_seconds, media_uri, tts_string, upload_uri, upload_status, has_default, language_default, tags, self_uri].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



154
155
156
157
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 154

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



277
278
279
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 277

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



282
283
284
285
286
287
288
289
290
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 282

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 ⇒ Object 



272
273
274
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 272

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/purecloudplatformclientv2/models/system_prompt_asset.rb', line 161

def valid?
  if @language.nil?
    return false
  end

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