Class: Notifo::NotificationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/notifo/api/notifications_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NotificationsApi

Returns a new instance of NotificationsApi.



16
17
18
 
# File 'lib/notifo/api/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/notifo/api/notifications_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#notifications_confirm_me(body, opts = {}) ⇒ nil

Confirms the user notifications for the current user.

Parameters:

  • body —

    The request object.

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

    the optional parameters

Returns:

  • (nil) 


23
24
25
26
 
# File 'lib/notifo/api/notifications_api.rb', line 23

def notifications_confirm_me(body, opts = {})
  notifications_confirm_me_with_http_info(body, opts)
  nil
end

#notifications_confirm_me_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Confirms the user notifications for the current user.

Parameters:

  • body —

    The request object.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



32
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
 
# File 'lib/notifo/api/notifications_api.rb', line 32

def notifications_confirm_me_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_confirm_me ...'
  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 NotificationsApi.notifications_confirm_me"
  end
  # resource path
  local_var_path = '/api/me/notifications/handled'

  # 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] 

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

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

#notifications_get_my_archive(opts = {}) ⇒ ListResponseDtoOfUserNotificationDto

Query archhived user notifications of the current user.

Parameters:

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

    the optional parameters

Returns:



78
79
80
81
 
# File 'lib/notifo/api/notifications_api.rb', line 78

def notifications_get_my_archive(opts = {})
  data, _status_code, _headers = notifications_get_my_archive_with_http_info(opts)
  data
end

#notifications_get_my_archive_with_http_info(opts = {}) ⇒ Array<(ListResponseDtoOfUserNotificationDto, Integer, Hash)>

Query archhived user notifications of the current user.

Parameters:

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

    the optional parameters

Returns:



86
87
88
89
90
91
92
93
94
95
96
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
 
# File 'lib/notifo/api/notifications_api.rb', line 86

def notifications_get_my_archive_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_get_my_archive ...'
  end
  # resource path
  local_var_path = '/api/me/notifications/archive'

  # 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'])

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

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

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

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

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

#notifications_get_my_notifications(opts = {}) ⇒ ListResponseDtoOfUserNotificationDto

Query user notifications of the current user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :channels (Array<String>) —

    The active channels.

  • :query (String) —

    The optional query to search for items.

  • :take (Integer) —

    The number of items to return.

  • :skip (Integer) —

    The number of items to skip.

Returns:



130
131
132
133
 
# File 'lib/notifo/api/notifications_api.rb', line 130

def notifications_get_my_notifications(opts = {})
  data, _status_code, _headers = notifications_get_my_notifications_with_http_info(opts)
  data
end

#notifications_get_my_notifications_with_http_info(opts = {}) ⇒ Array<(ListResponseDtoOfUserNotificationDto, Integer, Hash)>

Query user notifications of the current user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :channels (Array<String>) —

    The active channels.

  • :query (String) —

    The optional query to search for items.

  • :take (Integer) —

    The number of items to return.

  • :skip (Integer) —

    The number of items to skip.

Returns:



142
143
144
145
146
147
148
149
150
151
152
153
154
155
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
 
# File 'lib/notifo/api/notifications_api.rb', line 142

def notifications_get_my_notifications_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_get_my_notifications ...'
  end
  # resource path
  local_var_path = '/api/me/notifications'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'Channels'] = @api_client.build_collection_param(opts[:'channels'], :multi) if !opts[:'channels'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?

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

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

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

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

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

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

#notifications_get_notifications(app_id, id, opts = {}) ⇒ ListResponseDtoOfUserNotificationDetailsDto

Query user notifications.

Parameters:

  • app_id —

    The app where the user belongs to.

  • id —

    The user id.

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

    the optional parameters

Options Hash (opts):

  • :channels (Array<String>) —

    The active channels.

  • :query (String) —

    The optional query to search for items.

  • :take (Integer) —

    The number of items to return.

  • :skip (Integer) —

    The number of items to skip.

Returns:



192
193
194
195
 
# File 'lib/notifo/api/notifications_api.rb', line 192

def notifications_get_notifications(app_id, id, opts = {})
  data, _status_code, _headers = notifications_get_notifications_with_http_info(app_id, id, opts)
  data
end

#notifications_get_notifications_with_http_info(app_id, id, opts = {}) ⇒ Array<(ListResponseDtoOfUserNotificationDetailsDto, Integer, Hash)>

Query user notifications.

Parameters:

  • app_id —

    The app where the user belongs to.

  • id —

    The user id.

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

    the optional parameters

Options Hash (opts):

  • :channels (Array<String>) —

    The active channels.

  • :query (String) —

    The optional query to search for items.

  • :take (Integer) —

    The number of items to return.

  • :skip (Integer) —

    The number of items to skip.

Returns:



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/notifo/api/notifications_api.rb', line 206

def notifications_get_notifications_with_http_info(app_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_get_notifications ...'
  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 NotificationsApi.notifications_get_notifications"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling NotificationsApi.notifications_get_notifications"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/users/{id}/notifications'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'Channels'] = @api_client.build_collection_param(opts[:'channels'], :multi) if !opts[:'channels'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?

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

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

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

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

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

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