Class: PinterestSdkClient::FeedFields

Inherits:
Object
  • Object
show all
Defined in:
lib/pinterest_sdk/models/feed_fields.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FeedFields

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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 91

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::FeedFields` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PinterestSdkClient::FeedFields`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#credentials ⇒ Object

Returns the value of attribute credentials.



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

def credentials
  @credentials
end

#default_availability ⇒ Object

Returns the value of attribute default_availability.



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

def default_availability
  @default_availability
end

#default_country ⇒ Object

Returns the value of attribute default_country.



18
19
20
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 18

def default_country
  @default_country
end

#default_currency ⇒ Object

Returns the value of attribute default_currency.



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

def default_currency
  @default_currency
end

#default_locale ⇒ Object

The locale used within a feed for product descriptions.



30
31
32
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 30

def default_locale
  @default_locale
end

#format ⇒ Object

Returns the value of attribute format.



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

def format
  @format
end

#location ⇒ Object

The URL where a feed is available for download. This URL is what Pinterest will use to download a feed for processing.



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

def location
  @location
end

#name ⇒ Object

A human-friendly name associated to a given feed. This value is currently nullable due to historical reasons. It is expected to become non-nullable in the future.



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

def name
  @name
end

#preferred_processing_schedule ⇒ Object

Returns the value of attribute preferred_processing_schedule.



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

def preferred_processing_schedule
  @preferred_processing_schedule
end

#status ⇒ Object

Returns the value of attribute status.



39
40
41
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 39

def status
  @status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 42

def self.attribute_map
  {
    :'default_country' => :'default_country',
    :'default_availability' => :'default_availability',
    :'default_currency' => :'default_currency',
    :'name' => :'name',
    :'format' => :'format',
    :'default_locale' => :'default_locale',
    :'credentials' => :'credentials',
    :'location' => :'location',
    :'preferred_processing_schedule' => :'preferred_processing_schedule',
    :'status' => :'status'
  }
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



215
216
217
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 215

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'default_availability',
    :'default_currency',
    :'name',
    :'credentials',
    :'preferred_processing_schedule',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'default_country' => :'Country',
    :'default_availability' => :'ProductAvailabilityType',
    :'default_currency' => :'NullableCurrency',
    :'name' => :'String',
    :'format' => :'CatalogsFormat',
    :'default_locale' => :'String',
    :'credentials' => :'CatalogsFeedCredentials',
    :'location' => :'String',
    :'preferred_processing_schedule' => :'CatalogsFeedProcessingSchedule',
    :'status' => :'CatalogsStatus'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_country == o.default_country &&
      default_availability == o.default_availability &&
      default_currency == o.default_currency &&
      name == o.name &&
      format == o.format &&
      default_locale == o.default_locale &&
      credentials == o.credentials &&
      location == o.location &&
      preferred_processing_schedule == o.preferred_processing_schedule &&
      status == o.status
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 245

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = PinterestSdkClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 316

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 222

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


202
203
204
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



208
209
210
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 208

def hash
  [default_country, default_availability, default_currency, name, format, default_locale, credentials, location, preferred_processing_schedule, status].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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 147

def list_invalid_properties
  invalid_properties = Array.new
  if @default_country.nil?
    invalid_properties.push('invalid value for "default_country", default_country cannot be nil.')
  end

  if @format.nil?
    invalid_properties.push('invalid value for "format", format cannot be nil.')
  end

  if @default_locale.nil?
    invalid_properties.push('invalid value for "default_locale", default_locale cannot be nil.')
  end

  if @location.nil?
    invalid_properties.push('invalid value for "location", location cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



292
293
294
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 292

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 298

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



286
287
288
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 286

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



174
175
176
177
178
179
180
181
 
# File 'lib/pinterest_sdk/models/feed_fields.rb', line 174

def valid?
  return false if @default_country.nil?
  return false if @format.nil?
  return false if @default_locale.nil?
  return false if @location.nil?
  return false if @status.nil?
  true
end