Class: BudgeaClient::Connector

Inherits:
Object
  • Object
show all
Defined in:
lib/budgea_client/models/connector.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Connector

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
169
170
171
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
 
# File 'lib/budgea_client/models/connector.rb', line 116

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?(:'hidden')
    self.hidden = attributes[:'hidden']
  else
    self.hidden = false
  end

  if attributes.has_key?(:'charged')
    self.charged = attributes[:'charged']
  else
    self.charged = true
  end

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

  if attributes.has_key?(:'beta')
    self.beta = attributes[:'beta']
  else
    self.beta = false
  end

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'restricted')
    self.restricted = attributes[:'restricted']
  else
    self.restricted = false
  end

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

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

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

Instance Attribute Details

#account_types ⇒ Object

Returns the value of attribute account_types.



46
47
48
 
# File 'lib/budgea_client/models/connector.rb', line 46

def 
  @account_types
end

#auth_mechanism ⇒ Object

Authentication mechanism to use



49
50
51
 
# File 'lib/budgea_client/models/connector.rb', line 49

def auth_mechanism
  @auth_mechanism
end

#beta ⇒ Object

If true, this connector is perhaps unstable :)



33
34
35
 
# File 'lib/budgea_client/models/connector.rb', line 33

def beta
  @beta
end

#capabilities ⇒ Object

Returns the value of attribute capabilities.



62
63
64
 
# File 'lib/budgea_client/models/connector.rb', line 62

def capabilities
  @capabilities
end

#charged ⇒ Object

Usage of this connector is charged



27
28
29
 
# File 'lib/budgea_client/models/connector.rb', line 27

def charged
  @charged
end

#code ⇒ Object

Bank code



30
31
32
 
# File 'lib/budgea_client/models/connector.rb', line 30

def code
  @code
end

#color ⇒ Object

Main color of the bank or provider



36
37
38
 
# File 'lib/budgea_client/models/connector.rb', line 36

def color
  @color
end

#fields ⇒ Object

Returns the value of attribute fields.



60
61
62
 
# File 'lib/budgea_client/models/connector.rb', line 60

def fields
  @fields
end

#hidden ⇒ Object

This connector is hidden from your users



24
25
26
 
# File 'lib/budgea_client/models/connector.rb', line 24

def hidden
  @hidden
end

#id ⇒ Object

ID of the connector



18
19
20
 
# File 'lib/budgea_client/models/connector.rb', line 18

def id
  @id
end

#months_to_fetch ⇒ Object

How many months of history to fetch



44
45
46
 
# File 'lib/budgea_client/models/connector.rb', line 44

def months_to_fetch
  @months_to_fetch
end

#name ⇒ Object

Name of the bank or provider



21
22
23
 
# File 'lib/budgea_client/models/connector.rb', line 21

def name
  @name
end

#restricted ⇒ Object

If true, new connections cannot be added with this connector



58
59
60
 
# File 'lib/budgea_client/models/connector.rb', line 58

def restricted
  @restricted
end

#siret ⇒ Object

SIRET code for Bill modules



52
53
54
 
# File 'lib/budgea_client/models/connector.rb', line 52

def siret
  @siret
end

#slug ⇒ Object

Returns the value of attribute slug.



38
39
40
 
# File 'lib/budgea_client/models/connector.rb', line 38

def slug
  @slug
end

#sources ⇒ Object

Returns the value of attribute sources.



64
65
66
 
# File 'lib/budgea_client/models/connector.rb', line 64

def sources
  @sources
end

#sync_frequency ⇒ Object

How many days to wait between syncs



41
42
43
 
# File 'lib/budgea_client/models/connector.rb', line 41

def sync_frequency
  @sync_frequency
end

#uuid ⇒ Object

Unique connector identifier



55
56
57
 
# File 'lib/budgea_client/models/connector.rb', line 55

def uuid
  @uuid
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
80
81
82
83
84
85
86
87
88
 
# File 'lib/budgea_client/models/connector.rb', line 67

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'hidden' => :'hidden',
    :'charged' => :'charged',
    :'code' => :'code',
    :'beta' => :'beta',
    :'color' => :'color',
    :'slug' => :'slug',
    :'sync_frequency' => :'sync_frequency',
    :'months_to_fetch' => :'months_to_fetch',
    :'account_types' => :'account_types',
    :'auth_mechanism' => :'auth_mechanism',
    :'siret' => :'siret',
    :'uuid' => :'uuid',
    :'restricted' => :'restricted',
    :'fields' => :'fields',
    :'capabilities' => :'capabilities',
    :'sources' => :'sources'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/budgea_client/models/connector.rb', line 91

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'hidden' => :'BOOLEAN',
    :'charged' => :'BOOLEAN',
    :'code' => :'String',
    :'beta' => :'BOOLEAN',
    :'color' => :'String',
    :'slug' => :'String',
    :'sync_frequency' => :'Float',
    :'months_to_fetch' => :'Integer',
    :'account_types' => :'Array<String>',
    :'auth_mechanism' => :'String',
    :'siret' => :'String',
    :'uuid' => :'String',
    :'restricted' => :'BOOLEAN',
    :'fields' => :'Array<Field>',
    :'capabilities' => :'Array<String>',
    :'sources' => :'Array<ConnectorSource>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/budgea_client/models/connector.rb', line 256

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      hidden == o.hidden &&
      charged == o.charged &&
      code == o.code &&
      beta == o.beta &&
      color == o.color &&
      slug == o.slug &&
      sync_frequency == o.sync_frequency &&
      months_to_fetch == o.months_to_fetch &&
       == o. &&
      auth_mechanism == o.auth_mechanism &&
      siret == o.siret &&
      uuid == o.uuid &&
      restricted == o.restricted &&
      fields == o.fields &&
      capabilities == o.capabilities &&
      sources == o.sources
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



315
316
317
318
319
320
321
322
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
 
# File 'lib/budgea_client/models/connector.rb', line 315

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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/budgea_client/models/connector.rb', line 381

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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/budgea_client/models/connector.rb', line 294

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


281
282
283
 
# File 'lib/budgea_client/models/connector.rb', line 281

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



287
288
289
 
# File 'lib/budgea_client/models/connector.rb', line 287

def hash
  [id, name, hidden, charged, code, beta, color, slug, sync_frequency, months_to_fetch, , auth_mechanism, siret, uuid, restricted, fields, capabilities, sources].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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/budgea_client/models/connector.rb', line 213

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 @charged.nil?
    invalid_properties.push('invalid value for "charged", charged cannot be nil.')
  end

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

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

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



361
362
363
 
# File 'lib/budgea_client/models/connector.rb', line 361

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



367
368
369
370
371
372
373
374
375
 
# File 'lib/budgea_client/models/connector.rb', line 367

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



355
356
357
 
# File 'lib/budgea_client/models/connector.rb', line 355

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



244
245
246
247
248
249
250
251
252
 
# File 'lib/budgea_client/models/connector.rb', line 244

def valid?
  return false if @id.nil?
  return false if @name.nil?
  return false if @charged.nil?
  return false if @beta.nil?
  return false if @uuid.nil?
  return false if @restricted.nil?
  true
end