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.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/purecloud/models/property_index_request.rb', line 53

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[:'sessionId']
    self.session_id = attributes[:'sessionId']
  end
  
  if attributes[:'targetDate']
    self.target_date = attributes[:'targetDate']
  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



28
29
30
 
# File 'lib/purecloud/models/property_index_request.rb', line 28

def properties
  @properties
end

#session_id ⇒ Object

Attach properties to a segment in the indicated session



22
23
24
 
# File 'lib/purecloud/models/property_index_request.rb', line 22

def session_id
  @session_id
end

#target_date ⇒ Object

Attach properties to a segment covering a specific point in time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



25
26
27
 
# File 'lib/purecloud/models/property_index_request.rb', line 25

def target_date
  @target_date
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'session_id' => :'sessionId',
    
    :'target_date' => :'targetDate',
    
    :'properties' => :'properties'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'session_id' => :'String',
    :'target_date' => :'DateTime',
    :'properties' => :'Array<AnalyticsProperty>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



77
78
79
80
81
82
83
 
# File 'lib/purecloud/models/property_index_request.rb', line 77

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

#_deserialize(type, value) ⇒ Object 



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

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



175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/purecloud/models/property_index_request.rb', line 175

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/purecloud/models/property_index_request.rb', line 96

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


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

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



91
92
93
 
# File 'lib/purecloud/models/property_index_request.rb', line 91

def hash
  [session_id, target_date, properties].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



158
159
160
 
# File 'lib/purecloud/models/property_index_request.rb', line 158

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



163
164
165
166
167
168
169
170
171
 
# File 'lib/purecloud/models/property_index_request.rb', line 163

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 



153
154
155
 
# File 'lib/purecloud/models/property_index_request.rb', line 153

def to_s
  to_hash.to_s
end