Class: PinterestSdkClient::BrandAccountsCreateRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 98

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

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

  if attributes.key?(:'country')
    self.country = attributes[:'country']
  else
    self.country = nil
  end

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

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

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

Instance Attribute Details

#aboutObject

Brand Account about information



27
28
29
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 27

def about
  @about
end

#countryObject

Returns the value of attribute country.



24
25
26
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 24

def country
  @country
end

#nameObject

Brand Account name



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

def name
  @name
end

#profile_imageObject

Returns the value of attribute profile_image.



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

def profile_image
  @profile_image
end

#usernameObject

Brand Account username



22
23
24
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 22

def username
  @username
end

#websiteObject

Brand Account website



30
31
32
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 30

def website
  @website
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



69
70
71
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 69

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



74
75
76
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 74

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



57
58
59
60
61
62
63
64
65
66
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 57

def self.attribute_map
  {
    :'name' => :'name',
    :'username' => :'username',
    :'country' => :'country',
    :'about' => :'about',
    :'website' => :'website',
    :'profile_image' => :'profile_image'
  }
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 231

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



91
92
93
94
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 91

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

.openapi_typesObject

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 79

def self.openapi_types
  {
    :'name' => :'String',
    :'username' => :'String',
    :'country' => :'Country',
    :'about' => :'String',
    :'website' => :'String',
    :'profile_image' => :'ImageBase64'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



205
206
207
208
209
210
211
212
213
214
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      username == o.username &&
      country == o.country &&
      about == o.about &&
      website == o.website &&
      profile_image == o.profile_image
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


218
219
220
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 218

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



224
225
226
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 224

def hash
  [name, username, country, about, website, profile_image].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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

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

  if @username.nil?
    invalid_properties.push('invalid value for "username", username cannot be nil.')
  end

  if @country.nil?
    invalid_properties.push('invalid value for "country", country cannot be nil.')
  end

  invalid_properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



253
254
255
256
257
258
259
260
261
262
263
264
265
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 253

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



165
166
167
168
169
170
171
# File 'lib/pinterest_sdk/models/brand_accounts_create_request.rb', line 165

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