Class: Zernio::PinterestPlatformData

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/pinterest_platform_data.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 = {}) ⇒ PinterestPlatformData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
89
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
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 83

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

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

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

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

Instance Attribute Details

#board_id ⇒ Object

Target Pinterest board ID. If omitted, the first available board is used.



22
23
24
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 22

def board_id
  @board_id
end

#board_section_id ⇒ Object

Target section inside the board. Optional; the pin lands on the board itself when omitted. Pinterest rejects the pin if the section does not belong to boardId, so send both together.



25
26
27
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 25

def board_section_id
  @board_section_id
end

#cover_image_key_frame_time ⇒ Object

Optional key frame time in seconds for derived video cover



34
35
36
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 34

def cover_image_key_frame_time
  @cover_image_key_frame_time
end

#cover_image_url ⇒ Object

Optional cover image for video pins



31
32
33
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 31

def cover_image_url
  @cover_image_url
end

#is_ai_generated ⇒ Object

When true, the Pin is created with Pinterest's AI_MODIFIED disclosure (ai_disclosures), which shows an "AI modified" label. Applies to image and video Pins. Pinterest offers no "not AI" value, so false simply omits the disclosure. Pinterest may still label a Pin on its own detection.



37
38
39
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 37

def is_ai_generated
  @is_ai_generated
end

#link ⇒ Object

Destination link (pin URL)



28
29
30
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 28

def link
  @link
end

#title ⇒ Object

Pin title. Defaults to first line of content or "Pin". Must be ≤ 100 characters.



19
20
21
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 19

def title
  @title
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



53
54
55
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 53

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 58

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
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 40

def self.attribute_map
  {
    :'title' => :'title',
    :'board_id' => :'boardId',
    :'board_section_id' => :'boardSectionId',
    :'link' => :'link',
    :'cover_image_url' => :'coverImageUrl',
    :'cover_image_key_frame_time' => :'coverImageKeyFrameTime',
    :'is_ai_generated' => :'isAiGenerated'
  }
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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 191

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



76
77
78
79
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 63

def self.openapi_types
  {
    :'title' => :'String',
    :'board_id' => :'String',
    :'board_section_id' => :'String',
    :'link' => :'String',
    :'cover_image_url' => :'String',
    :'cover_image_key_frame_time' => :'Integer',
    :'is_ai_generated' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      board_id == o.board_id &&
      board_section_id == o.board_section_id &&
      link == o.link &&
      cover_image_url == o.cover_image_url &&
      cover_image_key_frame_time == o.cover_image_key_frame_time &&
      is_ai_generated == o.is_ai_generated
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


178
179
180
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



184
185
186
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 184

def hash
  [title, board_id, board_section_id, link, cover_image_url, cover_image_key_frame_time, is_ai_generated].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



130
131
132
133
134
135
136
137
138
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 130

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 213

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



142
143
144
145
146
 
# File 'lib/zernio-sdk/models/pinterest_platform_data.rb', line 142

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