Class: Carbon::OrganizationResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrganizationResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
218
219
220
221
222
223
224
225
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 129

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

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

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

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

  if attributes.key?(:'custom_limits')
    self.custom_limits = attributes[:'custom_limits']
  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?(:'file_statistics_aggregated_at')
    self.file_statistics_aggregated_at = attributes[:'file_statistics_aggregated_at']
  end

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

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

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

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

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

  if attributes.key?(:'logging_settings')
    self.logging_settings = attributes[:'logging_settings']
  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
end

Instance Attribute Details

#aggregate_file_size ⇒ Object

Returns the value of attribute aggregate_file_size.



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

def aggregate_file_size
  @aggregate_file_size
end

#aggregate_num_characters ⇒ Object

Returns the value of attribute aggregate_num_characters.



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

def aggregate_num_characters
  @aggregate_num_characters
end

#aggregate_num_embeddings ⇒ Object

Returns the value of attribute aggregate_num_embeddings.



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

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.



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

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.



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

def aggregate_num_files_by_source
  @aggregate_num_files_by_source
end

#aggregate_num_tokens ⇒ Object

Returns the value of attribute aggregate_num_tokens.



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

def aggregate_num_tokens
  @aggregate_num_tokens
end

#cancel_at_period_end ⇒ Object

Returns the value of attribute cancel_at_period_end.



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

def cancel_at_period_end
  @cancel_at_period_end
end

#connector_settings ⇒ Object

Returns the value of attribute connector_settings.



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

def connector_settings
  @connector_settings
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#custom_branding ⇒ Object

Returns the value of attribute custom_branding.



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

def custom_branding
  @custom_branding
end

#custom_limits ⇒ Object

Returns the value of attribute custom_limits.



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

def custom_limits
  @custom_limits
end

#file_statistics_aggregated_at ⇒ Object

Returns the value of attribute file_statistics_aggregated_at.



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

def file_statistics_aggregated_at
  @file_statistics_aggregated_at
end

#file_sync_usage ⇒ Object

Returns the value of attribute file_sync_usage.



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

def file_sync_usage
  @file_sync_usage
end

#global_user_config ⇒ Object

Returns the value of attribute global_user_config.



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

def global_user_config
  @global_user_config
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#logging_settings ⇒ Object

Returns the value of attribute logging_settings.



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

def logging_settings
  @logging_settings
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#nickname ⇒ Object

Returns the value of attribute nickname.



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

def nickname
  @nickname
end

#period_ends_at ⇒ Object

Returns the value of attribute period_ends_at.



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

def period_ends_at
  @period_ends_at
end

#remove_branding ⇒ Object

Returns the value of attribute remove_branding.



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

def remove_branding
  @remove_branding
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



54
55
56
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 54

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'nickname' => :'nickname',
    :'remove_branding' => :'remove_branding',
    :'custom_branding' => :'custom_branding',
    :'custom_limits' => :'custom_limits',
    :'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',
    :'file_statistics_aggregated_at' => :'file_statistics_aggregated_at',
    :'period_ends_at' => :'period_ends_at',
    :'cancel_at_period_end' => :'cancel_at_period_end',
    :'connector_settings' => :'connector_settings',
    :'global_user_config' => :'global_user_config',
    :'file_sync_usage' => :'file_sync_usage',
    :'logging_settings' => :'logging_settings',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
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



338
339
340
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 338

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 116

def self.openapi_nullable
  Set.new([
    :'nickname',
    :'custom_branding',
    :'custom_limits',
    :'file_statistics_aggregated_at',
    :'period_ends_at',
    :'cancel_at_period_end',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'nickname' => :'String',
    :'remove_branding' => :'Boolean',
    :'custom_branding' => :'Object',
    :'custom_limits' => :'Object',
    :'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',
    :'file_statistics_aggregated_at' => :'Time',
    :'period_ends_at' => :'Time',
    :'cancel_at_period_end' => :'Boolean',
    :'connector_settings' => :'Object',
    :'global_user_config' => :'Object',
    :'file_sync_usage' => :'Object',
    :'logging_settings' => :'Object',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 297

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      nickname == o.nickname &&
      remove_branding == o.remove_branding &&
      custom_branding == o.custom_branding &&
      custom_limits == o.custom_limits &&
      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 &&
      file_statistics_aggregated_at == o.file_statistics_aggregated_at &&
      period_ends_at == o.period_ends_at &&
      cancel_at_period_end == o.cancel_at_period_end &&
      connector_settings == o.connector_settings &&
      global_user_config == o.global_user_config &&
      file_sync_usage == o.file_sync_usage &&
      logging_settings == o.logging_settings &&
      created_at == o.created_at &&
      updated_at == o.updated_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



369
370
371
372
373
374
375
376
377
378
379
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
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 369

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



440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 440

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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 345

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


325
326
327
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 325

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



331
332
333
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 331

def hash
  [id, name, nickname, remove_branding, custom_branding, custom_limits, aggregate_file_size, aggregate_num_characters, aggregate_num_tokens, aggregate_num_embeddings, aggregate_num_files_by_source, aggregate_num_files_by_file_format, file_statistics_aggregated_at, period_ends_at, cancel_at_period_end, connector_settings, global_user_config, file_sync_usage, logging_settings, created_at, updated_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



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
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 229

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

  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



416
417
418
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 416

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



422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 422

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



410
411
412
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 410

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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/carbon_ruby_sdk/models/organization_response.rb', line 280

def valid?
  return false if @id.nil?
  return false if @name.nil?
  return false if @remove_branding.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 @created_at.nil?
  return false if @updated_at.nil?
  true
end