Class: SunshineConversationsClient::UsersApi

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



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

def api_client
  @api_client
end

Instance Method Details

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

Create User Creates a new user.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/sunshine-conversations-client/api/users_api.rb', line 25

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

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

Create User Creates a new user.

Parameters:

  • app_id (String) —

    Identifies the app.

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

    the optional parameters

Returns:

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

    UserResponse 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
83
84
85
86
87
88
89
90
91
 
# File 'lib/sunshine-conversations-client/api/users_api.rb', line 36

def create_user_with_http_info(app_id, user_create_body, 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 'user_create_body' is set
  if @api_client.config.client_side_validation && user_create_body.nil?
    fail ArgumentError, "Missing the required parameter 'user_create_body' when calling UsersApi.create_user"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/users'.sub('{' + 'appId' + '}', 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']) unless header_params['Accept']
  # 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(user_create_body)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', '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

#delete_user(app_id, user_id_or_external_id, opts = {}) ⇒ Object

Delete User Delete a user, its clients and its conversation history. The user is considered completely deleted once the ‘user:delete` webhook is fired. To only delete a user’s personal information, see [Delete User Personal Information](#operation/DeleteUserPersonalInformation).

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

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

    the optional parameters

Returns:

  • (Object) 


99
100
101
102
 
# File 'lib/sunshine-conversations-client/api/users_api.rb', line 99

def delete_user(app_id, user_id_or_external_id, opts = {})
  data, _status_code, _headers = delete_user_with_http_info(app_id, user_id_or_external_id, opts)
  data
end

#delete_user_personal_information(app_id, user_id_or_external_id, opts = {}) ⇒ UserResponse

Delete User Personal Information Delete a user’s personal information. Calling this API will clear ‘givenName`, `surname`, `email` and `avatarUrl` and every custom property for the specified user. For every client owned by the user, it will also clear `displayName`, `avatarUrl` and any channel specific information stored in the info and raw fields. Calling this API doesn’t delete the user’s conversation history. To fully delete the user, see [Delete User](#operation/DeleteUser).

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

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

    the optional parameters

Returns:



168
169
170
171
 
# File 'lib/sunshine-conversations-client/api/users_api.rb', line 168

def delete_user_personal_information(app_id, user_id_or_external_id, opts = {})
  data, _status_code, _headers = delete_user_personal_information_with_http_info(app_id, user_id_or_external_id, opts)
  data
end

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

Delete User Personal Information Delete a user’s personal information. Calling this API will clear &#x60;givenName&#x60;, &#x60;surname&#x60;, &#x60;email&#x60; and &#x60;avatarUrl&#x60; and every custom property for the specified user. For every client owned by the user, it will also clear &#x60;displayName&#x60;, &#x60;avatarUrl&#x60; and any channel specific information stored in the info and raw fields. Calling this API doesn’t delete the user’s conversation history. To fully delete the user, see [Delete User](#operation/DeleteUser).

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

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

    the optional parameters

Returns:

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

    UserResponse data, response status code and response headers



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

def delete_user_personal_information_with_http_info(app_id, user_id_or_external_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.delete_user_personal_information ...'
  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_personal_information"
  end
  # verify the required parameter 'user_id_or_external_id' is set
  if @api_client.config.client_side_validation && user_id_or_external_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id_or_external_id' when calling UsersApi.delete_user_personal_information"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/users/{userIdOrExternalId}/personalinformation'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'userIdOrExternalId' + '}', CGI.escape(user_id_or_external_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']) unless header_params['Accept']

  # 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] || ['basicAuth', 'bearerAuth']

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

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

Delete User Delete a user, its clients and its conversation history. The user is considered completely deleted once the &#x60;user:delete&#x60; webhook is fired. To only delete a user’s personal information, see [Delete User Personal Information](#operation/DeleteUserPersonalInformation).

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
 
# File 'lib/sunshine-conversations-client/api/users_api.rb', line 110

def delete_user_with_http_info(app_id, user_id_or_external_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_or_external_id' is set
  if @api_client.config.client_side_validation && user_id_or_external_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id_or_external_id' when calling UsersApi.delete_user"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/users/{userIdOrExternalId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'userIdOrExternalId' + '}', CGI.escape(user_id_or_external_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', '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_or_external_id, opts = {}) ⇒ UserResponse

Get User Fetches an individual user.

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

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

    the optional parameters

Returns:



237
238
239
240
 
# File 'lib/sunshine-conversations-client/api/users_api.rb', line 237

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

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

Get User Fetches an individual user.

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

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

    the optional parameters

Returns:

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

    UserResponse data, response status code and response headers



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

def get_user_with_http_info(app_id, user_id_or_external_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_or_external_id' is set
  if @api_client.config.client_side_validation && user_id_or_external_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id_or_external_id' when calling UsersApi.get_user"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/users/{userIdOrExternalId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'userIdOrExternalId' + '}', CGI.escape(user_id_or_external_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']) unless header_params['Accept']

  # 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] || ['basicAuth', '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

#sync_user(app_id, zendesk_id, opts = {}) ⇒ UserResponse

Synchronize User Synchronize a messaging user with its core Zendesk user counterpart. Messaging users are separate objects linked to a core Zendesk user record by ‘zendeskId`. It is possible for changes to be made to the core Zendesk user record in a way that causes the messaging user to fall out of sync. The core Zendesk user might have their primary email changed, for example. This endpoint can be used to update the messaging user with the `profile.givenName`, `profile.surname`, `externalId`, and primary email identity of its core Zendesk user counterpart.<br/><br/>It is also possible for two Zendesk users to be merged. In such a case, this API can be used to apply that merger on the messaging side. The surviving Zendesk user id can be specified via the `survivingZendeskId` parameter of the request body, and the outgoing `zendeskId` is specified in the request path. <aside class="notice"><strong>Note:</strong> Only the primary email identity of the core Zendesk user will be synchronized, and it will be set on the identities array, not in the profile.</aside> <br/> <aside class="notice"><strong>Note:</strong> In some circumstances, a single call to this API might produce changes on more than one messaging user. If the externalId or email being synchronized already exists on a different messaging user within the account, the conflict will be resolved by merging those messaging users together, if possible. If a conflicting messaging user is already linked to a core Zendesk user by zendeskId it cannot be merged. In this case, the conflicting externalId or email will instead be removed and reassigned to the messaging user that is being synchronized.</aside>

Parameters:

  • app_id (String) —

    Identifies the app.

  • zendesk_id (String) —

    The ID that links a messaging user to its core Zendesk user counterpart. This ID can be used to fetch the core user record via the Zendesk Support API.

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

    the optional parameters

Options Hash (opts):

Returns:



307
308
309
310
 
# File 'lib/sunshine-conversations-client/api/users_api.rb', line 307

def sync_user(app_id, zendesk_id, opts = {})
  data, _status_code, _headers = sync_user_with_http_info(app_id, zendesk_id, opts)
  data
end

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

Synchronize User Synchronize a messaging user with its core Zendesk user counterpart. Messaging users are separate objects linked to a core Zendesk user record by &#x60;zendeskId&#x60;. It is possible for changes to be made to the core Zendesk user record in a way that causes the messaging user to fall out of sync. The core Zendesk user might have their primary email changed, for example. This endpoint can be used to update the messaging user with the &#x60;profile.givenName&#x60;, &#x60;profile.surname&#x60;, &#x60;externalId&#x60;, and primary email identity of its core Zendesk user counterpart.&lt;br/&gt;&lt;br/&gt;It is also possible for two Zendesk users to be merged. In such a case, this API can be used to apply that merger on the messaging side. The surviving Zendesk user id can be specified via the &#x60;survivingZendeskId&#x60; parameter of the request body, and the outgoing &#x60;zendeskId&#x60; is specified in the request path. &lt;aside class&#x3D;&quot;notice&quot;&gt;&lt;strong&gt;Note:&lt;/strong&gt; Only the primary email identity of the core Zendesk user will be synchronized, and it will be set on the identities array, not in the profile.&lt;/aside&gt; &lt;br/&gt; &lt;aside class&#x3D;&quot;notice&quot;&gt;&lt;strong&gt;Note:&lt;/strong&gt; In some circumstances, a single call to this API might produce changes on more than one messaging user. If the externalId or email being synchronized already exists on a different messaging user within the account, the conflict will be resolved by merging those messaging users together, if possible. If a conflicting messaging user is already linked to a core Zendesk user by zendeskId it cannot be merged. In this case, the conflicting externalId or email will instead be removed and reassigned to the messaging user that is being synchronized.&lt;/aside&gt;

Parameters:

  • app_id (String) —

    Identifies the app.

  • zendesk_id (String) —

    The ID that links a messaging user to its core Zendesk user counterpart. This ID can be used to fetch the core user record via the Zendesk Support API.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    UserResponse data, response status code and response headers



319
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
371
372
373
374
 
# File 'lib/sunshine-conversations-client/api/users_api.rb', line 319

def sync_user_with_http_info(app_id, zendesk_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.sync_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.sync_user"
  end
  # verify the required parameter 'zendesk_id' is set
  if @api_client.config.client_side_validation && zendesk_id.nil?
    fail ArgumentError, "Missing the required parameter 'zendesk_id' when calling UsersApi.sync_user"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/users/{zendeskId}/sync'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'zendeskId' + '}', CGI.escape(zendesk_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']) unless header_params['Accept']
  # 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(opts[:'sync_user_body'])

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

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

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

#update_user(app_id, user_id_or_external_id, user_update_body, opts = {}) ⇒ UserResponse

Update User Updates a user.

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

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

    the optional parameters

Returns:



383
384
385
386
 
# File 'lib/sunshine-conversations-client/api/users_api.rb', line 383

def update_user(app_id, user_id_or_external_id, user_update_body, opts = {})
  data, _status_code, _headers = update_user_with_http_info(app_id, user_id_or_external_id, user_update_body, opts)
  data
end

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

Update User Updates a user.

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

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

    the optional parameters

Returns:

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

    UserResponse data, response status code and response headers



395
396
397
398
399
400
401
402
403
404
405
406
407
408
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
 
# File 'lib/sunshine-conversations-client/api/users_api.rb', line 395

def update_user_with_http_info(app_id, user_id_or_external_id, user_update_body, 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_or_external_id' is set
  if @api_client.config.client_side_validation && user_id_or_external_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id_or_external_id' when calling UsersApi.update_user"
  end
  # verify the required parameter 'user_update_body' is set
  if @api_client.config.client_side_validation && user_update_body.nil?
    fail ArgumentError, "Missing the required parameter 'user_update_body' when calling UsersApi.update_user"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/users/{userIdOrExternalId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'userIdOrExternalId' + '}', CGI.escape(user_id_or_external_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']) unless header_params['Accept']
  # 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(user_update_body)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', '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