Class: Carbon::DataSourcesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DataSourcesApi

Returns a new instance of DataSourcesApi.



15
16
17
 
# File 'lib/carbon_ruby_sdk/api/data_sources_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/data_sources_api.rb', line 13

def api_client
  @api_client
end

Instance Method Details

#add_tags(tags:, data_source_id:, extra: {}) ⇒ Object

Add Data Source Tags

Parameters:

  • tags (Object)
  • data_source_id (Integer)
  • body (AddDataSourceTagsInput)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



25
26
27
28
29
30
31
32
 
# File 'lib/carbon_ruby_sdk/api/data_sources_api.rb', line 25

def add_tags(tags:, data_source_id:, extra: {})
  _body = {}
  _body[:tags] = tags if tags != SENTINEL
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
  add_data_source_tags_input = _body
  api_response = add_tags_with_http_info_impl(add_data_source_tags_input, extra)
  api_response.data
end

#add_tags_with_http_info(tags:, data_source_id:, extra: {}) ⇒ Object

Add Data Source Tags

Parameters:

  • tags (Object)
  • data_source_id (Integer)
  • body (AddDataSourceTagsInput)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



40
41
42
43
44
45
46
 
# File 'lib/carbon_ruby_sdk/api/data_sources_api.rb', line 40

def add_tags_with_http_info(tags:, data_source_id:, extra: {})
  _body = {}
  _body[:tags] = tags if tags != SENTINEL
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
  add_data_source_tags_input = _body
  add_tags_with_http_info_impl(add_data_source_tags_input, extra)
end

#query(pagination: SENTINEL, order_by: SENTINEL, order_dir: SENTINEL, filters: SENTINEL, extra: {}) ⇒ Object

Data Sources

Parameters:



123
124
125
126
127
128
129
130
131
132
 
# File 'lib/carbon_ruby_sdk/api/data_sources_api.rb', line 123

def query(pagination: SENTINEL, order_by: SENTINEL, order_dir: SENTINEL, filters: SENTINEL, extra: {})
  _body = {}
  _body[:pagination] = pagination if pagination != SENTINEL
  _body[:order_by] = order_by if order_by != SENTINEL
  _body[:order_dir] = order_dir if order_dir != SENTINEL
  _body[:filters] = filters if filters != SENTINEL
  organization_user_data_source_query_input = _body
  api_response = query_with_http_info_impl(organization_user_data_source_query_input, extra)
  api_response.data
end

#query_user_data_sources(pagination: SENTINEL, order_by: SENTINEL, order_dir: SENTINEL, filters: SENTINEL, extra: {}) ⇒ Object

User Data Sources

Parameters:



227
228
229
230
231
232
233
234
235
236
 
# File 'lib/carbon_ruby_sdk/api/data_sources_api.rb', line 227

def query_user_data_sources(pagination: SENTINEL, order_by: SENTINEL, order_dir: SENTINEL, filters: SENTINEL, extra: {})
  _body = {}
  _body[:pagination] = pagination if pagination != SENTINEL
  _body[:order_by] = order_by if order_by != SENTINEL
  _body[:order_dir] = order_dir if order_dir != SENTINEL
  _body[:filters] = filters if filters != SENTINEL
  organization_user_data_source_query_input = _body
  api_response = query_user_data_sources_with_http_info_impl(organization_user_data_source_query_input, extra)
  api_response.data
end

#query_user_data_sources_with_http_info(pagination: SENTINEL, order_by: SENTINEL, order_dir: SENTINEL, filters: SENTINEL, extra: {}) ⇒ Object

User Data Sources

Parameters:



246
247
248
249
250
251
252
253
254
 
# File 'lib/carbon_ruby_sdk/api/data_sources_api.rb', line 246

def query_user_data_sources_with_http_info(pagination: SENTINEL, order_by: SENTINEL, order_dir: SENTINEL, filters: SENTINEL, extra: {})
  _body = {}
  _body[:pagination] = pagination if pagination != SENTINEL
  _body[:order_by] = order_by if order_by != SENTINEL
  _body[:order_dir] = order_dir if order_dir != SENTINEL
  _body[:filters] = filters if filters != SENTINEL
  organization_user_data_source_query_input = _body
  query_user_data_sources_with_http_info_impl(organization_user_data_source_query_input, extra)
