Class: Carbon::AuthApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuthApi

Returns a new instance of AuthApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_access_token(extra: {}) ⇒ Object

Get Access Token

Parameters:

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

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



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

def get_access_token(extra: {})
  api_response = get_access_token_with_http_info_impl(extra)
  api_response.data
end

#get_access_token_with_http_info(extra: {}) ⇒ Object

Get Access Token

Parameters:

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

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



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

def get_access_token_with_http_info(extra: {})
  get_access_token_with_http_info_impl(extra)
end

#get_white_labeling(extra: {}) ⇒ Object

Get White Labeling

Returns whether or not the organization is white labeled and which integrations are white labeled

:param current_user: the current user :param db: the database session :return: a WhiteLabelingResponse

Parameters:

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

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



99
100
101
102
 
# File 'lib/carbon_ruby_sdk/api/auth_api.rb', line 99

def get_white_labeling(extra: {})
  api_response = get_white_labeling_with_http_info_impl(extra)
  api_response.data
end

#get_white_labeling_with_http_info(extra: {}) ⇒ Object

Get White Labeling

Returns whether or not the organization is white labeled and which integrations are white labeled

:param current_user: the current user :param db: the database session :return: a WhiteLabelingResponse

Parameters:

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

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



113
114
115
 
# File 'lib/carbon_ruby_sdk/api/auth_api.rb', line 113

def get_white_labeling_with_http_info(extra: {})
  get_white_labeling_with_http_info_impl(extra)
end