Class: Notifo::UserApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserApi 



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

def api_client
  @api_client
end

Instance Method Details

#user_delete_subscription(prefix, opts = {}) ⇒ nil

Remove my subscription. User Id and App Id are resolved using the API token.



24
25
26
27
 
# File 'lib/notifo/api/user_api.rb', line 24

def user_delete_subscription(prefix, opts = {})
  user_delete_subscription_with_http_info(prefix, opts)
  nil
end

#user_delete_subscription_with_http_info(prefix, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove my subscription. User Id and App Id are resolved using the API token.



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/user_api.rb', line 34

def user_delete_subscription_with_http_info(prefix, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_delete_subscription ...'
  end
  # verify the required parameter 'prefix' is set
  if @api_client.config.client_side_validation && prefix.nil?
    fail ArgumentError, "Missing the required parameter 'prefix' when calling UserApi.user_delete_subscription"
  end
  # resource path
  local_var_path = '/api/me/subscriptions/{prefix}'.sub('{' + 'prefix' + '}', prefix.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'])

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

  # http body (model)
  post_body = opts[: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: UserApi#user_delete_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get_admin_user(opts = {}) ⇒ AdminProfileDto

Get the current admin user.



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

def user_get_admin_user(opts = {})
  data, _status_code, _headers = user_get_admin_user_with_http_info(opts)
  data
end

#user_get_admin_user_with_http_info(opts = {}) ⇒ Array<(AdminProfileDto, Integer, Hash)>

Get the current admin user.



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/user_api.rb', line 86

def user_get_admin_user_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_get_admin_user ...'
  end
  # resource path
  local_var_path = '/api/me/admin'

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

  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: UserApi#user_get_admin_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get_my_subscription(topic, opts = {}) ⇒ SubscriptionDto

Gets a user subscription. User Id and App Id are resolved using the API token.



128
129
130
131
 
# File 'lib/notifo/api/user_api.rb', line 128

def user_get_my_subscription(topic, opts = {})
  data, _status_code, _headers = user_get_my_subscription_with_http_info(topic, opts)
  data
end

#user_get_my_subscription_with_http_info(topic, opts = {}) ⇒ Array<(SubscriptionDto, Integer, Hash)>

Gets a user subscription. User Id and App Id are resolved using the API token.



138
139
140
141
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
 
# File 'lib/notifo/api/user_api.rb', line 138

def user_get_my_subscription_with_http_info(topic, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_get_my_subscription ...'
  end
  # verify the required parameter 'topic' is set
  if @api_client.config.client_side_validation && topic.nil?
    fail ArgumentError, "Missing the required parameter 'topic' when calling UserApi.user_get_my_subscription"
  end
  # resource path
  local_var_path = '/api/me/subscriptions/{topic}'.sub('{' + 'topic' + '}', topic.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'])

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

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

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

  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: UserApi#user_get_my_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get_my_subscriptions(opts = {}) ⇒ ListResponseDtoOfSubscriptionDto

Query the user subscriptions.

Options Hash (opts):

  • :topics (String) —

    The topics we are interested in.

  • :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.



186
187
188
189
 
# File 'lib/notifo/api/user_api.rb', line 186

def user_get_my_subscriptions(opts = {})
  data, _status_code, _headers = user_get_my_subscriptions_with_http_info(opts)
  data
end

#user_get_my_subscriptions_with_http_info(opts = {}) ⇒ Array<(ListResponseDtoOfSubscriptionDto, Integer, Hash)>

Query the user subscriptions.

Options Hash (opts):

  • :topics (String) —

    The topics we are interested in.

  • :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.



198
199
200
201
202
203
204
205
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
 
# File 'lib/notifo/api/user_api.rb', line 198

def user_get_my_subscriptions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_get_my_subscriptions ...'
  end
  # resource path
  local_var_path = '/api/me/subscriptions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'Topics'] = opts[:'topics'] if !opts[:'topics'].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] || 'ListResponseDtoOfSubscriptionDto' 

  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: UserApi#user_get_my_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get_topics(opts = {}) ⇒ Array<UserTopicDto>

Query the user topics.

Options Hash (opts):

  • :language (String) —

    The optional language.



243
244
245
246
 
# File 'lib/notifo/api/user_api.rb', line 243

def user_get_topics(opts = {})
  data, _status_code, _headers = user_get_topics_with_http_info(opts)
  data
end

#user_get_topics_with_http_info(opts = {}) ⇒ Array<(Array<UserTopicDto>, Integer, Hash)>

Query the user topics.

Options Hash (opts):

  • :language (String) —

    The optional language.



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/notifo/api/user_api.rb', line 252

def user_get_topics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_get_topics ...'
  end
  # resource path
  local_var_path = '/api/me/topics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'language'] = opts[:'language'] if !opts[:'language'].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] || 'Array<UserTopicDto>' 

  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: UserApi#user_get_topics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_get_user(opts = {}) ⇒ ProfileDto

Get the current user.



293
294
295
296
 
# File 'lib/notifo/api/user_api.rb', line 293

def user_get_user(opts = {})
  data, _status_code, _headers = user_get_user_with_http_info(opts)
  data
end

#user_get_user_with_http_info(opts = {}) ⇒ Array<(ProfileDto, Integer, Hash)>

Get the current user.



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/notifo/api/user_api.rb', line 301

def user_get_user_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.user_get_user ...'
  end
  # resource path
  local_var_path = '/api/me'

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

  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: UserApi#user_get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Upserts or deletes my subscriptions. User Id and App Id are resolved using the API token.



343
344
345
346
 
# File 'lib/notifo/api/user_api.rb', line 343

def user_post_my_subscriptions(body, opts = {})
  user_post_my_subscriptions_with_http_info(body, opts)
  nil
end

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

Upserts or deletes my subscriptions. User Id and App Id are resolved using the API token.



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/notifo/api/user_api.rb', line 353

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

  # 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: UserApi#user_post_my_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#user_post_user(body, opts = {}) ⇒ ProfileDto

Update the user.



400
401
402
403
 
# File 'lib/notifo/api/user_api.rb', line 400

def user_post_user(body, opts = {})
  data, _status_code, _headers = user_post_user_with_http_info(body, opts)
  data
end

#user_post_user_with_http_info(body, opts = {}) ⇒ Array<(ProfileDto, Integer, Hash)>

Update the user.



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/notifo/api/user_api.rb', line 409

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

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

  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: UserApi#user_post_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end