end

#query_with_http_info(pagination: SENTINEL, order_by: SENTINEL, order_dir: SENTINEL, filters: SENTINEL, extra: {}) ⇒ Object

Data Sources

Parameters:



142
143
144
145
146
147
148
149
150
 
# File 'lib/carbon_ruby_sdk/api/data_sources_api.rb', line 142

def query_with_http_info(pagination: SENTINEL, order_by: SENTINEL, order_dir: SENTINEL, filters: SENTINEL, extra: {})
  _body = {}
  _body[:pagination] = pagination if pagination != SENTINEL
  _body[:order_by] = order_by if order_by != SENTINEL
  _body[:order_dir] = order_dir if order_dir != SENTINEL
  _body[:filters] = filters if filters != SENTINEL
  organization_user_data_source_query_input = _body
  query_with_http_info_impl(organization_user_data_source_query_input, extra)
end

#remove_tags(data_source_id:, tags_to_remove: SENTINEL, remove_all_tags: false, extra: {}) ⇒ Object

Remove Data Source Tags

Parameters:

  • data_source_id (Integer)
  • tags_to_remove (Array<String>) (defaults to: SENTINEL)
  • remove_all_tags (Boolean) (defaults to: false)
  • body (RemoveDataSourceTagsInput)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



330
331
332
333
334
335
336
337
338
 
# File 'lib/carbon_ruby_sdk/api/data_sources_api.rb', line 330

def remove_tags(data_source_id:, tags_to_remove: SENTINEL, remove_all_tags: false, extra: {})
  _body = {}
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
  _body[:tags_to_remove] = tags_to_remove if tags_to_remove != SENTINEL
  _body[:remove_all_tags] = remove_all_tags if remove_all_tags != SENTINEL
  remove_data_source_tags_input = _body
  api_response = remove_tags_with_http_info_impl(remove_data_source_tags_input, extra)
  api_response.data
end

#remove_tags_with_http_info(data_source_id:, tags_to_remove: SENTINEL, remove_all_tags: false, extra: {}) ⇒ Object

Remove Data Source Tags

Parameters:

  • data_source_id (Integer)
  • tags_to_remove (Array<String>) (defaults to: SENTINEL)
  • remove_all_tags (Boolean) (defaults to: false)
  • body (RemoveDataSourceTagsInput)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



347
348
349
350
351
352
353
354
 
# File 'lib/carbon_ruby_sdk/api/data_sources_api.rb', line 347

def remove_tags_with_http_info(data_source_id:, tags_to_remove: SENTINEL, remove_all_tags: false, extra: {})
  _body = {}
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
  _body[:tags_to_remove] = tags_to_remove if tags_to_remove != SENTINEL
  _body[:remove_all_tags] = remove_all_tags if remove_all_tags != SENTINEL
  remove_data_source_tags_input = _body
  remove_tags_with_http_info_impl(remove_data_source_tags_input, extra)
end

#revoke_access_token(data_source_id:, extra: {}) ⇒ Object

Revoke Access Token

Parameters:

  • data_source_id (Integer)
  • body (RevokeAccessTokenInput)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



428
429
430
431
432
433
434
 
# File 'lib/carbon_ruby_sdk/api/data_sources_api.rb', line 428

def revoke_access_token(data_source_id:, extra: {})
  _body = {}
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
  revoke_access_token_input = _body
  api_response = revoke_access_token_with_http_info_impl(revoke_access_token_input, extra)
  api_response.data
end

#revoke_access_token_with_http_info(data_source_id:, extra: {}) ⇒ Object

Revoke Access Token

Parameters:

  • data_source_id (Integer)
  • body (RevokeAccessTokenInput)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



441
442
443
444
445
446
 
# File 'lib/carbon_ruby_sdk/api/data_sources_api.rb', line 441

def revoke_access_token_with_http_info(data_source_id:, extra: {})
  _body = {}
  _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
  revoke_access_token_input = _body
  revoke_access_token_with_http_info_impl(revoke_access_token_input, extra)
end