Class: PinterestSdkClient::BusinessAccessUserSummary

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

Overview

Metadata of the member/partner that has access to the asset.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
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
 
# File 'lib/pinterest_sdk/models/business_access_user_summary.rb', line 67

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

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

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

Instance Attribute Details

#email ⇒ Object

Email of the business member/partner.



20
21
22
 
# File 'lib/pinterest_sdk/models/business_access_user_summary.rb', line 20

def email
  @email
end

#id ⇒ Object

Unique identifier of the business member/partner.



23
24
25
 
# File 'lib/pinterest_sdk/models/business_access_user_summary.rb', line 23

def id
  @id
end

#username ⇒ Object

Username of the business member/partner.



26
27
28
 
# File 'lib/pinterest_sdk/models/business_access_user_summary.rb', line 26

def username
  @username
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



38
39
40
 
# File 'lib/pinterest_sdk/models/business_access_user_summary.rb', line 38

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



43
44
45
 
# File 'lib/pinterest_sdk/models/business_access_user_summary.rb', line 43

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/pinterest_sdk/models/business_access_user_summary.rb', line 29

def self.attribute_map
  {
    :'email' => :'email',
    :'id' => :'id',
    :'username' => :'username'
  }
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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/pinterest_sdk/models/business_access_user_summary.rb', line 158

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



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

def self.openapi_nullable
  Set.new([
    :'email',
    :'id',
    :'username'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'email' => :'String',
    :'id' => :'String',
    :'username' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



135
136
137
138
139
140
141
 
# File 'lib/pinterest_sdk/models/business_access_user_summary.rb', line 135

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      id == o.id &&
      username == o.username
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


145
146
147
 
# File 'lib/pinterest_sdk/models/business_access_user_summary.rb', line 145

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



151
152
153
 
# File 'lib/pinterest_sdk/models/business_access_user_summary.rb', line 151

def hash
  [email, id, username].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



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/pinterest_sdk/models/business_access_user_summary.rb', line 96

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@id.nil? && @id.to_s.length > 20
    invalid_properties.push('invalid value for "id", the character length must be smaller than or equal to 20.')
  end

  if !@id.nil? && @id.to_s.length < 1
    invalid_properties.push('invalid value for "id", the character length must be greater than or equal to 1.')
  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



180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/pinterest_sdk/models/business_access_user_summary.rb', line 180

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



112
113
114
115
116
117
 
# File 'lib/pinterest_sdk/models/business_access_user_summary.rb', line 112

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@id.nil? && @id.to_s.length > 20
  return false if !@id.nil? && @id.to_s.length < 1
  true
end