Class: Carbon::UserResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/carbon_ruby_sdk/models/user_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
210
211
212
213
214
215
216
217
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 121

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#aggregate_file_size ⇒ Object

Returns the value of attribute aggregate_file_size.



32
33
34
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 32

def aggregate_file_size
  @aggregate_file_size
end

#aggregate_num_characters ⇒ Object

Returns the value of attribute aggregate_num_characters.



34
35
36
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 34

def aggregate_num_characters
  @aggregate_num_characters
end

#aggregate_num_embeddings ⇒ Object

Returns the value of attribute aggregate_num_embeddings.



38
39
40
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 38

def aggregate_num_embeddings
  @aggregate_num_embeddings
end

#aggregate_num_files_by_file_format ⇒ Object

Returns the value of attribute aggregate_num_files_by_file_format.



42
43
44
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 42

def aggregate_num_files_by_file_format
  @aggregate_num_files_by_file_format
end

#aggregate_num_files_by_source ⇒ Object

Returns the value of attribute aggregate_num_files_by_source.



40
41
42
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 40

def aggregate_num_files_by_source
  @aggregate_num_files_by_source
end

#aggregate_num_tokens ⇒ Object

Returns the value of attribute aggregate_num_tokens.



36
37
38
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 36

def aggregate_num_tokens
  @aggregate_num_tokens
end

#auto_sync_enabled_sources ⇒ Object

Returns the value of attribute auto_sync_enabled_sources.



50
51
52
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 50

def auto_sync_enabled_sources
  @auto_sync_enabled_sources
end

#connector_settings ⇒ Object

Returns the value of attribute connector_settings.



52
53
54
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 52

def connector_settings
  @connector_settings
end

#created_at ⇒ Object

Returns the value of attribute created_at.



20
21
22
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 20

def created_at
  @created_at
end

#custom_limits ⇒ Object

Returns the value of attribute custom_limits.



48
49
50
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 48

def custom_limits
  @custom_limits
end

#deleted_at ⇒ Object

Returns the value of attribute deleted_at.



24
25
26
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 24

def deleted_at
  @deleted_at
end

#enabled_features ⇒ Object

Returns the value of attribute enabled_features.



46
47
48
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 46

def enabled_features
  @enabled_features
end

#id ⇒ Object

Returns the value of attribute id.



14
15
16
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 14

def id
  @id
end

#num_characters_synced ⇒ Object

Returns the value of attribute num_characters_synced.



28
29
30
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 28

def num_characters_synced
  @num_characters_synced
end

#num_files_synced ⇒ Object

Returns the value of attribute num_files_synced.



26
27
28
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 26

def num_files_synced
  @num_files_synced
end

#num_tokens_synced ⇒ Object

Returns the value of attribute num_tokens_synced.



30
31
32
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 30

def num_tokens_synced
  @num_tokens_synced
end

#organization_id ⇒ Object

Returns the value of attribute organization_id.



16
17
18
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 16

def organization_id
  @organization_id
end

#organization_supplied_user_id ⇒ Object

Returns the value of attribute organization_supplied_user_id.



18
19
20
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 18

def organization_supplied_user_id
  @organization_supplied_user_id
end

#unique_file_tags ⇒ Object

Returns the value of attribute unique_file_tags.



44
45
46
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 44

def unique_file_tags
  @unique_file_tags
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



22
23
24
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 22

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 55

def self.attribute_map
  {
    :'id' => :'id',
    :'organization_id' => :'organization_id',
    :'organization_supplied_user_id' => :'organization_supplied_user_id',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'deleted_at' => :'deleted_at',
    :'num_files_synced' => :'num_files_synced',
    :'num_characters_synced' => :'num_characters_synced',
    :'num_tokens_synced' => :'num_tokens_synced',
    :'aggregate_file_size' => :'aggregate_file_size',
    :'aggregate_num_characters' => :'aggregate_num_characters',
    :'aggregate_num_tokens' => :'aggregate_num_tokens',
    :'aggregate_num_embeddings' => :'aggregate_num_embeddings',
    :'aggregate_num_files_by_source' => :'aggregate_num_files_by_source',
    :'aggregate_num_files_by_file_format' => :'aggregate_num_files_by_file_format',
    :'unique_file_tags' => :'unique_file_tags',
    :'enabled_features' => :'enabled_features',
    :'custom_limits' => :'custom_limits',
    :'auto_sync_enabled_sources' => :'auto_sync_enabled_sources',
    :'connector_settings' => :'connector_settings'
  }
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



