Class: Bandwidth::PageInfo

Inherits:
ApiModelBase show all
Defined in:
lib/bandwidth-sdk/models/page_info.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ PageInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 68

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

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

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

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

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

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

Instance Attribute Details

#next_page ⇒ Object

The link to the next page for pagination.



22
23
24
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 22

def next_page
  @next_page
end

#next_page_token ⇒ Object

The isolated pagination token for the next page.



28
29
30
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 28

def next_page_token
  @next_page_token
end

#prev_page ⇒ Object

The link to the previous page for pagination.



19
20
21
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 19

def prev_page
  @prev_page
end

#prev_page_token ⇒ Object

The isolated pagination token for the previous page.



25
26
27
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 25

def prev_page_token
  @prev_page_token
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



41
42
43
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 41

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



46
47
48
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 46

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 31

def self.attribute_map
  {
    :'prev_page' => :'prevPage',
    :'next_page' => :'nextPage',
    :'prev_page_token' => :'prevPageToken',
    :'next_page_token' => :'nextPageToken'
  }
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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 140

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 61

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

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 51

def self.openapi_types
  {
    :'prev_page' => :'String',
    :'next_page' => :'String',
    :'prev_page_token' => :'String',
    :'next_page_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



116
117
118
119
120
121
122
123
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 116

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      prev_page == o.prev_page &&
      next_page == o.next_page &&
      prev_page_token == o.prev_page_token &&
      next_page_token == o.next_page_token
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


127
128
129
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 127

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



133
134
135
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 133

def hash
  [prev_page, next_page, prev_page_token, next_page_token].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



101
102
103
104
105
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 101

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 162

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



109
110
111
112
 
# File 'lib/bandwidth-sdk/models/page_info.rb', line 109

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end