Class: PinterestSdkClient::AuthRespondInvitesBody

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/pinterest_sdk/models/auth_respond_invites_body.rb

Overview

An object with a list of all the invites the user would like to respond to and the action to take.

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 = {}) ⇒ AuthRespondInvitesBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

Instance Attribute Details

#invitesObject

Returns the value of attribute invites.



19
20
21
# File 'lib/pinterest_sdk/models/auth_respond_invites_body.rb', line 19

def invites
  @invites
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



29
30
31
# File 'lib/pinterest_sdk/models/auth_respond_invites_body.rb', line 29

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



34
35
36
# File 'lib/pinterest_sdk/models/auth_respond_invites_body.rb', line 34

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



22
23
24
25
26
# File 'lib/pinterest_sdk/models/auth_respond_invites_body.rb', line 22

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



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

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_nullableObject

List of attributes with nullable: true



46
47
48
49
# File 'lib/pinterest_sdk/models/auth_respond_invites_body.rb', line 46

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

.openapi_typesObject

Attribute type mapping.



39
40
41
42
43
# File 'lib/pinterest_sdk/models/auth_respond_invites_body.rb', line 39

def self.openapi_types
  {
    :'invites' => :'Array<AuthRespondInvitesBodyInvitesInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



126
127
128
129
130
# File 'lib/pinterest_sdk/models/auth_respond_invites_body.rb', line 126

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


134
135
136
# File 'lib/pinterest_sdk/models/auth_respond_invites_body.rb', line 134

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



140
141
142
# File 'lib/pinterest_sdk/models/auth_respond_invites_body.rb', line 140

def hash
  [invites].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/pinterest_sdk/models/auth_respond_invites_body.rb', line 78

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

  if @invites.length > 100
    invalid_properties.push('invalid value for "invites", number of items must be less than or equal to 100.')
  end

  if @invites.length < 1
    invalid_properties.push('invalid value for "invites", number of items must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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



98
99
100
101
102
103
104
# File 'lib/pinterest_sdk/models/auth_respond_invites_body.rb', line 98

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @invites.nil?
  return false if @invites.length > 100
  return false if @invites.length < 1
  true
end