349
350
351
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 349

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
116
117
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 112

def self.openapi_nullable
  Set.new([
    :'deleted_at',
    :'enabled_features',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 86

def self.openapi_types
  {
    :'id' => :'Integer',
    :'organization_id' => :'Integer',
    :'organization_supplied_user_id' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'deleted_at' => :'Time',
    :'num_files_synced' => :'Integer',
    :'num_characters_synced' => :'Integer',
    :'num_tokens_synced' => :'Integer',
    :'aggregate_file_size' => :'Object',
    :'aggregate_num_characters' => :'Object',
    :'aggregate_num_tokens' => :'Object',
    :'aggregate_num_embeddings' => :'Object',
    :'aggregate_num_files_by_source' => :'Object',
    :'aggregate_num_files_by_file_format' => :'Object',
    :'unique_file_tags' => :'Array<Object>',
    :'enabled_features' => :'Object',
    :'custom_limits' => :'Object',
    :'auto_sync_enabled_sources' => :'Array<Object>',
    :'connector_settings' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 309

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      organization_id == o.organization_id &&
      organization_supplied_user_id == o.organization_supplied_user_id &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      deleted_at == o.deleted_at &&
      num_files_synced == o.num_files_synced &&
      num_characters_synced == o.num_characters_synced &&
      num_tokens_synced == o.num_tokens_synced &&
      aggregate_file_size == o.aggregate_file_size &&
      aggregate_num_characters == o.aggregate_num_characters &&
      aggregate_num_tokens == o.aggregate_num_tokens &&
      aggregate_num_embeddings == o.aggregate_num_embeddings &&
      aggregate_num_files_by_source == o.aggregate_num_files_by_source &&
      aggregate_num_files_by_file_format == o.aggregate_num_files_by_file_format &&
      unique_file_tags == o.unique_file_tags &&
      enabled_features == o.enabled_features &&
      custom_limits == o.custom_limits &&
      auto_sync_enabled_sources == o.auto_sync_enabled_sources &&
      connector_settings == o.connector_settings
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



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 380

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



451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 451

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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 356

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  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


336
337
338
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 336

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



342
343
344
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 342

def hash
  [id, organization_id, organization_supplied_user_id, created_at, updated_at, deleted_at, num_files_synced, num_characters_synced, num_tokens_synced, aggregate_file_size, aggregate_num_characters, aggregate_num_tokens, aggregate_num_embeddings, aggregate_num_files_by_source, aggregate_num_files_by_file_format, unique_file_tags, enabled_features, custom_limits, auto_sync_enabled_sources, connector_settings].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



221
222
223
224
225
226
227
228
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 221

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

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

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

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

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

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

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

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

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

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

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

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



427
428
429
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 427

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



433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 433

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



421
422
423
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 421

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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/carbon_ruby_sdk/models/user_response.rb', line 288

def valid?
  return false if @id.nil?
  return false if @organization_id.nil?
  return false if @organization_supplied_user_id.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @num_files_synced.nil?
  return false if @num_characters_synced.nil?
  return false if @num_tokens_synced.nil?
  return false if @aggregate_file_size.nil?
  return false if @aggregate_num_characters.nil?
  return false if @aggregate_num_tokens.nil?
  return false if @aggregate_num_embeddings.nil?
  return false if @aggregate_num_files_by_source.nil?
  return false if @aggregate_num_files_by_file_format.nil?
  return false if @unique_file_tags.nil?
  true
end