Class: PinterestSdkClient::BoardBase

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 101

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

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

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

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

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

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

  if attributes.key?(:'is_ads_only')
    self.is_ads_only = attributes[:'is_ads_only']
  else
    self.is_ads_only = false
  end

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

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

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

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

Instance Attribute Details

#board_pins_modified_at ⇒ Object

Date and time of last board pins modified.



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

def board_pins_modified_at
  @board_pins_modified_at
end

#collaborator_count ⇒ Object

Count of collaborators on the board.



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

def collaborator_count
  @collaborator_count
end

#created_at ⇒ Object

Date and time of board creation.



25
26
27
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 25

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#follower_count ⇒ Object

Board follower count.



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

def follower_count
  @follower_count
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#is_ads_only ⇒ Object

If set to true, the board will be ad-only and can store ad-only Pins.



35
36
37
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 35

def is_ads_only
  @is_ads_only
end

#media ⇒ Object

Board media.



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

def media
  @media
end

#name ⇒ Object

Name of the board. Note: If you create an ad-only board by setting is_ads_only to true, the board name automatically becomes "Ad-only Pins".



41
42
43
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 41

def name
  @name
end

#owner ⇒ Object

Returns the value of attribute owner.



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

def owner
  @owner
end

#pin_count ⇒ Object

Count of Pins on the board.



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

def pin_count
  @pin_count
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



66
67
68
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 66

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 49

def self.attribute_map
  {
    :'board_pins_modified_at' => :'board_pins_modified_at',
    :'collaborator_count' => :'collaborator_count',
    :'created_at' => :'created_at',
    :'description' => :'description',
    :'follower_count' => :'follower_count',
    :'id' => :'id',
    :'is_ads_only' => :'is_ads_only',
    :'media' => :'media',
    :'name' => :'name',
    :'owner' => :'owner',
    :'pin_count' => :'pin_count'
  }
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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 312

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



93
94
95
96
97
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 76

def self.openapi_types
  {
    :'board_pins_modified_at' => :'Time',
    :'collaborator_count' => :'Integer',
    :'created_at' => :'Time',
    :'description' => :'String',
    :'follower_count' => :'Integer',
    :'id' => :'String',
    :'is_ads_only' => :'Boolean',
    :'media' => :'BoardMedia',
    :'name' => :'String',
    :'owner' => :'BoardOwner',
    :'pin_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 281

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      board_pins_modified_at == o.board_pins_modified_at &&
      collaborator_count == o.collaborator_count &&
      created_at == o.created_at &&
      description == o.description &&
      follower_count == o.follower_count &&
      id == o.id &&
      is_ads_only == o.is_ads_only &&
      media == o.media &&
      name == o.name &&
      owner == o.owner &&
      pin_count == o.pin_count
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


299
300
301
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 299

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



305
306
307
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 305

def hash
  [board_pins_modified_at, collaborator_count, created_at, description, follower_count, id, is_ads_only, media, name, owner, pin_count].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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 168

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@collaborator_count.nil? && @collaborator_count < 0
    invalid_properties.push('invalid value for "collaborator_count", must be greater than or equal to 0.')
  end

  if !@follower_count.nil? && @follower_count < 0
    invalid_properties.push('invalid value for "follower_count", must be greater than or equal to 0.')
  end

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

  pattern = Regexp.new(/^\d+$/)
  if @id !~ pattern
    invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
  end

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

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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 334

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



201
202
203
204
205
206
207
208
209
210
 
# File 'lib/pinterest_sdk/models/board_base.rb', line 201

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@collaborator_count.nil? && @collaborator_count < 0
  return false if !@follower_count.nil? && @follower_count < 0
  return false if @id.nil?
  return false if @id !~ Regexp.new(/^\d+$/)
  return false if @name.nil?
  return false if !@pin_count.nil? && @pin_count < 0
  true
end