Class: PinterestSdkClient::Keyword

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
165
166
 
# File 'lib/pinterest_sdk/models/keyword.rb', line 117

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

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

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

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

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  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?(:'type')
    self.type = attributes[:'type']
  end
end

Instance Attribute Details

#archived ⇒ Object

Returns the value of attribute archived.



26
27
28
 
# File 'lib/pinterest_sdk/models/keyword.rb', line 26

def archived
  @archived
end

#bid ⇒ Object

</p><strong>Note:</strong> bid field has been deprecated. Input will not be set and field will return null. Keyword custom bid in microcurrency - null if inherited from parent ad group.



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

def bid
  @bid
end

#id ⇒ Object

Keyword ID .



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

def id
  @id
end

#match_type ⇒ Object

Returns the value of attribute match_type.



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

def match_type
  @match_type
end

#parent_id ⇒ Object

Keyword parent entity ID (advertiser, campaign, ad group).



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

def parent_id
  @parent_id
end

#parent_type ⇒ Object

Parent entity type



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

def parent_type
  @parent_type
end

#type ⇒ Object

Always keyword



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

def type
  @type
end

#value ⇒ Object

Keyword value (120 chars max).



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

def value
  @value
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



77
78
79
 
# File 'lib/pinterest_sdk/models/keyword.rb', line 77

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



82
83
84
 
# File 'lib/pinterest_sdk/models/keyword.rb', line 82

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'bid' => :'bid',
    :'match_type' => :'match_type',
    :'value' => :'value',
    :'archived' => :'archived',
    :'id' => :'id',
    :'parent_id' => :'parent_id',
    :'parent_type' => :'parent_type',
    :'type' => :'type'
  }
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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/pinterest_sdk/models/keyword.rb', line 270

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



109
110
111
112
113
 
# File 'lib/pinterest_sdk/models/keyword.rb', line 109

def self.openapi_all_of
  [
  :'KeywordsCommon'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



101
102
103
104
105
106
 
# File 'lib/pinterest_sdk/models/keyword.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/pinterest_sdk/models/keyword.rb', line 87

def self.openapi_types
  {
    :'bid' => :'Integer',
    :'match_type' => :'MatchTypeResponse',
    :'value' => :'String',
    :'archived' => :'Boolean',
    :'id' => :'String',
    :'parent_id' => :'String',
    :'parent_type' => :'String',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/pinterest_sdk/models/keyword.rb', line 242

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bid == o.bid &&
      match_type == o.match_type &&
      value == o.value &&
      archived == o.archived &&
      id == o.id &&
      parent_id == o.parent_id &&
      parent_type == o.parent_type &&
      type == o.type
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


257
258
259
 
# File 'lib/pinterest_sdk/models/keyword.rb', line 257

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



263
264
265
 
# File 'lib/pinterest_sdk/models/keyword.rb', line 263

def hash
  [bid, match_type, value, archived, id, parent_id, parent_type, type].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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/pinterest_sdk/models/keyword.rb', line 170

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @value.nil?
    invalid_properties.push('invalid value for "value", value cannot be nil.')
  end

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

  pattern = Regexp.new(/^\d+$/)
  if !@parent_id.nil? && @parent_id !~ pattern
    invalid_properties.push("invalid value for \"parent_id\", must conform to the pattern #{pattern}.")
  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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/pinterest_sdk/models/keyword.rb', line 292

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



192
193
194
195
196
197
198
 
# File 'lib/pinterest_sdk/models/keyword.rb', line 192

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