Class: Notifo::UsersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsersApi

Returns a new instance of UsersApi.



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

def api_client
  @api_client
end

Instance Method Details

#users_delete_allowed_topic(app_id, id, prefix, opts = {}) ⇒ nil

Remove an allowed topic.

Parameters:

  • app_id —

    The app where the users belong to.

  • id —

    The user id.

  • prefix —

    The topic prefix.

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

    the optional parameters

Returns:

  • (nil) 


25
26
27
28
 
# File 'lib/notifo/api/users_api.rb', line 25

def users_delete_allowed_topic(app_id, id, prefix, opts = {})
  users_delete_allowed_topic_with_http_info(app_id, id, prefix, opts)
  nil
end

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

Remove an allowed topic.

Parameters:

  • app_id —

    The app where the users belong to.

  • id —

    The user id.

  • prefix —

    The topic prefix.

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

    the optional parameters

Returns:

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

    nil, 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
83
84
 
# File 'lib/notifo/api/users_api.rb', line 36

def users_delete_allowed_topic_with_http_info(app_id, id, prefix, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.users_delete_allowed_topic ...'
  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 UsersApi.users_delete_allowed_topic"
  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 UsersApi.users_delete_allowed_topic"
  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 UsersApi.users_delete_allowed_topic"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/users/{id}/allowed-topics/{prefix}'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'id' + '}', id.to_s).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(:DELETE, 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: UsersApi#users_delete_allowed_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_delete_subscription(app_id, id, prefix, opts = {}) ⇒ nil

Remove a user subscriptions.

Parameters:

  • app_id —

    The app where the user belongs to.

  • id —

    The user id.

  • prefix —

    The topic prefix.

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

    the optional parameters

Returns:

  • (nil) 


91
92
93
94
 
# File 'lib/notifo/api/users_api.rb', line 91

def users_delete_subscription(app_id, id, prefix, opts = {})
  users_delete_subscription_with_http_info(app_id, id, prefix, opts)
  nil
end

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

Remove a user subscriptions.

Parameters:

  • app_id —

    The app where the user belongs to.

  • id —

    The user id.

  • prefix —

    The topic prefix.

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/notifo/api/users_api.rb', line 102

def users_delete_subscription_with_http_info(app_id, id, prefix, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.users_delete_subscription ...'
  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 UsersApi.users_delete_subscription"
  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 UsersApi.users_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 UsersApi.users_delete_subscription"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/users/{id}/subscriptions/{prefix}'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'id' + '}', id.to_s).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(:DELETE, 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: UsersApi#users_delete_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_delete_user(app_id, id, opts = {}) ⇒ ListResponseDtoOfUserDto

Delete a user.

Parameters:

  • app_id —

    The app where the users belongs to.

  • id —

    The user id to delete.

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

    the optional parameters

Returns:



156
157
158
159
 
# File 'lib/notifo/api/users_api.rb', line 156

def users_delete_user(app_id, id, opts = {})
  data, _status_code, _headers = users_delete_user_with_http_info(app_id, id, opts)
  data
end

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

Delete a user.

Parameters:

  • app_id —

    The app where the users belongs to.

  • id —

    The user id to delete.

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

    the optional parameters

Returns:

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

    ListResponseDtoOfUserDto data, response status code and response headers



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/notifo/api/users_api.rb', line 166

def users_delete_user_with_http_info(app_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.users_delete_user ...'
  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 UsersApi.users_delete_user"
  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 UsersApi.users_delete_user"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/users/{id}'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'id' + '}', 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'])

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

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

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

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:DELETE, 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: UsersApi#users_delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_get_subscriptions(app_id, id, opts = {}) ⇒ ListResponseDtoOfSubscriptionDto

Query user subscriptions.

Parameters:

  • app_id —

    The app where the user belongs to.

  • id —

    The user id.

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

    the optional parameters

Options Hash (opts):

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



219
220
221
222
 
# File 'lib/notifo/api/users_api.rb', line 219

def users_get_subscriptions(app_id, id, opts = {})
  data, _status_code, _headers = users_get_subscriptions_with_http_info(app_id, id, opts)
  data
end

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

Query user subscriptions.

Parameters:

  • app_id —

    The app where the user belongs to.

  • id —

    The user id.

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

    the optional parameters

Options Hash (opts):

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
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
 
# File 'lib/notifo/api/users_api.rb', line 232

def users_get_subscriptions_with_http_info(app_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.users_get_subscriptions ...'
  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 UsersApi.users_get_subscriptions"
  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 UsersApi.users_get_subscriptions"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/users/{id}/subscriptions'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  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: UsersApi#users_get_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_get_user(app_id, id, opts = {}) ⇒ ListResponseDtoOfUserDto

Get a user.

Parameters:

  • app_id —

    The app where the user belongs to.

  • id —

    The user id.

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

    the optional parameters

Returns:



285
286
287
288
 
# File 'lib/notifo/api/users_api.rb', line 285

def users_get_user(app_id, id, opts = {})
  data, _status_code, _headers = users_get_user_with_http_info(app_id, id, opts)
  data
end

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

Get a user.

Parameters:

  • app_id —

    The app where the user belongs to.

  • id —

    The user id.

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

    the optional parameters

Returns:

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

    ListResponseDtoOfUserDto data, response status code and response headers



295
296
297
298
299
300
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
338
339
 
# File 'lib/notifo/api/users_api.rb', line 295

def users_get_user_with_http_info(app_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.users_get_user ...'
  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 UsersApi.users_get_user"
  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 UsersApi.users_get_user"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/users/{id}'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'id' + '}', 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'])

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

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

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

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

#users_get_users(app_id, opts = {}) ⇒ ListResponseDtoOfUserDto

Query users.

Parameters:

  • app_id —

    The app where the users belongs to.

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

    the optional parameters

Options Hash (opts):

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



347
348
349
350
 
# File 'lib/notifo/api/users_api.rb', line 347

def users_get_users(app_id, opts = {})
  data, _status_code, _headers = users_get_users_with_http_info(app_id, opts)
  data
end

#users_get_users_with_http_info(app_id, opts = {}) ⇒ Array<(ListResponseDtoOfUserDto, Integer, Hash)>

Query users.

Parameters:

  • app_id —

    The app where the users belongs to.

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

    the optional parameters

Options Hash (opts):

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

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

    ListResponseDtoOfUserDto data, response status code and response headers



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
396
397
398
399
400
401
402
 
# File 'lib/notifo/api/users_api.rb', line 359

def users_get_users_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.users_get_users ...'
  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 UsersApi.users_get_users"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/users'.sub('{' + 'appId' + '}', app_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  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] || 'ListResponseDtoOfUserDto' 

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

#users_post_allowed_topic(body, app_id, id, opts = {}) ⇒ nil

Add an allowed topic.

Parameters:

  • body —

    The upsert request.

  • app_id —

    The app where the users belong to.

  • id —

    The user id.

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

    the optional parameters

Returns:

  • (nil) 


409
410
411
412
 
# File 'lib/notifo/api/users_api.rb', line 409

def users_post_allowed_topic(body, app_id, id, opts = {})
  users_post_allowed_topic_with_http_info(body, app_id, id, opts)
  nil
end

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

Add an allowed topic.

Parameters:

  • body —

    The upsert request.

  • app_id —

    The app where the users belong to.

  • id —

    The user id.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/notifo/api/users_api.rb', line 420

def users_post_allowed_topic_with_http_info(body, app_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.users_post_allowed_topic ...'
  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 UsersApi.users_post_allowed_topic"
  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 UsersApi.users_post_allowed_topic"
  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 UsersApi.users_post_allowed_topic"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/users/{id}/allowed-topics'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'id' + '}', 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] 

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

#users_post_subscription(body, app_id, id, opts = {}) ⇒ nil

Upsert a user subscriptions.

Parameters:

  • body —

    The subscription object.

  • app_id —

    The app where the user belongs to.

  • id —

    The user id.

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

    the optional parameters

Returns:

  • (nil) 


477
478
479
480
 
# File 'lib/notifo/api/users_api.rb', line 477

def users_post_subscription(body, app_id, id, opts = {})
  users_post_subscription_with_http_info(body, app_id, id, opts)
  nil
end

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

Upsert a user subscriptions.

Parameters:

  • body —

    The subscription object.

  • app_id —

    The app where the user belongs to.

  • id —

    The user id.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/notifo/api/users_api.rb', line 488

def users_post_subscription_with_http_info(body, app_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.users_post_subscription ...'
  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 UsersApi.users_post_subscription"
  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 UsersApi.users_post_subscription"
  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 UsersApi.users_post_subscription"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/users/{id}/subscriptions'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'id' + '}', 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] 

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

#users_post_users(body, app_id, opts = {}) ⇒ Array<UserDto>

Upsert users.

Parameters:

  • body —

    The upsert request.

  • app_id —

    The app where the users belong to.

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

    the optional parameters

Returns:



544
545
546
547
 
# File 'lib/notifo/api/users_api.rb', line 544

def users_post_users(body, app_id, opts = {})
  data, _status_code, _headers = users_post_users_with_http_info(body, app_id, opts)
  data
end

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

Upsert users.

Parameters:

  • body —

    The upsert request.

  • app_id —

    The app where the users belong to.

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

    the optional parameters

Returns:

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

    Array<UserDto> data, response status code and response headers



554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/notifo/api/users_api.rb', line 554

def users_post_users_with_http_info(body, app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.users_post_users ...'
  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 UsersApi.users_post_users"
  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 UsersApi.users_post_users"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/users'.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] || 'Array<UserDto>' 

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