Class: SematextCloud::AlertNotificationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/SematextCloud/api/alert_notifications_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AlertNotificationsApi

Returns a new instance of AlertNotificationsApi.



16
17
18
 
# File 'lib/SematextCloud/api/alert_notifications_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/SematextCloud/api/alert_notifications_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_alert_notifications_for_app_using_post1(body, app_id, opts = {}) ⇒ NotificationsResponse

Get alert notifications for an app Default value of interval is 1d

Parameters:

  • body —

    Time Interval

  • app_id —

    appId

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/SematextCloud/api/alert_notifications_api.rb', line 25

def get_alert_notifications_for_app_using_post1(body, app_id, opts = {})
  data, _status_code, _headers = get_alert_notifications_for_app_using_post1_with_http_info(body, app_id, opts)
  data
end

#get_alert_notifications_for_app_using_post1_with_http_info(body, app_id, opts = {}) ⇒ Array<(NotificationsResponse, Integer, Hash)>

Get alert notifications for an app Default value of interval is 1d

Parameters:

  • body —

    Time Interval

  • app_id —

    appId

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

    the optional parameters

Returns:

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

    NotificationsResponse data, response status code and response headers



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
82
 
# File 'lib/SematextCloud/api/alert_notifications_api.rb', line 36

def get_alert_notifications_for_app_using_post1_with_http_info(body, app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertNotificationsApi.get_alert_notifications_for_app_using_post1 ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AlertNotificationsApi.get_alert_notifications_for_app_using_post1"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling AlertNotificationsApi.get_alert_notifications_for_app_using_post1"
  end
  # resource path
  local_var_path = '/users-web/api/v3/apps/{appId}/notifications/alerts'.sub('{' + 'appId' + '}', app_id.to_s)

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

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

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

  return_type = opts[:return_type] || 'NotificationsResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertNotificationsApi#get_alert_notifications_for_app_using_post1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alert_notifications_for_user_using_post1(body, opts = {}) ⇒ NotificationsResponse

Get alert notifications for a user Default value of interval is 1d

Parameters:

  • body —

    Time Interval

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

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/SematextCloud/api/alert_notifications_api.rb', line 88

def get_alert_notifications_for_user_using_post1(body, opts = {})
  data, _status_code, _headers = get_alert_notifications_for_user_using_post1_with_http_info(body, opts)
  data
end

#get_alert_notifications_for_user_using_post1_with_http_info(body, opts = {}) ⇒ Array<(NotificationsResponse, Integer, Hash)>

Get alert notifications for a user Default value of interval is 1d

Parameters:

  • body —

    Time Interval

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

    the optional parameters

Returns:

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

    NotificationsResponse data, response status code and response headers



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/SematextCloud/api/alert_notifications_api.rb', line 98

def get_alert_notifications_for_user_using_post1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertNotificationsApi.get_alert_notifications_for_user_using_post1 ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AlertNotificationsApi.get_alert_notifications_for_user_using_post1"
  end
  # resource path
  local_var_path = '/users-web/api/v3/notifications/alerts'

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

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

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

  return_type = opts[:return_type] || 'NotificationsResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertNotificationsApi#get_alert_notifications_for_user_using_post1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end