Class: DocuSign_Admin::UsersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = UsersApi.default) ⇒ UsersApi

Returns a new instance of UsersApi.



89
90
91
 
# File 'lib/docusign_admin/api/users_api.rb', line 89

def initialize(api_client = UsersApi.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



87
88
89
 
# File 'lib/docusign_admin/api/users_api.rb', line 87

def api_client
  @api_client
end

Instance Method Details

#activate_membership(organization_id, user_id, membership_id, request) ⇒ UpdateResponse

Activates user memberships Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID Guid

  • user_id —

    The user ID Guid

  • membership_id —

    The membership ID Guid

  • request —

    Additional details about the user’s membership

Returns:



100
101
102
103
 
# File 'lib/docusign_admin/api/users_api.rb', line 100

def activate_membership(organization_id, user_id, membership_id, request)
  data, _status_code, _headers = activate_membership_with_http_info(organization_id, user_id, membership_id,  request)
  return data
end

#activate_membership_with_http_info(organization_id, user_id, membership_id, request) ⇒ Array<(UpdateResponse, Fixnum, Hash)>

Activates user memberships Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID Guid

  • user_id —

    The user ID Guid

  • membership_id —

    The membership ID Guid

  • request —

    Additional details about the user’s membership

Returns:

  • (Array<(UpdateResponse, Fixnum, Hash)>) —

    UpdateResponse data, response status code and response headers



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
 
# File 'lib/docusign_admin/api/users_api.rb', line 112

def activate_membership_with_http_info(organization_id, user_id, membership_id, request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.activate_membership ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.activate_membership" if organization_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.activate_membership" if user_id.nil?
  # verify the required parameter 'membership_id' is set
  fail ArgumentError, "Missing the required parameter 'membership_id' when calling UsersApi.activate_membership" if membership_id.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling UsersApi.activate_membership" if request.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/users/{userId}/memberships/{membershipId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'membershipId' + '}', membership_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  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 => 'UpdateResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#activate_membership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_or_update_user(organization_id, account_id, request) ⇒ AddUserResponse

Creates and updates a multi-product user Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • request —

    The request object

Returns:



162
163
164
165
 
# File 'lib/docusign_admin/api/users_api.rb', line 162

def add_or_update_user(organization_id, , request)
  data, _status_code, _headers = add_or_update_user_with_http_info(organization_id, ,  request)
  return data
end

#add_or_update_user_with_http_info(organization_id, account_id, request) ⇒ Array<(AddUserResponse, Fixnum, Hash)>

Creates and updates a multi-product user Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID GUID

  • account_id —

    The account ID GUID

  • request —

    The request object

Returns:

  • (Array<(AddUserResponse, Fixnum, Hash)>) —

    AddUserResponse data, response status code and response headers



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
211
212
213
 
# File 'lib/docusign_admin/api/users_api.rb', line 173

def add_or_update_user_with_http_info(organization_id, , request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.add_or_update_user ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.add_or_update_user" if organization_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.add_or_update_user" if .nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling UsersApi.add_or_update_user" if request.nil?
  # resource path
  local_var_path = "/v2.1/organizations/{organizationId}/accounts/{accountId}/users".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  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 => 'AddUserResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#add_or_update_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_users(organization_id, account_id, request) ⇒ NewUserResponse

Adds users to an account. Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID Guid

  • account_id —

    The account ID Guid

  • request —

    The details for the users to add to the account

Returns:



221
222
223
224
 
# File 'lib/docusign_admin/api/users_api.rb', line 221

def add_users(organization_id, , request)
  data, _status_code, _headers = add_users_with_http_info(organization_id, ,  request)
  return data
end

#add_users_with_http_info(organization_id, account_id, request) ⇒ Array<(NewUserResponse, Fixnum, Hash)>

Adds users to an account. Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID Guid

  • account_id —

    The account ID Guid

  • request —

    The details for the users to add to the account

Returns:

  • (Array<(NewUserResponse, Fixnum, Hash)>) —

    NewUserResponse data, response status code and response headers



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
 
# File 'lib/docusign_admin/api/users_api.rb', line 232

def add_users_with_http_info(organization_id, , request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.add_users ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.add_users" if organization_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.add_users" if .nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling UsersApi.add_users" if request.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/accounts/{accountId}/users".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  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 => 'NewUserResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#add_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#close_memberships(organization_id, user_id, request) ⇒ DeleteMembershipsResponse

Closes a user’s memberships. Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID Guid

  • user_id —

    The user ID Guid

  • request —

    The details about which membership to close

Returns:



280
281
282
283
 
# File 'lib/docusign_admin/api/users_api.rb', line 280

def close_memberships(organization_id, user_id, request)
  data, _status_code, _headers = close_memberships_with_http_info(organization_id, user_id,  request)
  return data
end

#close_memberships_with_http_info(organization_id, user_id, request) ⇒ Array<(DeleteMembershipsResponse, Fixnum, Hash)>

Closes a user&#39;s memberships. Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID Guid

  • user_id —

    The user ID Guid

  • request —

    The details about which membership to close

Returns:

  • (Array<(DeleteMembershipsResponse, Fixnum, Hash)>) —

    DeleteMembershipsResponse data, response status code and response headers



291
292
293
294
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
 
# File 'lib/docusign_admin/api/users_api.rb', line 291

def close_memberships_with_http_info(organization_id, user_id, request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.close_memberships ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.close_memberships" if organization_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.close_memberships" if user_id.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling UsersApi.close_memberships" if request.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/users/{userId}/accounts".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  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 => 'DeleteMembershipsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#close_memberships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_user(organization_id, request) ⇒ NewUserResponse

Creates a new user Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID Guid

  • request —

    Details about the user to be added

Returns:



338
339
340
341
 
# File 'lib/docusign_admin/api/users_api.rb', line 338

def create_user(organization_id, request)
  data, _status_code, _headers = create_user_with_http_info(organization_id,  request)
  return data
end

#create_user_with_http_info(organization_id, request) ⇒ Array<(NewUserResponse, Fixnum, Hash)>

Creates a new user Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID Guid

  • request —

    Details about the user to be added

Returns:

  • (Array<(NewUserResponse, Fixnum, Hash)>) —

    NewUserResponse data, response status code and response headers



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
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/docusign_admin/api/users_api.rb', line 348

def create_user_with_http_info(organization_id, request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.create_user ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.create_user" if organization_id.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling UsersApi.create_user" if request.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/users".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  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 => 'NewUserResponse')
  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_identities(organization_id, user_id, request_model) ⇒ DeleteResponse

Deletes user identities. Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID Guid

  • user_id —

    The user ID Guid

  • request_model —

    The details for the user identities to be deleted

Returns:



394
395
396
397
 
# File 'lib/docusign_admin/api/users_api.rb', line 394

def delete_identities(organization_id, user_id, request_model)
  data, _status_code, _headers = delete_identities_with_http_info(organization_id, user_id,  request_model)
  return data
end

#delete_identities_with_http_info(organization_id, user_id, request_model) ⇒ Array<(DeleteResponse, Fixnum, Hash)>

Deletes user identities. Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID Guid

  • user_id —

    The user ID Guid

  • request_model —

    The details for the user identities to be deleted

Returns:

  • (Array<(DeleteResponse, Fixnum, Hash)>) —

    DeleteResponse data, response status code and response headers



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
 
# File 'lib/docusign_admin/api/users_api.rb', line 405

def delete_identities_with_http_info(organization_id, user_id, request_model)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.delete_identities ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.delete_identities" if organization_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_identities" if user_id.nil?
  # verify the required parameter 'request_model' is set
  fail ArgumentError, "Missing the required parameter 'request_model' when calling UsersApi.delete_identities" if request_model.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/users/{userId}/identities".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_model)
  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 => 'DeleteResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#delete_identities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_ds_profile(organization_id, user_id, options = DocuSign_Admin::GetUserDSProfileOptions.default) ⇒ UsersDrilldownResponse

Returns user information using the userId for lookup. Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

  • user_id —

    The user ID Guid

  • DocuSign_Admin::GetUserDSProfileOptions —

    Options for modifying the behavior of the function.

Returns:



453
454
455
456
 
# File 'lib/docusign_admin/api/users_api.rb', line 453

def get_user_ds_profile(organization_id, user_id, options = DocuSign_Admin::GetUserDSProfileOptions.default)
  data, _status_code, _headers = get_user_ds_profile_with_http_info(organization_id, user_id, options)
  return data
end

#get_user_ds_profile_with_http_info(organization_id, user_id, options = DocuSign_Admin::GetUserDSProfileOptions.default) ⇒ Array<(UsersDrilldownResponse, Fixnum, Hash)>

Returns user information using the userId for lookup. Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

  • user_id —

    The user ID Guid

  • DocuSign_Admin::GetUserDSProfileOptions —

    Options for modifying the behavior of the function.

Returns:

  • (Array<(UsersDrilldownResponse, Fixnum, Hash)>) —

    UsersDrilldownResponse data, response status code and response headers



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/docusign_admin/api/users_api.rb', line 464

def get_user_ds_profile_with_http_info(organization_id, user_id, options = DocuSign_Admin::GetUserDSProfileOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_user_ds_profile ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.get_user_ds_profile" if organization_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_ds_profile" if user_id.nil?
  # resource path
  local_var_path = "/v2.1/organizations/{organizationId}/users/{userId}/dsprofile".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'sort'] = options.sort if !options.sort.nil?

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  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 => 'UsersDrilldownResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_user_ds_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_ds_profiles_by_email(organization_id, options = DocuSign_Admin::GetUserDSProfilesByEmailOptions.default) ⇒ UsersDrilldownResponse

Returns DS user profile information. Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

  • DocuSign_Admin::GetUserDSProfilesByEmailOptions —

    Options for modifying the behavior of the function.

Returns:



510
511
512
513
 
# File 'lib/docusign_admin/api/users_api.rb', line 510

def get_user_ds_profiles_by_email(organization_id, options = DocuSign_Admin::GetUserDSProfilesByEmailOptions.default)
  data, _status_code, _headers = get_user_ds_profiles_by_email_with_http_info(organization_id, options)
  return data
end

#get_user_ds_profiles_by_email_with_http_info(organization_id, options = DocuSign_Admin::GetUserDSProfilesByEmailOptions.default) ⇒ Array<(UsersDrilldownResponse, Fixnum, Hash)>

Returns DS user profile information. Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

  • DocuSign_Admin::GetUserDSProfilesByEmailOptions —

    Options for modifying the behavior of the function.

Returns:

  • (Array<(UsersDrilldownResponse, Fixnum, Hash)>) —

    UsersDrilldownResponse data, response status code and response headers



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
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/docusign_admin/api/users_api.rb', line 520

def get_user_ds_profiles_by_email_with_http_info(organization_id, options = DocuSign_Admin::GetUserDSProfilesByEmailOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_user_ds_profiles_by_email ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.get_user_ds_profiles_by_email" if organization_id.nil?
  # resource path
  local_var_path = "/v2.1/organizations/{organizationId}/users/dsprofile".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'email'] = options.email if !options.email.nil?
  query_params[:'sort'] = options.sort if !options.sort.nil?

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  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 => 'UsersDrilldownResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_user_ds_profiles_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_profiles(organization_id, options = DocuSign_Admin::GetUserProfilesOptions.default) ⇒ UsersDrilldownResponse

Returns user information. Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

  • DocuSign_Admin::GetUserProfilesOptions —

    Options for modifying the behavior of the function.

Returns:



565
566
567
568
 
# File 'lib/docusign_admin/api/users_api.rb', line 565

def get_user_profiles(organization_id, options = DocuSign_Admin::GetUserProfilesOptions.default)
  data, _status_code, _headers = get_user_profiles_with_http_info(organization_id, options)
  return data
end

#get_user_profiles_with_http_info(organization_id, options = DocuSign_Admin::GetUserProfilesOptions.default) ⇒ Array<(UsersDrilldownResponse, Fixnum, Hash)>

Returns user information. Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

  • DocuSign_Admin::GetUserProfilesOptions —

    Options for modifying the behavior of the function.

Returns:

  • (Array<(UsersDrilldownResponse, Fixnum, Hash)>) —

    UsersDrilldownResponse data, response status code and response headers



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
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/docusign_admin/api/users_api.rb', line 575

def get_user_profiles_with_http_info(organization_id, options = DocuSign_Admin::GetUserProfilesOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_user_profiles ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.get_user_profiles" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/users/profile".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'email'] = options.email if !options.email.nil?

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  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 => 'UsersDrilldownResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_user_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_users(organization_id, options = DocuSign_Admin::GetUsersOptions.default) ⇒ OrganizationUsersResponse

Returns information about the users in the organization Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

  • DocuSign_Admin::GetUsersOptions —

    Options for modifying the behavior of the function.

Returns:



619
620
621
622
 
# File 'lib/docusign_admin/api/users_api.rb', line 619

def get_users(organization_id, options = DocuSign_Admin::GetUsersOptions.default)
  data, _status_code, _headers = get_users_with_http_info(organization_id, options)
  return data
end

#get_users_with_http_info(organization_id, options = DocuSign_Admin::GetUsersOptions.default) ⇒ Array<(OrganizationUsersResponse, Fixnum, Hash)>

Returns information about the users in the organization Required scopes: user_read

Parameters:

  • organization_id —

    The organization ID Guid

  • DocuSign_Admin::GetUsersOptions —

    Options for modifying the behavior of the function.

Returns:

  • (Array<(OrganizationUsersResponse, Fixnum, Hash)>) —

    OrganizationUsersResponse data, response status code and response headers



629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/docusign_admin/api/users_api.rb', line 629

def get_users_with_http_info(organization_id, options = DocuSign_Admin::GetUsersOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_users ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.get_users" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/users".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'start'] = options.start if !options.start.nil?
  query_params[:'take'] = options.take if !options.take.nil?
  query_params[:'end'] = options._end if !options._end.nil?
  query_params[:'email'] = options.email if !options.email.nil?
  query_params[:'email_user_name_like'] = options.email_user_name_like if !options.email_user_name_like.nil?
  query_params[:'status'] = options.status if !options.status.nil?
  query_params[:'membership_status'] = options.membership_status if !options.membership_status.nil?
  query_params[:'account_id'] = options. if !options..nil?
  query_params[:'organization_reserved_domain_id'] = options.organization_reserved_domain_id if !options.organization_reserved_domain_id.nil?
  query_params[:'last_modified_since'] = options.last_modified_since if !options.last_modified_since.nil?
  query_params[:'include_ds_groups'] = options.include_ds_groups if !options.include_ds_groups.nil?

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  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 => 'OrganizationUsersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_address(organization_id, request) ⇒ UsersUpdateResponse

Updates a user’s email address. Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID Guid

  • request —

    The details about which email addresses to update

Returns:



683
684
685
686
 
# File 'lib/docusign_admin/api/users_api.rb', line 683

def update_email_address(organization_id, request)
  data, _status_code, _headers = update_email_address_with_http_info(organization_id,  request)
  return data
end

#update_email_address_with_http_info(organization_id, request) ⇒ Array<(UsersUpdateResponse, Fixnum, Hash)>

Updates a user&#39;s email address. Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID Guid

  • request —

    The details about which email addresses to update

Returns:

  • (Array<(UsersUpdateResponse, Fixnum, Hash)>) —

    UsersUpdateResponse data, response status code and response headers



693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
 
# File 'lib/docusign_admin/api/users_api.rb', line 693

def update_email_address_with_http_info(organization_id, request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.update_email_address ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.update_email_address" if organization_id.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling UsersApi.update_email_address" if request.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/users/email_addresses".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  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 => 'UsersUpdateResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_email_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_user(organization_id, request) ⇒ UsersUpdateResponse

Updates a user. Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID Guid

  • request —

    The user details to update

Returns:



738
739
740
741
 
# File 'lib/docusign_admin/api/users_api.rb', line 738

def update_user(organization_id, request)
  data, _status_code, _headers = update_user_with_http_info(organization_id,  request)
  return data
end

#update_user_with_http_info(organization_id, request) ⇒ Array<(UsersUpdateResponse, Fixnum, Hash)>

Updates a user. Required scopes: user_write

Parameters:

  • organization_id —

    The organization ID Guid

  • request —

    The user details to update

Returns:

  • (Array<(UsersUpdateResponse, Fixnum, Hash)>) —

    UsersUpdateResponse data, response status code and response headers



748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
 
# File 'lib/docusign_admin/api/users_api.rb', line 748

def update_user_with_http_info(organization_id, request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.update_user ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling UsersApi.update_user" if organization_id.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling UsersApi.update_user" if request.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/users/profiles".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  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 => 'UsersUpdateResponse')
  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