Class: Brevo::CreateExternalFeed

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo/models/create_external_feed.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateExternalFeed

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
144
145
 
# File 'lib/brevo/models/create_external_feed.rb', line 98

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?(:'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']
  else
    self.auth_type = 'noAuth'
  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']
  else
    self.cache = false
  end
end

Instance Attribute Details

#auth_type ⇒ Object

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



24
25
26
 
# File 'lib/brevo/models/create_external_feed.rb', line 24

def auth_type
  @auth_type
end

#cache ⇒ Object

Toggle caching of feed url response



42
43
44
 
# File 'lib/brevo/models/create_external_feed.rb', line 42

def cache
  @cache
end

#headers ⇒ Object

Custom headers for the feed



36
37
38
 
# File 'lib/brevo/models/create_external_feed.rb', line 36

def headers
  @headers
end

#max_retries ⇒ Object

Maximum number of retries on the feed url



39
40
41
 
# File 'lib/brevo/models/create_external_feed.rb', line 39

def max_retries
  @max_retries
end

#name ⇒ Object

Name of the feed



18
19
20
 
# File 'lib/brevo/models/create_external_feed.rb', line 18

def name
  @name
end

#password ⇒ Object

Password for authType ‘basic`



30
31
32
 
# File 'lib/brevo/models/create_external_feed.rb', line 30

def password
  @password
end

#token ⇒ Object

Token for authType ‘token`



33
34
35
 
# File 'lib/brevo/models/create_external_feed.rb', line 33

def token
  @token
end

#url ⇒ Object

URL of the feed



21
22
23
 
# File 'lib/brevo/models/create_external_feed.rb', line 21

def url
  @url
end

#username ⇒ Object

Username for authType ‘basic`



27
28
29
 
# File 'lib/brevo/models/create_external_feed.rb', line 27

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/brevo/models/create_external_feed.rb', line 67

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

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/brevo/models/create_external_feed.rb', line 82

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/brevo/models/create_external_feed.rb', line 208

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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
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



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
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/brevo/models/create_external_feed.rb', line 258

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 = Brevo.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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/brevo/models/create_external_feed.rb', line 324

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/brevo/models/create_external_feed.rb', line 237

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


224
225
226
 
# File 'lib/brevo/models/create_external_feed.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



230
231
232
 
# File 'lib/brevo/models/create_external_feed.rb', line 230

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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/brevo/models/create_external_feed.rb', line 149

def list_invalid_properties
  invalid_properties = Array.new
  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 !@max_retries.nil? && @max_retries > 5
    invalid_properties.push('invalid value for "max_retries", must be smaller than or equal to 5.')
  end

  if !@max_retries.nil? && @max_retries < 0
    invalid_properties.push('invalid value for "max_retries", must be greater than or equal to 0.')
  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



304
305
306
 
# File 'lib/brevo/models/create_external_feed.rb', line 304

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



310
311
312
313
314
315
316
317
318
 
# File 'lib/brevo/models/create_external_feed.rb', line 310

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



298
299
300
 
# File 'lib/brevo/models/create_external_feed.rb', line 298

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



172
173
174
175
176
177
178
179
180
 
# File 'lib/brevo/models/create_external_feed.rb', line 172

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