Class: QwilAPI::ApitokenauthApi

Inherits:
Object
  • Object
show all
Defined in:
lib/qwil_api/api/apitokenauth_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApitokenauthApi

Returns a new instance of ApitokenauthApi.



28
29
30
 
# File 'lib/qwil_api/api/apitokenauth_api.rb', line 28

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



26
27
28
 
# File 'lib/qwil_api/api/apitokenauth_api.rb', line 26

def api_client
  @api_client
end

Instance Method Details

#obtain_json_web_token_post(opts = {}) ⇒ JSONWebTokenSerializer

API View that receives a POST with a user’s username and password API View that receives a POST with a user’s username and password.<br/>Returns a JSON Web Token that can be used for authenticated requests.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



37
38
39
40
 
# File 'lib/qwil_api/api/apitokenauth_api.rb', line 37

def obtain_json_web_token_post(opts = {})
  data, _status_code, _headers = obtain_json_web_token_post_with_http_info(opts)
  return data
end

#obtain_json_web_token_post_with_http_info(opts = {}) ⇒ Array<(JSONWebTokenSerializer, Fixnum, Hash)>

API View that receives a POST with a user&#39;s username and password API View that receives a POST with a user&#39;s username and password.&lt;br/&gt;Returns a JSON Web Token that can be used for authenticated requests.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(JSONWebTokenSerializer, Fixnum, Hash)>) —

    JSONWebTokenSerializer data, response status code and response headers



47
48
49
50
51
52
53
54
55
56
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
82
83
84
85
 
# File 'lib/qwil_api/api/apitokenauth_api.rb', line 47

def obtain_json_web_token_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ApitokenauthApi.obtain_json_web_token_post ..."
  end
  # resource path
  local_var_path = "/api-token-auth/".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'json_web_token_serializer'])
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'JSONWebTokenSerializer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApitokenauthApi#obtain_json_web_token_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end