Class: SunshineConversationsClient::Page

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/models/page.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Page

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
75
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 49

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Page` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SunshineConversationsClient::Page`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'after')
    self.after = attributes[:'after']
  end

  if attributes.key?(:'before')
    self.before = attributes[:'before']
  end

  if attributes.key?(:'size')
    self.size = attributes[:'size']
  else
    self.size = 25
  end
end

Instance Attribute Details

#after ⇒ Object

A record id. Results will only contain the records that come after the specified record. Only one of ‘after` or `before` can be provided, not both.



15
16
17
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 15

def after
  @after
end

#before ⇒ Object

A record id. Results will only contain the records that come before the specified record. Only one of ‘after` or `before` can be provided, not both.



18
19
20
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 18

def before
  @before
end

#size ⇒ Object

The number of records to return. Does not apply to the ‘listMessages` endpoint.



21
22
23
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 21

def size
  @size
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 24

def self.attribute_map
  {
    :'after' => :'after',
    :'before' => :'before',
    :'size' => :'size'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



187
188
189
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 187

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



42
43
44
45
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 42

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
39
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 33

def self.openapi_types
  {
    :'after' => :'String',
    :'before' => :'String',
    :'size' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



164
165
166
167
168
169
170
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      after == o.after &&
      before == o.before &&
      size == o.size
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 215

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 =~ /\A(true|t|yes|y|1)\z/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
    SunshineConversationsClient.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 284

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 194

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


174
175
176
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



180
181
182
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 180

def hash
  [after, before, size].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 79

def list_invalid_properties
  invalid_properties = Array.new
  if !@after.nil? && @after.to_s.length > 24
    invalid_properties.push('invalid value for "after", the character length must be smaller than or equal to 24.')
  end

  if !@after.nil? && @after.to_s.length < 24
    invalid_properties.push('invalid value for "after", the character length must be great than or equal to 24.')
  end

  if !@before.nil? && @before.to_s.length > 24
    invalid_properties.push('invalid value for "before", the character length must be smaller than or equal to 24.')
  end

  if !@before.nil? && @before.to_s.length < 24
    invalid_properties.push('invalid value for "before", the character length must be great than or equal to 24.')
  end

  if !@size.nil? && @size > 100
    invalid_properties.push('invalid value for "size", must be smaller than or equal to 100.')
  end

  if !@size.nil? && @size < 1
    invalid_properties.push('invalid value for "size", must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



260
261
262
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 260

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 266

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



254
255
256
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 254

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



110
111
112
113
114
115
116
117
118
 
# File 'lib/sunshine-conversations-client/models/page.rb', line 110

def valid?
  return false if !@after.nil? && @after.to_s.length > 24
  return false if !@after.nil? && @after.to_s.length < 24
  return false if !@before.nil? && @before.to_s.length > 24
  return false if !@before.nil? && @before.to_s.length < 24
  return false if !@size.nil? && @size > 100
  return false if !@size.nil? && @size < 1
  true
end