Class: PureCloud::WfmHistoricalAdherenceResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb

Overview

Response for Historical Adherence Query, intended to tell the client what to listen for on a notification topic

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WfmHistoricalAdherenceResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 59

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

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

  
end

Instance Attribute Details

#download_url ⇒ Object

The uri to query to GET the results of the Historical Adherence query. This will return unpopulated but will be populated in the notification



26
27
28
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 26

def download_url
  @download_url
end

#id ⇒ Object

The query ID to listen for



23
24
25
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 23

def id
  @id
end

#query_state ⇒ Object

The state of the adherence query



29
30
31
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 29

def query_state
  @query_state
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 32

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'download_url' => :'downloadUrl',
    
    :'query_state' => :'queryState'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 45

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'download_url' => :'String',
    
    :'query_state' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



154
155
156
157
158
159
160
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 154

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      download_url == o.download_url &&
      query_state == o.query_state
end

#_deserialize(type, value) ⇒ Object 



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
223
224
225
226
227
228
229
230
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 194

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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 254

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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 175

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


164
165
166
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 164

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



170
171
172
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 170

def hash
  [id, download_url, query_state].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



97
98
99
100
101
102
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 97

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



237
238
239
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 237

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



242
243
244
245
246
247
248
249
250
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 242

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 



232
233
234
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 232

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb', line 106

def valid?
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["Processing", "Complete", "Error"]
  if @query_state && !allowed_values.include?(@query_state)
    return false
  end
  
  
  
end