Class: PinterestSdkClient::GetInvites200Response

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/pinterest_sdk/models/get_invites200_response.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 = {}) ⇒ GetInvites200Response

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 65

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::GetInvites200Response` 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 `PinterestSdkClient::GetInvites200Response`. 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?(:'bookmark')
    self.bookmark = attributes[:'bookmark']
  end

  if attributes.key?(:'items')
    if (value = attributes[:'items']).is_a?(Array)
      self.items = value
    end
  else
    self.items = nil
  end
end

Instance Attribute Details

#bookmark ⇒ Object

Returns the value of attribute bookmark.



18
19
20
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 18

def bookmark
  @bookmark
end

#items ⇒ Object

List of invite and request data.



21
22
23
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 21

def items
  @items
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



32
33
34
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 32

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



37
38
39
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 37

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



24
25
26
27
28
29
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 24

def self.attribute_map
  {
    :'bookmark' => :'bookmark',
    :'items' => :'items'
  }
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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 146

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



57
58
59
60
61
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 57

def self.openapi_all_of
  [
  :'Paginated'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



50
51
52
53
54
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 50

def self.openapi_nullable
  Set.new([
    :'bookmark',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 42

def self.openapi_types
  {
    :'bookmark' => :'String',
    :'items' => :'Array<InviteResponse>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



124
125
126
127
128
129
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 124

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bookmark == o.bookmark &&
      items == o.items
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


133
134
135
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 133

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



139
140
141
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 139

def hash
  [bookmark, items].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



94
95
96
97
98
99
100
101
102
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 94

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @items.nil?
    invalid_properties.push('invalid value for "items", items cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 168

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



106
107
108
109
110
 
# File 'lib/pinterest_sdk/models/get_invites200_response.rb', line 106

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @items.nil?
  true
end