Class: BrevoRuby::GetAllExternalFeedsFeeds

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/models/get_all_external_feeds_feeds.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetAllExternalFeedsFeeds

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 113

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

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

  if attributes.has_key?(:'url')
    self.url = attributes[:'url']
  end

  if attributes.has_key?(:'authType')
    self.auth_type = attributes[:'authType']
  end

  if attributes.has_key?(:'username')
    self.username = attributes[:'username']
  end

  if attributes.has_key?(:'password')
    self.password = attributes[:'password']
  end

  if attributes.has_key?(:'token')
    self.token = attributes[:'token']
  end

  if attributes.has_key?(:'headers')
    if (value = attributes[:'headers']).is_a?(Array)
      self.headers = value
    end
  end

  if attributes.has_key?(:'maxRetries')
    self.max_retries = attributes[:'maxRetries']
  end

  if attributes.has_key?(:'cache')
    self.cache = attributes[:'cache']
  end

  if attributes.has_key?(:'createdAt')
    self.created_at = attributes[:'createdAt']
  end

  if attributes.has_key?(:'modifiedAt')
    self.modified_at = attributes[:'modifiedAt']
  end
end

Instance Attribute Details

#auth_type ⇒ Object

Auth type of the feed: * ‘basic` * `token` * `noAuth`



27
28
29
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 27

def auth_type
  @auth_type
end

#cache ⇒ Object

Toggle caching of feed url response



45
46
47
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 45

def cache
  @cache
end

#created_at ⇒ Object

Datetime on which the feed was created



48
49
50
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 48

def created_at
  @created_at
end

#headers ⇒ Object

Custom headers for the feed



39
40
41
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 39

def headers
  @headers
end

#id ⇒ Object

ID of the feed



18
19
20
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 18

def id
  @id
end

#max_retries ⇒ Object

Maximum number of retries on the feed url



42
43
44
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 42

def max_retries
  @max_retries
end

#modified_at ⇒ Object

Datetime on which the feed was modified



51
52
53
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 51

def modified_at
  @modified_at
end

#name ⇒ Object

Name of the feed



21
22
23
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 21

def name
  @name
end

#password ⇒ Object

Password for authType ‘basic`



33
34
35
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 33

def password
  @password
end

#token ⇒ Object

Token for authType ‘token`



36
37
38
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 36

def token
  @token
end

#url ⇒ Object

URL of the feed



24
25
26
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 24

def url
  @url
end

#username ⇒ Object

Username for authType ‘basic`



30
31
32
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 30

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 76

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'url' => :'url',
    :'auth_type' => :'authType',
    :'username' => :'username',
    :'password' => :'password',
    :'token' => :'token',
    :'headers' => :'headers',
    :'max_retries' => :'maxRetries',
    :'cache' => :'cache',
    :'created_at' => :'createdAt',
    :'modified_at' => :'modifiedAt'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 94

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'url' => :'String',
    :'auth_type' => :'String',
    :'username' => :'String',
    :'password' => :'String',
    :'token' => :'String',
    :'headers' => :'Array<GetExternalFeedByUUIDHeaders>',
    :'max_retries' => :'Integer',
    :'cache' => :'BOOLEAN',
    :'created_at' => :'DateTime',
    :'modified_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 270

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      url == o.url &&
      auth_type == o.auth_type &&
      username == o.username &&
      password == o.password &&
      token == o.token &&
      headers == o.headers &&
      max_retries == o.max_retries &&
      cache == o.cache &&
      created_at == o.created_at &&
      modified_at == o.modified_at
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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 323

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = BrevoRuby.const_get(type).new
    temp_model.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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 389

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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 302

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


289
290
291
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 289

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



295
296
297
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 295

def hash
  [id, name, url, auth_type, username, password, token, headers, max_retries, cache, created_at, modified_at].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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 172

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

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

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

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

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

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

  if @max_retries > 5
    invalid_properties.push('invalid value for "max_retries", must be smaller than or equal to 5.')
  end

  if @max_retries < 0
    invalid_properties.push('invalid value for "max_retries", must be greater than or equal to 0.')
  end

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

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

  if @modified_at.nil?
    invalid_properties.push('invalid value for "modified_at", modified_at 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



369
370
371
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 369

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



375
376
377
378
379
380
381
382
383
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 375

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



363
364
365
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 363

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/brevo-ruby/models/get_all_external_feeds_feeds.rb', line 223

def valid?
  return false if @id.nil?
  return false if @name.nil?
  return false if @url.nil?
  return false if @auth_type.nil?
  auth_type_validator = EnumAttributeValidator.new('String', ['basic', 'token', 'noAuth'])
  return false unless auth_type_validator.valid?(@auth_type)
  return false if @headers.nil?
  return false if @max_retries.nil?
  return false if @max_retries > 5
  return false if @max_retries < 0
  return false if @cache.nil?
  return false if @created_at.nil?
  return false if @modified_at.nil?
  true
end