Class: PureCloud::SocializeFilterRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SocializeFilterRequest

Returns a new instance of SocializeFilterRequest.



45
46
47
48
49
50
51
52
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/socialize_filter_request.rb', line 45

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[:'filters']
    if (value = attributes[:'filters']).is_a?(Array)
      self.filters = value
    end
  end
  
  if attributes[:'pageSize']
    self.page_size = attributes[:'pageSize']
  end
  
  if attributes[:'pageNumber']
    self.page_number = attributes[:'pageNumber']
  end
  
  if attributes[:'sortBy']
    self.sort_by = attributes[:'sortBy']
  end
  
  if attributes[:'sortOrder']
    self.sort_order = attributes[:'sortOrder']
  end
  
end

Instance Attribute Details

#filters ⇒ Object

The list of filters used to narrow the return.



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

def filters
  @filters
end

#page_number ⇒ Object

Returns the value of attribute page_number.



10
11
12
 
# File 'lib/purecloud/models/socialize_filter_request.rb', line 10

def page_number
  @page_number
end

#page_size ⇒ Object

Returns the value of attribute page_size.



8
9
10
 
# File 'lib/purecloud/models/socialize_filter_request.rb', line 8

def page_size
  @page_size
end

#sort_by ⇒ Object

Returns the value of attribute sort_by.



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

def sort_by
  @sort_by
end

#sort_order ⇒ Object

Returns the value of attribute sort_order.



14
15
16
 
# File 'lib/purecloud/models/socialize_filter_request.rb', line 14

def sort_order
  @sort_order
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'filters' => :'filters',
    
    :'page_size' => :'pageSize',
    
    :'page_number' => :'pageNumber',
    
    :'sort_by' => :'sortBy',
    
    :'sort_order' => :'sortOrder'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/purecloud/models/socialize_filter_request.rb', line 34

def self.swagger_types
  {
    :'filters' => :'Array<SocializeEntityFilter>',
    :'page_size' => :'Integer',
    :'page_number' => :'Integer',
    :'sort_by' => :'String',
    :'sort_order' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



86
87
88
89
90
91
92
93
94
 
# File 'lib/purecloud/models/socialize_filter_request.rb', line 86

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      filters == o.filters &&
      page_size == o.page_size &&
      page_number == o.page_number &&
      sort_by == o.sort_by &&
      sort_order == o.sort_order
end

#_deserialize(type, value) ⇒ Object 



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
152
153
154
155
156
157
158
159
 
# File 'lib/purecloud/models/socialize_filter_request.rb', line 126

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



183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/purecloud/models/socialize_filter_request.rb', line 183

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



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

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


97
98
99
 
# File 'lib/purecloud/models/socialize_filter_request.rb', line 97

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



102
103
104
 
# File 'lib/purecloud/models/socialize_filter_request.rb', line 102

def hash
  [filters, page_size, page_number, sort_by, sort_order].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



166
167
168
 
# File 'lib/purecloud/models/socialize_filter_request.rb', line 166

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



171
172
173
174
175
176
177
178
179
 
# File 'lib/purecloud/models/socialize_filter_request.rb', line 171

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 



161
162
163
 
# File 'lib/purecloud/models/socialize_filter_request.rb', line 161

def to_s
  to_hash.to_s
end