Class: PinterestSdkClient::BoardCreate

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

Overview

Resource create operation model.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#is_ads_only ⇒ Object

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



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

def is_ads_only
  @is_ads_only
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".



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

def name
  @name
end

#privacy ⇒ Object

Privacy setting for a board. Learn more about [secret](help.pinterest.com/en/article/secret-boards) boards and [protected](help.pinterest.com/en/business/article/protected-boards) boards. Note: If you create an ad-only board by setting is_ads_only to true, the privacy settng automatically becomes PROTECTED.



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

def privacy
  @privacy
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



63
64
65
 
# File 'lib/pinterest_sdk/models/board_create.rb', line 63

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/pinterest_sdk/models/board_create.rb', line 68

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
 
# File 'lib/pinterest_sdk/models/board_create.rb', line 53

def self.attribute_map
  {
    :'description' => :'description',
    :'is_ads_only' => :'is_ads_only',
    :'name' => :'name',
    :'privacy' => :'privacy'
  }
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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/pinterest_sdk/models/board_create.rb', line 182

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



83
84
85
86
87
 
# File 'lib/pinterest_sdk/models/board_create.rb', line 83

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

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
 
# File 'lib/pinterest_sdk/models/board_create.rb', line 73

def self.openapi_types
  {
    :'description' => :'String',
    :'is_ads_only' => :'Boolean',
    :'name' => :'String',
    :'privacy' => :'BoardPrivacy'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
 
# File 'lib/pinterest_sdk/models/board_create.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      is_ads_only == o.is_ads_only &&
      name == o.name &&
      privacy == o.privacy
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


169
170
171
 
# File 'lib/pinterest_sdk/models/board_create.rb', line 169

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



175
176
177
 
# File 'lib/pinterest_sdk/models/board_create.rb', line 175

def hash
  [description, is_ads_only, name, privacy].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



128
129
130
131
132
133
134
135
136
 
# File 'lib/pinterest_sdk/models/board_create.rb', line 128

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



140
141
142
143
144
 
# File 'lib/pinterest_sdk/models/board_create.rb', line 140

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