Class: PureCloud::PropertyIndexRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/property_index_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PropertyIndexRequest

Returns a new instance of PropertyIndexRequest.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/purecloud/models/property_index_request.rb', line 43

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'segmentId']
    self.segment_id = attributes[:'segmentId']
  end
  
  if attributes[:'sessionId']
    self.session_id = attributes[:'sessionId']
  end
  
  if attributes[:'timestamp']
    self.timestamp = attributes[:'timestamp']
  end
  
  if attributes[:'properties']
    if (value = attributes[:'properties']).is_a?(Array)
      self.properties = value
    end
  end
  
end

Instance Attribute Details

#properties ⇒ Object

The list of properties to index



15
16
17
 
# File 'lib/purecloud/models/property_index_request.rb', line 15

def properties
  @properties
end

#segment_id ⇒ Object

Attach properties to the indicated segment.



6
7
8
 
# File 'lib/purecloud/models/property_index_request.rb', line 6

def segment_id
  @segment_id
end

#session_id ⇒ Object

Attach properties to a segment in the indicated session. Also requires a timestamp.



9
10
11
 
# File 'lib/purecloud/models/property_index_request.rb', line 9

def session_id
  @session_id
end

#timestamp ⇒ Object

Attach properties to a segment covering a specific point in time. Also requries a sessionId.



12
13
14
 
# File 'lib/purecloud/models/property_index_request.rb', line 12

def timestamp
  @timestamp
end

Class Method Details

.attribute_map ⇒ Object

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



18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/purecloud/models/property_index_request.rb', line 18

def self.attribute_map
  {
    
    :'segment_id' => :'segmentId',
    
    :'session_id' => :'sessionId',
    
    :'timestamp' => :'timestamp',
    
    :'properties' => :'properties'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
39
40
41
 
# File 'lib/purecloud/models/property_index_request.rb', line 33

def self.swagger_types
  {
    :'segment_id' => :'String',
    :'session_id' => :'String',
    :'timestamp' => :'Integer',
    :'properties' => :'Array<AnalyticsProperty>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



71
72
73
74
75
76
77
78
 
# File 'lib/purecloud/models/property_index_request.rb', line 71

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      segment_id == o.segment_id &&
      session_id == o.session_id &&
      timestamp == o.timestamp &&
      properties == o.properties
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/property_index_request.rb', line 110

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/purecloud/models/property_index_request.rb', line 167

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/purecloud/models/property_index_request.rb', line 91

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

Returns:

  • (Boolean)

See Also:

  • `==` method


81
82
83
 
# File 'lib/purecloud/models/property_index_request.rb', line 81

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



86
87
88
 
# File 'lib/purecloud/models/property_index_request.rb', line 86

def hash
  [segment_id, session_id, timestamp, properties].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



150
151
152
 
# File 'lib/purecloud/models/property_index_request.rb', line 150

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



155
156
157
158
159
160
161
162
163
 
# File 'lib/purecloud/models/property_index_request.rb', line 155

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 



145
146
147
 
# File 'lib/purecloud/models/property_index_request.rb', line 145

def to_s
  to_hash.to_s
end