Class: PinterestSdkClient::Label

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

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

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

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

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

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

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

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

Instance Attribute Details

#id ⇒ Object

Label ID.



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

def id
  @id
end

#label_type ⇒ Object

Returns the value of attribute label_type.



21
22
23
 
# File 'lib/pinterest_sdk/models/label.rb', line 21

def label_type
  @label_type
end

#parent_id ⇒ Object

Label parent entity ID.



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

def parent_id
  @parent_id
end

#parent_type ⇒ Object

Label parent entity type.



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

def parent_type
  @parent_type
end

#status ⇒ Object

Returns the value of attribute status.



29
30
31
 
# File 'lib/pinterest_sdk/models/label.rb', line 29

def status
  @status
end

#value ⇒ Object

Label name.



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

def value
  @value
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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/label.rb', line 57

def self.attribute_map
  {
    :'id' => :'id',
    :'label_type' => :'label_type',
    :'parent_id' => :'parent_id',
    :'parent_type' => :'parent_type',
    :'status' => :'status',
    :'value' => :'value'
  }
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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/pinterest_sdk/models/label.rb', line 214

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



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

def self.openapi_nullable
  Set.new([
    :'label_type',
    :'parent_type',
    :'status',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'label_type' => :'LabelType',
    :'parent_id' => :'String',
    :'parent_type' => :'String',
    :'status' => :'LabelStatus',
    :'value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/pinterest_sdk/models/label.rb', line 188

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      label_type == o.label_type &&
      parent_id == o.parent_id &&
      parent_type == o.parent_type &&
      status == o.status &&
      value == o.value
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


201
202
203
 
# File 'lib/pinterest_sdk/models/label.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



207
208
209
 
# File 'lib/pinterest_sdk/models/label.rb', line 207

def hash
  [id, label_type, parent_id, parent_type, status, value].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



142
143
144
145
146
147
148
149
150
 
# File 'lib/pinterest_sdk/models/label.rb', line 142

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@value.nil? && @value.to_s.length > 100
    invalid_properties.push('invalid value for "value", 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



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/pinterest_sdk/models/label.rb', line 236

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



154
155
156
157
158
159
160
 
# File 'lib/pinterest_sdk/models/label.rb', line 154

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  parent_type_validator = EnumAttributeValidator.new('String', ["CAMPAIGN"])
  return false unless parent_type_validator.valid?(@parent_type)
  return false if !@value.nil? && @value.to_s.length > 100
  true
end