Class: PinterestSdkClient::PinUpdate

Inherits:
ApiModelBase show all
Defined in:
lib/pinterest_sdk/models/pin_update.rb

Overview

Resource create or update operation model.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
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
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 90

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

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

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

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

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

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

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

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

Instance Attribute Details

#ai_disclosures ⇒ Object

AI disclosure declarations the creator has made about this Pin.



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

def ai_disclosures
  @ai_disclosures
end

#alt_text ⇒ Object

Returns the value of attribute alt_text.



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

def alt_text
  @alt_text
end

#board_id ⇒ Object

The board to which this Pin belongs.



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

def board_id
  @board_id
end

#board_section_id ⇒ Object

The board section to which this Pin belongs.



28
29
30
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 28

def board_section_id
  @board_section_id
end

#carousel_slots ⇒ Object

Carousel Pin slots data.



31
32
33
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 31

def carousel_slots
  @carousel_slots
end

#description ⇒ Object

Returns the value of attribute description.



33
34
35
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 33

def description
  @description
end

#link ⇒ Object

Returns the value of attribute link.



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

def link
  @link
end

#title ⇒ Object

Returns the value of attribute title.



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

def title
  @title
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



54
55
56
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 54

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



59
60
61
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 59

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 40

def self.attribute_map
  {
    :'ai_disclosures' => :'ai_disclosures',
    :'alt_text' => :'alt_text',
    :'board_id' => :'board_id',
    :'board_section_id' => :'board_section_id',
    :'carousel_slots' => :'carousel_slots',
    :'description' => :'description',
    :'link' => :'link',
    :'title' => :'title'
  }
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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 282

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



78
79
80
81
82
83
84
85
86
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 78

def self.openapi_nullable
  Set.new([
    :'alt_text',
    :'board_section_id',
    :'description',
    :'link',
    :'title'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 64

def self.openapi_types
  {
    :'ai_disclosures' => :'AiDisclosuresUpdate',
    :'alt_text' => :'String',
    :'board_id' => :'String',
    :'board_section_id' => :'String',
    :'carousel_slots' => :'Array<CarouselSlot>',
    :'description' => :'String',
    :'link' => :'String',
    :'title' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ai_disclosures == o.ai_disclosures &&
      alt_text == o.alt_text &&
      board_id == o.board_id &&
      board_section_id == o.board_section_id &&
      carousel_slots == o.carousel_slots &&
      description == o.description &&
      link == o.link &&
      title == o.title
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


269
270
271
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



275
276
277
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 275

def hash
  [ai_disclosures, alt_text, board_id, board_section_id, carousel_slots, description, link, title].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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 141

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

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

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

  if !@description.nil? && @description.to_s.length > 800
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 800.')
  end

  if !@link.nil? && @link.to_s.length > 2048
    invalid_properties.push('invalid value for "link", the character length must be smaller than or equal to 2048.')
  end

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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 304

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



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/pinterest_sdk/models/pin_update.rb', line 175

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@alt_text.nil? && @alt_text.to_s.length > 500
  return false if !@board_id.nil? && @board_id !~ Regexp.new(/^\d+$/)
  return false if !@board_section_id.nil? && @board_section_id !~ Regexp.new(/^\d+$/)
  return false if !@description.nil? && @description.to_s.length > 800
  return false if !@link.nil? && @link.to_s.length > 2048
  return false if !@title.nil? && @title.to_s.length > 100
  true
end