Class: PureCloud::DialerAuditRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DialerAuditRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
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
# File 'lib/purecloudplatformclientv2/models/dialer_audit_request.rb', line 55

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

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

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

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

end

Instance Attribute Details

#facetsObject

The fields to facet on.



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

def facets
  @facets
end

#filtersObject

The fields to filter on.



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

def filters
  @filters
end

#query_fieldsObject

The fields in which to search for the queryPhrase.



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

def query_fields
  @query_fields
end

#query_phraseObject

The word or words to search for.



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

def query_phrase
  @query_phrase
end

Class Method Details

.attribute_mapObject

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



34
35
36
37
38
39
40
41
# File 'lib/purecloudplatformclientv2/models/dialer_audit_request.rb', line 34

def self.attribute_map
  {
    :'query_phrase' => :'queryPhrase',
    :'query_fields' => :'queryFields',
    :'facets' => :'facets',
    :'filters' => :'filters'
  }
end

.swagger_typesObject

Attribute type mapping.



44
45
46
47
48
49
50
51
# File 'lib/purecloudplatformclientv2/models/dialer_audit_request.rb', line 44

def self.swagger_types
  {
    :'query_phrase' => :'String',
    :'query_fields' => :'Array<String>',
    :'facets' => :'Array<AuditFacet>',
    :'filters' => :'Array<AuditFilter>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



99
100
101
102
103
104
105
106
# File 'lib/purecloudplatformclientv2/models/dialer_audit_request.rb', line 99

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      query_phrase == o.query_phrase &&
      query_fields == o.query_fields &&
      facets == o.facets &&
      filters == o.filters
end

#_deserialize(type, value) ⇒ Object



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/purecloudplatformclientv2/models/dialer_audit_request.rb', line 140

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



200
201
202
203
204
205
206
207
208
209
210
211
212
# File 'lib/purecloudplatformclientv2/models/dialer_audit_request.rb', line 200

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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/purecloudplatformclientv2/models/dialer_audit_request.rb', line 121

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


110
111
112
# File 'lib/purecloudplatformclientv2/models/dialer_audit_request.rb', line 110

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



116
117
118
# File 'lib/purecloudplatformclientv2/models/dialer_audit_request.rb', line 116

def hash
  [query_phrase, query_fields, facets, filters].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons



87
88
89
90
# File 'lib/purecloudplatformclientv2/models/dialer_audit_request.rb', line 87

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



183
184
185
# File 'lib/purecloudplatformclientv2/models/dialer_audit_request.rb', line 183

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



188
189
190
191
192
193
194
195
196
# File 'lib/purecloudplatformclientv2/models/dialer_audit_request.rb', line 188

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_sObject



178
179
180
# File 'lib/purecloudplatformclientv2/models/dialer_audit_request.rb', line 178

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



94
95
# File 'lib/purecloudplatformclientv2/models/dialer_audit_request.rb', line 94

def valid?
end