Class: OpenapiClient::UsersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/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.



19
20
21
 
# File 'lib/openapi_client/api/users_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/openapi_client/api/users_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#activate_user(app_id, user_id, opts = {}) ⇒ UserResponse

Activate User Activate a user. They will now be able to login.

Parameters:

  • app_id (String) —

    App ID

  • user_id (String) —

    User ID

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/openapi_client/api/users_api.rb', line 28

def activate_user(app_id, user_id, opts = {})
  data, _status_code, _headers = activate_user_with_http_info(app_id, user_id, opts)
  data
end

#activate_user_with_http_info(app_id, user_id, opts = {}) ⇒ Array<(UserResponse, Integer, Hash)>

Activate User Activate a user. They will now be able to login.

Parameters:

  • app_id (String) —

    App ID

  • user_id (String) —

    User ID

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

    the optional parameters

Returns:

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

    UserResponse data, response status code and response headers



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
85
86
87
88
89
 
# File 'lib/openapi_client/api/users_api.rb', line 39

def activate_user_with_http_info(app_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.activate_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.activate_user"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.activate_user"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/{user_id}/activate'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UserResponse'

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

  new_options = opts.merge(
    :operation => :"UsersApi.activate_user",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#activate_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_user(app_id, create_user_request, opts = {}) ⇒ UserResponse

Create User Create user for an application. Must provide an email of phone number identifier.

Parameters:

  • app_id (String) —

    App ID

  • create_user_request (CreateUserRequest) —

    email, phone, user_metadata

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

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/openapi_client/api/users_api.rb', line 97

def create_user(app_id, create_user_request, opts = {})
  data, _status_code, _headers = create_user_with_http_info(app_id, create_user_request, opts)
  data
end

#create_user_with_http_info(app_id, create_user_request, opts = {}) ⇒ Array<(UserResponse, Integer, Hash)>

Create User Create user for an application. Must provide an email of phone number identifier.

Parameters:

  • app_id (String) —

    App ID

  • create_user_request (CreateUserRequest) —

    email, phone, user_metadata

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

    the optional parameters

Returns:

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

    UserResponse data, response status code and response headers



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
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/openapi_client/api/users_api.rb', line 108

def create_user_with_http_info(app_id, create_user_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.create_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.create_user"
  end
  # verify the required parameter 'create_user_request' is set
  if @api_client.config.client_side_validation && create_user_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_user_request' when calling UsersApi.create_user"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users'.sub('{' + 'app_id' + '}', CGI.escape(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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'UserResponse'

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

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

#deactivate_user(app_id, user_id, opts = {}) ⇒ UserResponse

Deactivate User Deactivate a user. Their account will still exist, but they will not be able to login.

Parameters:

  • app_id (String) —

    App ID

  • user_id (String) —

    User ID

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

    the optional parameters

Returns:



171
172
173
174
 
# File 'lib/openapi_client/api/users_api.rb', line 171

def deactivate_user(app_id, user_id, opts = {})
  data, _status_code, _headers = deactivate_user_with_http_info(app_id, user_id, opts)
  data
end

#deactivate_user_with_http_info(app_id, user_id, opts = {}) ⇒ Array<(UserResponse, Integer, Hash)>

Deactivate User Deactivate a user. Their account will still exist, but they will not be able to login.

Parameters:

  • app_id (String) —

    App ID

  • user_id (String) —

    User ID

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

    the optional parameters

Returns:

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

    UserResponse data, response status code and response headers



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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/openapi_client/api/users_api.rb', line 182

def deactivate_user_with_http_info(app_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.deactivate_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.deactivate_user"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.deactivate_user"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/{user_id}/deactivate'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UserResponse'

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

  new_options = opts.merge(
    :operation => :"UsersApi.deactivate_user",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#deactivate_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_user(app_id, user_id, opts = {}) ⇒ nil

Delete User Delete a user.

Parameters:

  • app_id (String) —

    App ID

  • user_id (String) —

    User ID

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

    the optional parameters

Returns:

  • (nil) 


240
241
242
243
 
# File 'lib/openapi_client/api/users_api.rb', line 240

def delete_user(app_id, user_id, opts = {})
  delete_user_with_http_info(app_id, user_id, opts)
  nil
end

#delete_user_with_http_info(app_id, user_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete User Delete a user.

Parameters:

  • app_id (String) —

    App ID

  • user_id (String) —

    User ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/openapi_client/api/users_api.rb', line 251

def delete_user_with_http_info(app_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.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.delete_user"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/{user_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"UsersApi.delete_user",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user(app_id, user_id, opts = {}) ⇒ UserResponse

Get User Get information about a user.

Parameters:

  • app_id (String) —

    App ID

  • user_id (String) —

    User ID

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

    the optional parameters

Returns:



309
310
311
312
 
# File 'lib/openapi_client/api/users_api.rb', line 309

def get_user(app_id, user_id, opts = {})
  data, _status_code, _headers = get_user_with_http_info(app_id, user_id, opts)
  data
end

#get_user_with_http_info(app_id, user_id, opts = {}) ⇒ Array<(UserResponse, Integer, Hash)>

Get User Get information about a user.

Parameters:

  • app_id (String) —

    App ID

  • user_id (String) —

    User ID

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

    the optional parameters

Returns:

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

    UserResponse data, response status code and response headers



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/openapi_client/api/users_api.rb', line 320

def get_user_with_http_info(app_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.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.get_user"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/{user_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UserResponse'

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

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

#list_paginated_users(app_id, opts = {}) ⇒ ListPaginatedUsersResponse

List Users List users for an app.

Parameters:

  • app_id (String) —

    App ID

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page to fetch (min&#x3D;1)

  • :limit (Integer) —

    number of users to fetch per page (max&#x3D;500)

  • :created_before (Integer) —

    Unix timestamp to anchor pagination results (fetches events that were created before the timestamp)

  • :order_by (String) —

    Comma separated list of &lt;field&gt;:&lt;ASC/DESC&gt; (example: order_by&#x3D;id:DESC,created_at:ASC) **cannot order_by &#x60;identifier&#x60;

  • :identifier (String) —

    search users email OR phone (pagination prepended operators identifier&#x3D;&lt;val&gt;, identifier&#x3D;&lt;ne:val&gt;, identifier&#x3D;&lt;gt:val&gt;, identifier&#x3D;&lt;lt:val&gt;, identifier&#x3D;&lt;like:val&gt;, identifier&#x3D;&lt;not_like:val&gt;)

  • :id (String) —

    search users id (pagination prepended operators id&#x3D;&lt;val&gt;, id&#x3D;&lt;ne:val&gt;, id&#x3D;&lt;gt:val&gt;, id&#x3D;&lt;lt:val&gt;, id&#x3D;&lt;like:val&gt;, id&#x3D;&lt;not_like:val&gt;)

  • :login_count (Integer) —

    search users login_count (pagination prepended operators login_count&#x3D;&lt;val&gt;, login_count&#x3D;&lt;ne:val&gt;, login_count&#x3D;&lt;gt:val&gt;, login_count&#x3D;&lt;lt:val&gt;)

  • :status (String) —

    search users by status (pagination prepended operators status&#x3D;&lt;val&gt;, status&#x3D;&lt;ne:val&gt;, status&#x3D;&lt;gt:val&gt;, status&#x3D;&lt;lt:val&gt;, status&#x3D;&lt;like:val&gt;, status&#x3D;&lt;not_like:val&gt;) – valid values: (active, inactive, pending)

  • :created_at (String) —

    search users created_at (pagination prepended operators created_at&#x3D;&lt;val&gt;, created_at&#x3D;&lt;ne:val&gt;, created_at&#x3D;&lt;gt:val&gt;, created_at&#x3D;&lt;lt:val&gt; – valid timestamp in the format: 2006-01-02T15:04:05.000000Z required

  • :updated_at (String) —

    search users updated_at (pagination prepended operators updated_at&#x3D;&lt;val&gt;, updated_at&#x3D;&lt;ne:val&gt;, updated_at&#x3D;&lt;gt:val&gt;, updated_at&#x3D;&lt;lt:val&gt; – valid timestamp in the format: 2006-01-02T15:04:05.000000Z required

  • :last_login_at (String) —

    search users last_login_at (pagination prepended operators last_login_at&#x3D;&lt;val&gt;, lat_login_at&#x3D;&lt;ne:val&gt;, last_login_at&#x3D;&lt;gt:val&gt;, last_login_at&#x3D;&lt;lt:val&gt; – valid timestamp in the format: 2006-01-02T15:04:05.000000Z required

Returns:



388
389
390
391
 
# File 'lib/openapi_client/api/users_api.rb', line 388

def list_paginated_users(app_id, opts = {})
  data, _status_code, _headers = list_paginated_users_with_http_info(app_id, opts)
  data
end

#list_paginated_users_with_http_info(app_id, opts = {}) ⇒ Array<(ListPaginatedUsersResponse, Integer, Hash)>

List Users List users for an app.

Parameters:

  • app_id (String) —

    App ID

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page to fetch (min&#x3D;1)

  • :limit (Integer) —

    number of users to fetch per page (max&#x3D;500)

  • :created_before (Integer) —

    Unix timestamp to anchor pagination results (fetches events that were created before the timestamp)

  • :order_by (String) —

    Comma separated list of &lt;field&gt;:&lt;ASC/DESC&gt; (example: order_by&#x3D;id:DESC,created_at:ASC) **cannot order_by &#x60;identifier&#x60;

  • :identifier (String) —

    search users email OR phone (pagination prepended operators identifier&#x3D;&lt;val&gt;, identifier&#x3D;&lt;ne:val&gt;, identifier&#x3D;&lt;gt:val&gt;, identifier&#x3D;&lt;lt:val&gt;, identifier&#x3D;&lt;like:val&gt;, identifier&#x3D;&lt;not_like:val&gt;)

  • :id (String) —

    search users id (pagination prepended operators id&#x3D;&lt;val&gt;, id&#x3D;&lt;ne:val&gt;, id&#x3D;&lt;gt:val&gt;, id&#x3D;&lt;lt:val&gt;, id&#x3D;&lt;like:val&gt;, id&#x3D;&lt;not_like:val&gt;)

  • :login_count (Integer) —

    search users login_count (pagination prepended operators login_count&#x3D;&lt;val&gt;, login_count&#x3D;&lt;ne:val&gt;, login_count&#x3D;&lt;gt:val&gt;, login_count&#x3D;&lt;lt:val&gt;)

  • :status (String) —

    search users by status (pagination prepended operators status&#x3D;&lt;val&gt;, status&#x3D;&lt;ne:val&gt;, status&#x3D;&lt;gt:val&gt;, status&#x3D;&lt;lt:val&gt;, status&#x3D;&lt;like:val&gt;, status&#x3D;&lt;not_like:val&gt;) – valid values: (active, inactive, pending)

  • :created_at (String) —

    search users created_at (pagination prepended operators created_at&#x3D;&lt;val&gt;, created_at&#x3D;&lt;ne:val&gt;, created_at&#x3D;&lt;gt:val&gt;, created_at&#x3D;&lt;lt:val&gt; – valid timestamp in the format: 2006-01-02T15:04:05.000000Z required

  • :updated_at (String) —

    search users updated_at (pagination prepended operators updated_at&#x3D;&lt;val&gt;, updated_at&#x3D;&lt;ne:val&gt;, updated_at&#x3D;&lt;gt:val&gt;, updated_at&#x3D;&lt;lt:val&gt; – valid timestamp in the format: 2006-01-02T15:04:05.000000Z required

  • :last_login_at (String) —

    search users last_login_at (pagination prepended operators last_login_at&#x3D;&lt;val&gt;, lat_login_at&#x3D;&lt;ne:val&gt;, last_login_at&#x3D;&lt;gt:val&gt;, last_login_at&#x3D;&lt;lt:val&gt; – valid timestamp in the format: 2006-01-02T15:04:05.000000Z required

Returns:

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

    ListPaginatedUsersResponse data, response status code and response headers



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

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'login_count'] = opts[:'login_count'] if !opts[:'login_count'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'created_at'] = opts[:'created_at'] if !opts[:'created_at'].nil?
  query_params[:'updated_at'] = opts[:'updated_at'] if !opts[:'updated_at'].nil?
  query_params[:'last_login_at'] = opts[:'last_login_at'] if !opts[:'last_login_at'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListPaginatedUsersResponse'

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

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

#update_user(app_id, user_id, update_user_request, opts = {}) ⇒ UserResponse

Update User Update a user’s information.

Parameters:

  • app_id (String) —

    App ID

  • user_id (String) —

    User ID

  • update_user_request (UpdateUserRequest) —

    user settings

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

    the optional parameters

Returns:



475
476
477
478
 
# File 'lib/openapi_client/api/users_api.rb', line 475

def update_user(app_id, user_id, update_user_request, opts = {})
  data, _status_code, _headers = update_user_with_http_info(app_id, user_id, update_user_request, opts)
  data
end

#update_user_with_http_info(app_id, user_id, update_user_request, opts = {}) ⇒ Array<(UserResponse, Integer, Hash)>

Update User Update a user&#39;s information.

Parameters:

  • app_id (String) —

    App ID

  • user_id (String) —

    User ID

  • update_user_request (UpdateUserRequest) —

    user settings

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

    the optional parameters

Returns:

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

    UserResponse data, response status code and response headers



487
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
539
540
541
542
543
544
545
546
 
# File 'lib/openapi_client/api/users_api.rb', line 487

def update_user_with_http_info(app_id, user_id, update_user_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.update_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.update_user"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_user"
  end
  # verify the required parameter 'update_user_request' is set
  if @api_client.config.client_side_validation && update_user_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_user_request' when calling UsersApi.update_user"
  end
  # resource path
  local_var_path = '/apps/{app_id}/users/{user_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'UserResponse'

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

  new_options = opts.merge(
    :operation => :"UsersApi.update_user",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end