Class: MailSafePro::DeveloperToolsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mailsafepro/api/developer_tools_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DeveloperToolsApi

Returns a new instance of DeveloperToolsApi.



19
20
21
 
# File 'lib/mailsafepro/api/developer_tools_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/mailsafepro/api/developer_tools_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#clear_request_logs_logs_logs_requests_delete(opts = {}) ⇒ Object

Clear Request Logs Clear all request logs for current user.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


26
27
28
29
 
# File 'lib/mailsafepro/api/developer_tools_api.rb', line 26

def clear_request_logs_logs_logs_requests_delete(opts = {})
  data, _status_code, _headers = clear_request_logs_logs_logs_requests_delete_with_http_info(opts)
  data
end

#clear_request_logs_logs_logs_requests_delete_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Clear Request Logs Clear all request logs for current user.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
 
# File 'lib/mailsafepro/api/developer_tools_api.rb', line 35

def clear_request_logs_logs_logs_requests_delete_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeveloperToolsApi.clear_request_logs_logs_logs_requests_delete ...'
  end
  # resource path
  local_var_path = '/logs/logs/requests'

  # 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/json']) unless header_params['Accept']

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DeveloperToolsApi.clear_request_logs_logs_logs_requests_delete",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeveloperToolsApi#clear_request_logs_logs_logs_requests_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_request_logs_logs_logs_requests_get(opts = {}) ⇒ Object

Get Request Logs Get request logs for authenticated user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Max results to return (default to 100)

  • :status_code (Integer) —

    Filter by HTTP status code

  • :endpoint (String) —

    Filter by endpoint path

  • :method (String) —

    Filter by HTTP method (GET, POST, etc)

  • :since (Time) —

    Filter by timestamp (ISO 8601)

Returns:

  • (Object) 


88
89
90
91
 
# File 'lib/mailsafepro/api/developer_tools_api.rb', line 88

def get_request_logs_logs_logs_requests_get(opts = {})
  data, _status_code, _headers = get_request_logs_logs_logs_requests_get_with_http_info(opts)
  data
end

#get_request_logs_logs_logs_requests_get_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get Request Logs Get request logs for authenticated user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Max results to return (default to 100)

  • :status_code (Integer) —

    Filter by HTTP status code

  • :endpoint (String) —

    Filter by endpoint path

  • :method (String) —

    Filter by HTTP method (GET, POST, etc)

  • :since (Time) —

    Filter by timestamp (ISO 8601)

Returns:

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

    Object data, response status code and response headers



102
103
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
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/mailsafepro/api/developer_tools_api.rb', line 102

def get_request_logs_logs_logs_requests_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeveloperToolsApi.get_request_logs_logs_logs_requests_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DeveloperToolsApi.get_request_logs_logs_logs_requests_get, must be smaller than or equal to 500.'
  end

  # resource path
  local_var_path = '/logs/logs/requests'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'status_code'] = opts[:'status_code'] if !opts[:'status_code'].nil?
  query_params[:'endpoint'] = opts[:'endpoint'] if !opts[:'endpoint'].nil?
  query_params[:'method'] = opts[:'method'] if !opts[:'method'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"DeveloperToolsApi.get_request_logs_logs_logs_requests_get",
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeveloperToolsApi#get_request_logs_logs_logs_requests_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end