Class: RagieRubySdk::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/ragie_ruby_sdk/models/connection.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Connection

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 132

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_atObject

Returns the value of attribute created_at.



20
21
22
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 20

def created_at
  @created_at
end

#disabled_by_systemObject

Returns the value of attribute disabled_by_system.



44
45
46
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 44

def disabled_by_system
  @disabled_by_system
end

#disabled_by_system_reasonObject

Returns the value of attribute disabled_by_system_reason.



34
35
36
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 34

def disabled_by_system_reason
  @disabled_by_system_reason
end

#enabledObject

Returns the value of attribute enabled.



32
33
34
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 32

def enabled
  @enabled
end

#idObject

Returns the value of attribute id.



18
19
20
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 18

def id
  @id
end

#last_synced_atObject

Returns the value of attribute last_synced_at.



36
37
38
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 36

def last_synced_at
  @last_synced_at
end

#metadataObject

Returns the value of attribute metadata.



24
25
26
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 24

def 
  @metadata
end

#nameObject

Returns the value of attribute name.



28
29
30
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 28

def name
  @name
end

#page_limitObject

Returns the value of attribute page_limit.



42
43
44
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 42

def page_limit
  @page_limit
end

#partitionObject

Returns the value of attribute partition.



40
41
42
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 40

def partition
  @partition
end

#sourceObject

Returns the value of attribute source.



30
31
32
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 30

def source
  @source
end

#syncingObject

Returns the value of attribute syncing.



38
39
40
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 38

def syncing
  @syncing
end

#typeObject

Returns the value of attribute type.



26
27
28
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 26

def type
  @type
end

#updated_atObject

Returns the value of attribute updated_at.



22
23
24
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 22

def updated_at
  @updated_at
end

Class Method Details

._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



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 434

def self._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 = RagieRubySdk.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



89
90
91
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 89

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



94
95
96
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 94

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 69

def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'metadata' => :'metadata',
    :'type' => :'type',
    :'name' => :'name',
    :'source' => :'source',
    :'enabled' => :'enabled',
    :'disabled_by_system_reason' => :'disabled_by_system_reason',
    :'last_synced_at' => :'last_synced_at',
    :'syncing' => :'syncing',
    :'partition' => :'partition',
    :'page_limit' => :'page_limit',
    :'disabled_by_system' => :'disabled_by_system'
  }
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



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 410

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_nullableObject

List of attributes with nullable: true



119
120
121
122
123
124
125
126
127
128
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 119

def self.openapi_nullable
  Set.new([
    :'source',
    :'disabled_by_system_reason',
    :'last_synced_at',
    :'syncing',
    :'partition',
    :'page_limit',
  ])
end

.openapi_typesObject

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 99

def self.openapi_types
  {
    :'id' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'metadata' => :'Hash<String, MetadataValue>',
    :'type' => :'String',
    :'name' => :'String',
    :'source' => :'Source',
    :'enabled' => :'Boolean',
    :'disabled_by_system_reason' => :'String',
    :'last_synced_at' => :'Time',
    :'syncing' => :'Boolean',
    :'partition' => :'String',
    :'page_limit' => :'Integer',
    :'disabled_by_system' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 376

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
       == o. &&
      type == o.type &&
      name == o.name &&
      source == o.source &&
      enabled == o.enabled &&
      disabled_by_system_reason == o.disabled_by_system_reason &&
      last_synced_at == o.last_synced_at &&
      syncing == o.syncing &&
      partition == o.partition &&
      page_limit == o.page_limit &&
      disabled_by_system == o.disabled_by_system
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



505
506
507
508
509
510
511
512
513
514
515
516
517
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 505

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


397
398
399
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 397

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



403
404
405
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 403

def hash
  [id, created_at, updated_at, , type, name, source, enabled, disabled_by_system_reason, last_synced_at, syncing, partition, page_limit, disabled_by_system].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 229

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



481
482
483
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 481

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



487
488
489
490
491
492
493
494
495
496
497
498
499
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 487

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



475
476
477
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 475

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
# File 'lib/ragie_ruby_sdk/models/connection.rb', line 269

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @metadata.nil?
  return false if @type.nil?
  return false if @name.nil?
  return false if @enabled.nil?
  disabled_by_system_reason_validator = EnumAttributeValidator.new('String', ["connection_over_total_page_limit", "authentication_failed"])
  return false unless disabled_by_system_reason_validator.valid?(@disabled_by_system_reason)
  return false if @disabled_by_system.nil?
  true
end