Class: AgentCatApi::AlertsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/agentcat-api/api/alerts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AlertsApi

Returns a new instance of AlertsApi.



19
20
21
 
# File 'lib/agentcat-api/api/alerts_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/agentcat-api/api/alerts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#unsubscribe_alert_get(opts = {}) ⇒ String

Show the confirmation page for removing an email address from one alert rule GET, the link in the email, shows a confirmation page and changes nothing, because mail scanners fetch links. POST removes the address from the rule; the page's form and the List-Unsubscribe-Post header both send it. POST is idempotent.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :token (String)

Returns:

  • (String) 


27
28
29
30
 
# File 'lib/agentcat-api/api/alerts_api.rb', line 27

def unsubscribe_alert_get(opts = {})
  data, _status_code, _headers = unsubscribe_alert_get_with_http_info(opts)
  data
end

#unsubscribe_alert_get_with_http_info(opts = {}) ⇒ Array<(String, Integer, Hash)>

Show the confirmation page for removing an email address from one alert rule GET, the link in the email, shows a confirmation page and changes nothing, because mail scanners fetch links. POST removes the address from the rule; the page's form and the List-Unsubscribe-Post header both send it. POST is idempotent.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :token (String)

Returns:

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

    String data, response status code and response headers



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
 
# File 'lib/agentcat-api/api/alerts_api.rb', line 37

def unsubscribe_alert_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.unsubscribe_alert_get ...'
  end
  # resource path
  local_var_path = '/v1/public/alerts/unsubscribe'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/html', 'text/plain', '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] || 'String'

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

  new_options = opts.merge(
    :operation => :"AlertsApi.unsubscribe_alert_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: AlertsApi#unsubscribe_alert_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unsubscribe_alert_post(opts = {}) ⇒ String

Remove an email address from one alert rule (List-Unsubscribe-Post and the confirmation form) GET, the link in the email, shows a confirmation page and changes nothing, because mail scanners fetch links. POST removes the address from the rule; the page's form and the List-Unsubscribe-Post header both send it. POST is idempotent.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :token (String)

Returns:

  • (String) 


87
88
89
90
 
# File 'lib/agentcat-api/api/alerts_api.rb', line 87

def unsubscribe_alert_post(opts = {})
  data, _status_code, _headers = unsubscribe_alert_post_with_http_info(opts)
  data
end

#unsubscribe_alert_post_with_http_info(opts = {}) ⇒ Array<(String, Integer, Hash)>

Remove an email address from one alert rule (List-Unsubscribe-Post and the confirmation form) GET, the link in the email, shows a confirmation page and changes nothing, because mail scanners fetch links. POST removes the address from the rule; the page's form and the List-Unsubscribe-Post header both send it. POST is idempotent.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :token (String)

Returns:

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

    String data, response status code and response headers



97
98
99
100
101
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
 
# File 'lib/agentcat-api/api/alerts_api.rb', line 97

def unsubscribe_alert_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.unsubscribe_alert_post ...'
  end
  # resource path
  local_var_path = '/v1/public/alerts/unsubscribe'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', '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] || 'String'

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

  new_options = opts.merge(
    :operation => :"AlertsApi.unsubscribe_alert_post",
    :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: AlertsApi#unsubscribe_alert_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end