Class: Fastly::SudoApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/sudo_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SudoApi

Returns a new instance of SudoApi.



17
18
19
 
# File 'lib/fastly/api/sudo_api.rb', line 17

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/sudo_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#request_sudo_access(opts = {}) ⇒ SudoResponse

Request Sudo access Re-authenticate to allow the provided user to obtain sudo access.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



24
25
26
27
 
# File 'lib/fastly/api/sudo_api.rb', line 24

def request_sudo_access(opts = {})
  data, _status_code, _headers = request_sudo_access_with_http_info(opts)
  data
end

#request_sudo_access_with_http_info(opts = {}) ⇒ Array<(SudoResponse, Integer, Hash)>

Request Sudo access Re-authenticate to allow the provided user to obtain sudo access.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:

  • (Array<(SudoResponse, Integer, Hash)>) —

    SudoResponse data, response status code and response headers



33
34
35
36
37
38
39
40
41
42
43
44
45
46
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
 
# File 'lib/fastly/api/sudo_api.rb', line 33

def request_sudo_access_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SudoApi.request_sudo_access ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/sudo'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'sudo_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'SudoResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"SudoApi.request_sudo_access",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SudoApi#request_sudo_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end