Class: TriglavClient::AuthApi

Inherits:
Object
  • Object
show all
Defined in:
lib/triglav_client/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.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/triglav_client/api/auth_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#create_token(credential, opts = {}) ⇒ TokenResponse

Creates a new token

Parameters:

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

    the optional parameters

Returns:



39
40
41
42
 
# File 'lib/triglav_client/api/auth_api.rb', line 39

def create_token(credential, opts = {})
  data, _status_code, _headers = create_token_with_http_info(credential, opts)
  return data
end

#create_token_with_http_info(credential, opts = {}) ⇒ Array<(TokenResponse, Fixnum, Hash)>

Creates a new token

Parameters:

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

    the optional parameters

Returns:

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

    TokenResponse data, response status code and response headers



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
86
87
88
89
 
# File 'lib/triglav_client/api/auth_api.rb', line 49

def create_token_with_http_info(credential, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthApi.create_token ..."
  end
  # verify the required parameter 'credential' is set
  fail ArgumentError, "Missing the required parameter 'credential' when calling AuthApi.create_token" if credential.nil?
  # resource path
  local_var_path = "/auth/token".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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 = ['application/json']
  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(credential)
  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 => 'TokenResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthApi#create_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_token(opts = {}) ⇒ nil

Deletes (Expires) a token of header

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


95
96
97
98
 
# File 'lib/triglav_client/api/auth_api.rb', line 95

def delete_token(opts = {})
  delete_token_with_http_info(opts)
  return nil
end

#delete_token_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes (Expires) a token of header

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/triglav_client/api/auth_api.rb', line 104

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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 = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthApi#delete_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#me(opts = {}) ⇒ UserResponse

Returns a user property of the access_token

Parameters:

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

    the optional parameters

Returns:



147
148
149
150
 
# File 'lib/triglav_client/api/auth_api.rb', line 147

def me(opts = {})
  data, _status_code, _headers = me_with_http_info(opts)
  return data
end

#me_with_http_info(opts = {}) ⇒ Array<(UserResponse, Fixnum, Hash)>

Returns a user property of the access_token

Parameters:

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

    the optional parameters

Returns:

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

    UserResponse data, response status code and response headers



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
 
# File 'lib/triglav_client/api/auth_api.rb', line 156

def me_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthApi.me ..."
  end
  # resource path
  local_var_path = "/auth/me".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  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 = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthApi#me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end