Class: Carbon::OrganizationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/carbon_ruby_sdk/api/organizations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrganizationsApi 



15
16
17
 
# File 'lib/carbon_ruby_sdk/api/organizations_api.rb', line 15

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



13
14
15
 
# File 'lib/carbon_ruby_sdk/api/organizations_api.rb', line 13

def api_client
  @api_client
end

Instance Method Details

#get(extra: {}) ⇒ Object

Get Organization



22
23
24
25
 
# File 'lib/carbon_ruby_sdk/api/organizations_api.rb', line 22

def get(extra: {})
  api_response = get_with_http_info_impl(extra)
  api_response.data
end

#get_with_http_info(extra: {}) ⇒ Object

Get Organization



30
31
32
 
# File 'lib/carbon_ruby_sdk/api/organizations_api.rb', line 30

def get_with_http_info(extra: {})
  get_with_http_info_impl(extra)
end

#update(global_user_config: SENTINEL, data_source_configs: SENTINEL, extra: {}) ⇒ Object

Update Organization



96
97
98
99
100
101
102
103
 
# File 'lib/carbon_ruby_sdk/api/organizations_api.rb', line 96

def update(global_user_config: SENTINEL, data_source_configs: SENTINEL, extra: {})
  _body = {}
  _body[:global_user_config] = global_user_config if global_user_config != SENTINEL
  _body[:data_source_configs] = data_source_configs if data_source_configs != SENTINEL
  update_organization_input = _body
  api_response = update_with_http_info_impl(update_organization_input, extra)
  api_response.data
end

#update_stats(extra: {}) ⇒ Object

Update Organization Statistics

Use this endpoint to reaggregate the statistics for an organization, for example aggregate_file_size. The reaggregation process is asyncronous so a webhook will be sent with the event type being FILE_STATISTICS_AGGREGATED to notify when the process is complee. After this aggregation is complete, the updated statistics can be retrieved using the /organization endpoint. The response of /organization willalso contain a timestamp of the last time the statistics were reaggregated.



194
195
196
197
 
# File 'lib/carbon_ruby_sdk/api/organizations_api.rb', line 194

def update_stats(extra: {})
  api_response = update_stats_with_http_info_impl(extra)
  api_response.data
end

#update_stats_with_http_info(extra: {}) ⇒ Object

Update Organization Statistics

Use this endpoint to reaggregate the statistics for an organization, for example aggregate_file_size. The reaggregation process is asyncronous so a webhook will be sent with the event type being FILE_STATISTICS_AGGREGATED to notify when the process is complee. After this aggregation is complete, the updated statistics can be retrieved using the /organization endpoint. The response of /organization willalso contain a timestamp of the last time the statistics were reaggregated.



207
208
209
 
# File 'lib/carbon_ruby_sdk/api/organizations_api.rb', line 207

def update_stats_with_http_info(extra: {})
  update_stats_with_http_info_impl(extra)
end

#update_with_http_info(global_user_config: SENTINEL, data_source_configs: SENTINEL, extra: {}) ⇒ Object

Update Organization



111
112
113
114
115
116
117
 
# File 'lib/carbon_ruby_sdk/api/organizations_api.rb', line 111

def update_with_http_info(global_user_config: SENTINEL, data_source_configs: SENTINEL, extra: {})
  _body = {}
  _body[:global_user_config] = global_user_config if global_user_config != SENTINEL
  _body[:data_source_configs] = data_source_configs if data_source_configs != SENTINEL
  update_organization_input = _body
  update_with_http_info_impl(update_organization_input, extra)
end