Class: PureCloud::PolicyActions

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PolicyActions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
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
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 74

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?(:'retainRecording')
    self.retain_recording = attributes[:'retainRecording']
  end

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#always_delete ⇒ Object

true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 28

def always_delete
  @always_delete
end

#assign_calibrations ⇒ Object

Returns the value of attribute assign_calibrations.



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 34

def assign_calibrations
  @assign_calibrations
end

#assign_evaluations ⇒ Object

Returns the value of attribute assign_evaluations.



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 30

def assign_evaluations
  @assign_evaluations
end

#assign_metered_evaluations ⇒ Object

Returns the value of attribute assign_metered_evaluations.



32
33
34
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 32

def assign_metered_evaluations
  @assign_metered_evaluations
end

#delete_recording ⇒ Object

true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 25

def delete_recording
  @delete_recording
end

#initiate_screen_recording ⇒ Object

Returns the value of attribute initiate_screen_recording.



38
39
40
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 38

def initiate_screen_recording
  @initiate_screen_recording
end

#media_transcriptions ⇒ Object

Returns the value of attribute media_transcriptions.



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 40

def media_transcriptions
  @media_transcriptions
end

#retain_recording ⇒ Object

true to retain the recording associated with the conversation. Default = true



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

def retain_recording
  @retain_recording
end

#retention_duration ⇒ Object

Returns the value of attribute retention_duration.



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 36

def retention_duration
  @retention_duration
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 43

def self.attribute_map
  {
    :'retain_recording' => :'retainRecording',
    :'delete_recording' => :'deleteRecording',
    :'always_delete' => :'alwaysDelete',
    :'assign_evaluations' => :'assignEvaluations',
    :'assign_metered_evaluations' => :'assignMeteredEvaluations',
    :'assign_calibrations' => :'assignCalibrations',
    :'retention_duration' => :'retentionDuration',
    :'initiate_screen_recording' => :'initiateScreenRecording',
    :'media_transcriptions' => :'mediaTranscriptions'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 58

def self.swagger_types
  {
    :'retain_recording' => :'BOOLEAN',
    :'delete_recording' => :'BOOLEAN',
    :'always_delete' => :'BOOLEAN',
    :'assign_evaluations' => :'Array<EvaluationAssignment>',
    :'assign_metered_evaluations' => :'Array<MeteredEvaluationAssignment>',
    :'assign_calibrations' => :'Array<CalibrationAssignment>',
    :'retention_duration' => :'RetentionDuration',
    :'initiate_screen_recording' => :'InitiateScreenRecording',
    :'media_transcriptions' => :'Array<MediaTranscription>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      retain_recording == o.retain_recording &&
      delete_recording == o.delete_recording &&
      always_delete == o.always_delete &&
      assign_evaluations == o.assign_evaluations &&
      assign_metered_evaluations == o.assign_metered_evaluations &&
      assign_calibrations == o.assign_calibrations &&
      retention_duration == o.retention_duration &&
      initiate_screen_recording == o.initiate_screen_recording &&
      media_transcriptions == o.media_transcriptions
end

#_deserialize(type, value) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 186

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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 246

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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 167

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


156
157
158
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 156

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



162
163
164
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 162

def hash
  [retain_recording, delete_recording, always_delete, assign_evaluations, assign_metered_evaluations, assign_calibrations, retention_duration, initiate_screen_recording, media_transcriptions].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



128
129
130
131
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 128

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



229
230
231
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 229

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



234
235
236
237
238
239
240
241
242
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 234

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 



224
225
226
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 224

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



135
136
 
# File 'lib/purecloudplatformclientv2/models/policy_actions.rb', line 135

def valid?
end