Class: DocuSign_eSign::UsersApi

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



113
114
115
 
# File 'lib/docusign_esign/api/users_api.rb', line 113

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



111
112
113
 
# File 'lib/docusign_esign/api/users_api.rb', line 111

def api_client
  @api_client
end

Instance Method Details

#create(account_id, new_users_definition) ⇒ NewUsersSummary

Adds news user to the specified account. Adds new users to your account. Set the ‘userSettings` property in the request to specify the actions the users can perform on the account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • new_users_definition (optional parameter)

Returns:



122
123
124
125
 
# File 'lib/docusign_esign/api/users_api.rb', line 122

def create(, new_users_definition)
  data, _status_code, _headers = create_with_http_info(,  new_users_definition)
  return data
end

#create_signatures(account_id, user_id, user_signatures_information) ⇒ UserSignaturesInformation

Adds user Signature and initials images to a Signature. Adds a user signature image and/or user initials image to the specified user. The userId property specified in the endpoint must match the authenticated user’s userId and the user must be a member of the account. The rules and processes associated with this are: * If Content-Type is set to application/json, then the default behavior for creating a default signature image, based on the name and a DocuSign font, is used. * If Content-Type is set to multipart/form-data, then the request must contain a first part with the user signature information, followed by parts that contain the images. For each Image part, the Content-Disposition header has a "filename" value that is used to map to the ‘signatureName` and/or `signatureInitials` properties in the JSON to the image. For example: `Content-Disposition: file; filename="Ron Test20121127083900"` If no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call. The Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary. If successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • user_signatures_information (optional parameter)

Returns:



174
175
176
177
 
# File 'lib/docusign_esign/api/users_api.rb', line 174

def create_signatures(, user_id, user_signatures_information)
  data, _status_code, _headers = create_signatures_with_http_info(, user_id,  user_signatures_information)
  return data
end

#create_signatures_with_http_info(account_id, user_id, user_signatures_information) ⇒ Array<(UserSignaturesInformation, Fixnum, Hash)>

Adds user Signature and initials images to a Signature. Adds a user signature image and/or user initials image to the specified user. The userId property specified in the endpoint must match the authenticated user&#39;s userId and the user must be a member of the account. The rules and processes associated with this are: * If Content-Type is set to application/json, then the default behavior for creating a default signature image, based on the name and a DocuSign font, is used. * If Content-Type is set to multipart/form-data, then the request must contain a first part with the user signature information, followed by parts that contain the images. For each Image part, the Content-Disposition header has a &quot;filename&quot; value that is used to map to the &#x60;signatureName&#x60; and/or &#x60;signatureInitials&#x60; properties in the JSON to the image. For example: &#x60;Content-Disposition: file; filename&#x3D;&quot;Ron Test20121127083900&quot;&#x60; If no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call. The Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary. If successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • user_signatures_information (optional parameter)

Returns:

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

    UserSignaturesInformation data, response status code and response headers



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

def create_signatures_with_http_info(, user_id, user_signatures_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.create_signatures ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.create_signatures" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.create_signatures" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures".sub('{format}','json').sub('{' + 'accountId' + '}', .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'])

  # form parameters
  form_params = {}

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

#create_with_http_info(account_id, new_users_definition) ⇒ Array<(NewUsersSummary, Fixnum, Hash)>

Adds news user to the specified account. Adds new users to your account. Set the &#x60;userSettings&#x60; property in the request to specify the actions the users can perform on the account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • new_users_definition (optional parameter)

Returns:

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

    NewUsersSummary data, response status code and response headers



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
164
165
166
 
# File 'lib/docusign_esign/api/users_api.rb', line 132

def create_with_http_info(, new_users_definition)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.create ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.create" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users".sub('{format}','json').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'])

  # form parameters
  form_params = {}

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

#delete(account_id, user_info_list, options = DocuSign_eSign::DeleteOptions.default) ⇒ UsersResponse

Removes users account privileges. This closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions. The response returns whether the API execution was successful (200 - OK) or if it failed. The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, the response for that user contains an ‘errorDetails` node with `errorCode` and `message` properties.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_info_list (optional parameter)
  • DocuSign_eSign::DeleteOptions —

    Options for modifying the behavior of the function.

Returns:



229
230
231
232
 
# File 'lib/docusign_esign/api/users_api.rb', line 229

def delete(, , options = DocuSign_eSign::DeleteOptions.default)
  data, _status_code, _headers = delete_with_http_info(,  , options)
  return data
end

#delete_contact_with_id(account_id, contact_id) ⇒ ContactUpdateResponse

Replaces a particular contact associated with an account for the DocuSign service.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • contact_id —

    The unique identifier of a person in the contacts address book.

Returns:



282
283
284
285
 
# File 'lib/docusign_esign/api/users_api.rb', line 282

def delete_contact_with_id(, contact_id)
  data, _status_code, _headers = delete_contact_with_id_with_http_info(, contact_id)
  return data
end

#delete_contact_with_id_with_http_info(account_id, contact_id) ⇒ Array<(ContactUpdateResponse, Fixnum, Hash)>

Replaces a particular contact associated with an account for the DocuSign service.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • contact_id —

    The unique identifier of a person in the contacts address book.

Returns:

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

    ContactUpdateResponse data, response status code and response headers



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

def delete_contact_with_id_with_http_info(, contact_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.delete_contact_with_id ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.delete_contact_with_id" if .nil?
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling UsersApi.delete_contact_with_id" if contact_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'contactId' + '}', contact_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'])

  # form parameters
  form_params = {}

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

#delete_contacts(account_id, contact_mod_request) ⇒ ContactUpdateResponse

Delete contacts associated with an account for the DocuSign service.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • contact_mod_request (optional parameter)

Returns:



335
336
337
338
 
# File 'lib/docusign_esign/api/users_api.rb', line 335

def delete_contacts(, contact_mod_request)
  data, _status_code, _headers = delete_contacts_with_http_info(,  contact_mod_request)
  return data
end

#delete_contacts_with_http_info(account_id, contact_mod_request) ⇒ Array<(ContactUpdateResponse, Fixnum, Hash)>

Delete contacts associated with an account for the DocuSign service.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • contact_mod_request (optional parameter)

Returns:

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

    ContactUpdateResponse data, response status code and response headers



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
375
376
377
378
379
 
# File 'lib/docusign_esign/api/users_api.rb', line 345

def delete_contacts_with_http_info(, contact_mod_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.delete_contacts ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.delete_contacts" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/contacts".sub('{format}','json').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'])

  # form parameters
  form_params = {}

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

#delete_custom_settings(account_id, user_id, custom_settings_information) ⇒ CustomSettingsInformation

Deletes custom user settings for a specified user. Deletes the specified custom user settings for a single user. ###Deleting Grouped Custom User Settings### If the custom user settings you want to delete are grouped, you must include the following information in the header, after Content-Type, in the request: ‘X-DocuSign-User-Settings-Key:group_name` Where the `group_name` is your designated name for the group of customer user settings. If the extra header information is not included, only the custom user settings that were added without a group are deleted.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • custom_settings_information (optional parameter)

Returns:



387
388
389
390
 
# File 'lib/docusign_esign/api/users_api.rb', line 387

def delete_custom_settings(, user_id, custom_settings_information)
  data, _status_code, _headers = delete_custom_settings_with_http_info(, user_id,  custom_settings_information)
  return data
end

#delete_custom_settings_with_http_info(account_id, user_id, custom_settings_information) ⇒ Array<(CustomSettingsInformation, Fixnum, Hash)>

Deletes custom user settings for a specified user. Deletes the specified custom user settings for a single user. ###Deleting Grouped Custom User Settings### If the custom user settings you want to delete are grouped, you must include the following information in the header, after Content-Type, in the request: &#x60;X-DocuSign-User-Settings-Key:group_name&#x60; Where the &#x60;group_name&#x60; is your designated name for the group of customer user settings. If the extra header information is not included, only the custom user settings that were added without a group are deleted.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • custom_settings_information (optional parameter)

Returns:

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

    CustomSettingsInformation data, response status code and response headers



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

def delete_custom_settings_with_http_info(, user_id, custom_settings_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.delete_custom_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.delete_custom_settings" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_custom_settings" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/custom_settings".sub('{format}','json').sub('{' + 'accountId' + '}', .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'])

  # form parameters
  form_params = {}

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

#delete_profile_image(account_id, user_id) ⇒ nil

Deletes the user profile image for the specified user. Deletes the user profile image from the specified user’s profile. The userId parameter specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the specified account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

  • (nil) 


441
442
443
444
 
# File 'lib/docusign_esign/api/users_api.rb', line 441

def delete_profile_image(, user_id)
  delete_profile_image_with_http_info(, user_id)
  return nil
end

#delete_profile_image_with_http_info(account_id, user_id) ⇒ Array<(nil, Fixnum, Hash)>

Deletes the user profile image for the specified user. Deletes the user profile image from the specified user&#39;s profile. The userId parameter specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the specified account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

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

    nil, response status code and response headers



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/docusign_esign/api/users_api.rb', line 451

def delete_profile_image_with_http_info(, user_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.delete_profile_image ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.delete_profile_image" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_profile_image" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/profile/image".sub('{format}','json').sub('{' + 'accountId' + '}', .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'])

  # form parameters
  form_params = {}

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

#delete_signature(account_id, signature_id, user_id) ⇒ nil

Removes removes signature information for the specified user. Removes the signature information for the user. The userId parameter specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account. The ‘signatureId` accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith".

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • signature_id —

    The ID of the signature being accessed.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

  • (nil) 


494
495
496
497
 
# File 'lib/docusign_esign/api/users_api.rb', line 494

def delete_signature(, signature_id, user_id)
  delete_signature_with_http_info(, signature_id, user_id)
  return nil
end

#delete_signature_image(account_id, image_type, signature_id, user_id) ⇒ UserSignature

Deletes the user initials image or the user signature image for the specified user. Deletes the specified initials image or signature image for the specified user. The function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice. The userId parameter specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account. The ‘signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith".

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • image_type —

    One of signature_image or initials_image.

  • signature_id —

    The ID of the signature being accessed.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:



551
552
553
554
 
# File 'lib/docusign_esign/api/users_api.rb', line 551

def delete_signature_image(, image_type, signature_id, user_id)
  data, _status_code, _headers = delete_signature_image_with_http_info(, image_type, signature_id, user_id)
  return data
end

#delete_signature_image_with_http_info(account_id, image_type, signature_id, user_id) ⇒ Array<(UserSignature, Fixnum, Hash)>

Deletes the user initials image or the user signature image for the specified user. Deletes the specified initials image or signature image for the specified user. The function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice. The userId parameter specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the account. The &#x60;signatureId&#x60; parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode &quot;Bob Smith&quot; as &quot;Bob%20Smith&quot;.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • image_type —

    One of signature_image or initials_image.

  • signature_id —

    The ID of the signature being accessed.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

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

    UserSignature data, response status code and response headers



563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/docusign_esign/api/users_api.rb', line 563

def delete_signature_image_with_http_info(, image_type, signature_id, user_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.delete_signature_image ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.delete_signature_image" if .nil?
  # verify the required parameter 'image_type' is set
  fail ArgumentError, "Missing the required parameter 'image_type' when calling UsersApi.delete_signature_image" if image_type.nil?
  # verify the required parameter 'signature_id' is set
  fail ArgumentError, "Missing the required parameter 'signature_id' when calling UsersApi.delete_signature_image" if signature_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_signature_image" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'imageType' + '}', image_type.to_s).sub('{' + 'signatureId' + '}', signature_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'])

  # form parameters
  form_params = {}

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

#delete_signature_with_http_info(account_id, signature_id, user_id) ⇒ Array<(nil, Fixnum, Hash)>

Removes removes signature information for the specified user. Removes the signature information for the user. The userId parameter specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the account. The &#x60;signatureId&#x60; accepts a signature ID or a signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode &quot;Bob Smith&quot; as &quot;Bob%20Smith&quot;.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • signature_id —

    The ID of the signature being accessed.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

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

    nil, response status code and response headers



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

def delete_signature_with_http_info(, signature_id, user_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.delete_signature ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.delete_signature" if .nil?
  # verify the required parameter 'signature_id' is set
  fail ArgumentError, "Missing the required parameter 'signature_id' when calling UsersApi.delete_signature" if signature_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_signature" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'signatureId' + '}', signature_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'])

  # form parameters
  form_params = {}

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

#delete_with_http_info(account_id, user_info_list, options = DocuSign_eSign::DeleteOptions.default) ⇒ Array<(UsersResponse, Fixnum, Hash)>

Removes users account privileges. This closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions. The response returns whether the API execution was successful (200 - OK) or if it failed. The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, the response for that user contains an &#x60;errorDetails&#x60; node with &#x60;errorCode&#x60; and &#x60;message&#x60; properties.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_info_list (optional parameter)
  • DocuSign_eSign::DeleteOptions —

    Options for modifying the behavior of the function.

Returns:

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

    UsersResponse data, response status code and response headers



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/docusign_esign/api/users_api.rb', line 240

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

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

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

#get_contact_by_id(account_id, contact_id) ⇒ ContactGetResponse

Gets a particular contact associated with the user’s account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • contact_id —

    The unique identifier of a person in the contacts address book.

Returns:



610
611
612
613
 
# File 'lib/docusign_esign/api/users_api.rb', line 610

def get_contact_by_id(, contact_id)
  data, _status_code, _headers = get_contact_by_id_with_http_info(, contact_id)
  return data
end

#get_contact_by_id_with_http_info(account_id, contact_id) ⇒ Array<(ContactGetResponse, Fixnum, Hash)>

Gets a particular contact associated with the user&#39;s account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • contact_id —

    The unique identifier of a person in the contacts address book.

Returns:

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

    ContactGetResponse data, response status code and response headers



620
621
622
623
624
625
626
627
628
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
 
# File 'lib/docusign_esign/api/users_api.rb', line 620

def get_contact_by_id_with_http_info(, contact_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_contact_by_id ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_contact_by_id" if .nil?
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling UsersApi.get_contact_by_id" if contact_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'contactId' + '}', contact_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'])

  # 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 => 'ContactGetResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_contact_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_information(account_id, user_id, options = DocuSign_eSign::GetInformationOptions.default) ⇒ UserInformation

Gets the user information for a specified user. Retrieves the user information for the specified user. To return additional user information that details the last login date, login status, and the user’s password expiration date, set the optional ‘additional_info` query string parameter to true.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::GetInformationOptions —

    Options for modifying the behavior of the function.

Returns:



664
665
666
667
 
# File 'lib/docusign_esign/api/users_api.rb', line 664

def get_information(, user_id, options = DocuSign_eSign::GetInformationOptions.default)
  data, _status_code, _headers = get_information_with_http_info(, user_id, options)
  return data
end

#get_information_with_http_info(account_id, user_id, options = DocuSign_eSign::GetInformationOptions.default) ⇒ Array<(UserInformation, Fixnum, Hash)>

Gets the user information for a specified user. Retrieves the user information for the specified user. To return additional user information that details the last login date, login status, and the user&#39;s password expiration date, set the optional &#x60;additional_info&#x60; query string parameter to true.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::GetInformationOptions —

    Options for modifying the behavior of the function.

Returns:

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

    UserInformation data, response status code and response headers



675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
 
# File 'lib/docusign_esign/api/users_api.rb', line 675

def get_information_with_http_info(, user_id, options = DocuSign_eSign::GetInformationOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_information ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_information" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_information" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'additional_info'] = options.additional_info if !options.additional_info.nil?
  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'])

  # 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 => 'UserInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_profile(account_id, user_id) ⇒ UserProfile

Retrieves the user profile for a specified user. Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user. The userId parameter specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the specified account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:



720
721
722
723
 
# File 'lib/docusign_esign/api/users_api.rb', line 720

def get_profile(, user_id)
  data, _status_code, _headers = get_profile_with_http_info(, user_id)
  return data
end

#get_profile_image(account_id, user_id, options = DocuSign_eSign::GetProfileImageOptions.default) ⇒ File

Retrieves the user profile image for the specified user. Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded. The userId parameter specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the specified account. If successful, the response returns a 200 - OK and the user profile image.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::GetProfileImageOptions —

    Options for modifying the behavior of the function.

Returns:

  • (File) 


774
775
776
777
 
# File 'lib/docusign_esign/api/users_api.rb', line 774

def get_profile_image(, user_id, options = DocuSign_eSign::GetProfileImageOptions.default)
  data, _status_code, _headers = get_profile_image_with_http_info(, user_id, options)
  return data
end

#get_profile_image_with_http_info(account_id, user_id, options = DocuSign_eSign::GetProfileImageOptions.default) ⇒ Array<(File, Fixnum, Hash)>

Retrieves the user profile image for the specified user. Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded. The userId parameter specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the specified account. If successful, the response returns a 200 - OK and the user profile image.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::GetProfileImageOptions —

    Options for modifying the behavior of the function.

Returns:

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

    File data, response status code and response headers



785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/docusign_esign/api/users_api.rb', line 785

def get_profile_image_with_http_info(, user_id, options = DocuSign_eSign::GetProfileImageOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_profile_image ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_profile_image" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_profile_image" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/profile/image".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'userId' + '}', user_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['image/gif'])

  # 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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_profile_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_profile_with_http_info(account_id, user_id) ⇒ Array<(UserProfile, Fixnum, Hash)>

Retrieves the user profile for a specified user. Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user. The userId parameter specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the specified account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

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

    UserProfile data, response status code and response headers



730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/docusign_esign/api/users_api.rb', line 730

def get_profile_with_http_info(, user_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_profile ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_profile" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_profile" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/profile".sub('{format}','json').sub('{' + 'accountId' + '}', .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'])

  # 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 => 'UserProfile')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_settings(account_id, user_id) ⇒ UserSettingsInformation

Gets the user account settings for a specified user. Retrieves a list of the account settings and email notification information for the specified user. The response returns the account setting name/value information and the email notification settings for the specified user. For more information about the different user settings, see the [ML:userSettings list].

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:



829
830
831
832
 
# File 'lib/docusign_esign/api/users_api.rb', line 829

def get_settings(, user_id)
  data, _status_code, _headers = get_settings_with_http_info(, user_id)
  return data
end

#get_settings_with_http_info(account_id, user_id) ⇒ Array<(UserSettingsInformation, Fixnum, Hash)>

Gets the user account settings for a specified user. Retrieves a list of the account settings and email notification information for the specified user. The response returns the account setting name/value information and the email notification settings for the specified user. For more information about the different user settings, see the [ML:userSettings list].

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

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

    UserSettingsInformation data, response status code and response headers



839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
 
# File 'lib/docusign_esign/api/users_api.rb', line 839

def get_settings_with_http_info(, user_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_settings" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_settings" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/settings".sub('{format}','json').sub('{' + 'accountId' + '}', .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'])

  # 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 => 'UserSettingsInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_signature(account_id, signature_id, user_id) ⇒ UserSignature

Gets the user signature information for the specified user. Retrieves the structure of a single signature with a known signature name. The userId specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account. The ‘signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith".

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • signature_id —

    The ID of the signature being accessed.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:



883
884
885
886
 
# File 'lib/docusign_esign/api/users_api.rb', line 883

def get_signature(, signature_id, user_id)
  data, _status_code, _headers = get_signature_with_http_info(, signature_id, user_id)
  return data
end

#get_signature_image(account_id, image_type, signature_id, user_id, options = DocuSign_eSign::GetSignatureImageOptions.default) ⇒ File

Retrieves the user initials image or the user signature image for the specified user. Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId property specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account. The ‘signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith". ###### Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • image_type —

    One of signature_image or initials_image.

  • signature_id —

    The ID of the signature being accessed.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::GetSignatureImageOptions —

    Options for modifying the behavior of the function.

Returns:

  • (File) 


942
943
944
945
 
# File 'lib/docusign_esign/api/users_api.rb', line 942

def get_signature_image(, image_type, signature_id, user_id, options = DocuSign_eSign::GetSignatureImageOptions.default)
  data, _status_code, _headers = get_signature_image_with_http_info(, image_type, signature_id, user_id, options)
  return data
end

#get_signature_image_with_http_info(account_id, image_type, signature_id, user_id, options = DocuSign_eSign::GetSignatureImageOptions.default) ⇒ Array<(File, Fixnum, Hash)>

Retrieves the user initials image or the user signature image for the specified user. Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId property specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the account. The &#x60;signatureId&#x60; parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode &quot;Bob Smith&quot; as &quot;Bob%20Smith&quot;. ###### Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • image_type —

    One of signature_image or initials_image.

  • signature_id —

    The ID of the signature being accessed.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::GetSignatureImageOptions —

    Options for modifying the behavior of the function.

Returns:

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

    File data, response status code and response headers



955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
 
# File 'lib/docusign_esign/api/users_api.rb', line 955

def get_signature_image_with_http_info(, image_type, signature_id, user_id, options = DocuSign_eSign::GetSignatureImageOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_signature_image ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_signature_image" if .nil?
  # verify the required parameter 'image_type' is set
  fail ArgumentError, "Missing the required parameter 'image_type' when calling UsersApi.get_signature_image" if image_type.nil?
  # verify the required parameter 'signature_id' is set
  fail ArgumentError, "Missing the required parameter 'signature_id' when calling UsersApi.get_signature_image" if signature_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_signature_image" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'imageType' + '}', image_type.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['image/gif'])

  # 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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_signature_with_http_info(account_id, signature_id, user_id) ⇒ Array<(UserSignature, Fixnum, Hash)>

Gets the user signature information for the specified user. Retrieves the structure of a single signature with a known signature name. The userId specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the account. The &#x60;signatureId&#x60; parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode &quot;Bob Smith&quot; as &quot;Bob%20Smith&quot;.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • signature_id —

    The ID of the signature being accessed.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

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

    UserSignature data, response status code and response headers



894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
 
# File 'lib/docusign_esign/api/users_api.rb', line 894

def get_signature_with_http_info(, signature_id, user_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_signature ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_signature" if .nil?
  # verify the required parameter 'signature_id' is set
  fail ArgumentError, "Missing the required parameter 'signature_id' when calling UsersApi.get_signature" if signature_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_signature" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'signatureId' + '}', signature_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'])

  # 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 => 'UserSignature')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(account_id, options = DocuSign_eSign::ListOptions.default) ⇒ UserInformationList

Retrieves the list of users for the specified account. Retrieves the list of users for the specified account. The response returns the list of users for the account along with the information about the result set. If the ‘additional_info` query was added to the endpoint and set to true, the full user information is returned for each user

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • DocuSign_eSign::ListOptions —

    Options for modifying the behavior of the function.

Returns:



1003
1004
1005
1006
 
# File 'lib/docusign_esign/api/users_api.rb', line 1003

def list(, options = DocuSign_eSign::ListOptions.default)
  data, _status_code, _headers = list_with_http_info(, options)
  return data
end

#list_custom_settings(account_id, user_id) ⇒ CustomSettingsInformation

Retrieves the custom user settings for a specified user. Retrieves a list of custom user settings for a single user. Custom settings provide a flexible way to store and retrieve custom user information that can be used in your own system. ###### Note: Custom user settings are not the same as user account settings. ###Getting Grouped Custom User Settings### If the custom user settings you want to retrieve are grouped, you must include the following information in the header, after Content-Type, in the request: ‘X-DocuSign-User-Settings-Key:group_name` Where the `group_name` is your designated name for the group of customer user settings. If the extra header information is not included, only the custom user settings that were added without a group are retrieved.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:



1064
1065
1066
1067
 
# File 'lib/docusign_esign/api/users_api.rb', line 1064

def list_custom_settings(, user_id)
  data, _status_code, _headers = list_custom_settings_with_http_info(, user_id)
  return data
end

#list_custom_settings_with_http_info(account_id, user_id) ⇒ Array<(CustomSettingsInformation, Fixnum, Hash)>

Retrieves the custom user settings for a specified user. Retrieves a list of custom user settings for a single user. Custom settings provide a flexible way to store and retrieve custom user information that can be used in your own system. ###### Note: Custom user settings are not the same as user account settings. ###Getting Grouped Custom User Settings### If the custom user settings you want to retrieve are grouped, you must include the following information in the header, after Content-Type, in the request: &#x60;X-DocuSign-User-Settings-Key:group_name&#x60; Where the &#x60;group_name&#x60; is your designated name for the group of customer user settings. If the extra header information is not included, only the custom user settings that were added without a group are retrieved.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

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

    CustomSettingsInformation data, response status code and response headers



1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
 
# File 'lib/docusign_esign/api/users_api.rb', line 1074

def list_custom_settings_with_http_info(, user_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.list_custom_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.list_custom_settings" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.list_custom_settings" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/custom_settings".sub('{format}','json').sub('{' + 'accountId' + '}', .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'])

  # 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 => 'CustomSettingsInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#list_custom_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_signatures(account_id, user_id, options = DocuSign_eSign::ListSignaturesOptions.default) ⇒ UserSignaturesInformation

Retrieves a list of user signature definitions for a specified user. Retrieves the signature definitions for the specified user. The userId parameter specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account. The ‘signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith".

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::ListSignaturesOptions —

    Options for modifying the behavior of the function.

Returns:



1118
1119
1120
1121
 
# File 'lib/docusign_esign/api/users_api.rb', line 1118

def list_signatures(, user_id, options = DocuSign_eSign::ListSignaturesOptions.default)
  data, _status_code, _headers = list_signatures_with_http_info(, user_id, options)
  return data
end

#list_signatures_with_http_info(account_id, user_id, options = DocuSign_eSign::ListSignaturesOptions.default) ⇒ Array<(UserSignaturesInformation, Fixnum, Hash)>

Retrieves a list of user signature definitions for a specified user. Retrieves the signature definitions for the specified user. The userId parameter specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the account. The &#x60;signatureId&#x60; parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode &quot;Bob Smith&quot; as &quot;Bob%20Smith&quot;.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • DocuSign_eSign::ListSignaturesOptions —

    Options for modifying the behavior of the function.

Returns:

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

    UserSignaturesInformation data, response status code and response headers



1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
 
# File 'lib/docusign_esign/api/users_api.rb', line 1129

def list_signatures_with_http_info(, user_id, options = DocuSign_eSign::ListSignaturesOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.list_signatures ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.list_signatures" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.list_signatures" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'userId' + '}', user_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['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 => 'UserSignaturesInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#list_signatures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_with_http_info(account_id, options = DocuSign_eSign::ListOptions.default) ⇒ Array<(UserInformationList, Fixnum, Hash)>

Retrieves the list of users for the specified account. Retrieves the list of users for the specified account. The response returns the list of users for the account along with the information about the result set. If the &#x60;additional_info&#x60; query was added to the endpoint and set to true, the full user information is returned for each user

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • DocuSign_eSign::ListOptions —

    Options for modifying the behavior of the function.

Returns:

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

    UserInformationList data, response status code and response headers



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/docusign_esign/api/users_api.rb', line 1013

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

  # query parameters
  query_params = {}
  query_params[:'additional_info'] = options.additional_info if !options.additional_info.nil?
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'email'] = options.email if !options.email.nil?
  query_params[:'email_substring'] = options.email_substring if !options.email_substring.nil?
  query_params[:'group_id'] = options.group_id if !options.group_id.nil?
  query_params[:'login_status'] = options. if !options..nil?
  query_params[:'not_group_id'] = options.not_group_id if !options.not_group_id.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
  query_params[:'status'] = options.status if !options.status.nil?
  query_params[:'user_name_substring'] = options.user_name_substring if !options.user_name_substring.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['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 => 'UserInformationList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_contacts(account_id, contact_mod_request) ⇒ ContactUpdateResponse

Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • contact_mod_request (optional parameter)

Returns:



1173
1174
1175
1176
 
# File 'lib/docusign_esign/api/users_api.rb', line 1173

def post_contacts(, contact_mod_request)
  data, _status_code, _headers = post_contacts_with_http_info(,  contact_mod_request)
  return data
end

#post_contacts_with_http_info(account_id, contact_mod_request) ⇒ Array<(ContactUpdateResponse, Fixnum, Hash)>

Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • contact_mod_request (optional parameter)

Returns:

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

    ContactUpdateResponse data, response status code and response headers



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
 
# File 'lib/docusign_esign/api/users_api.rb', line 1183

def post_contacts_with_http_info(, contact_mod_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.post_contacts ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.post_contacts" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/contacts".sub('{format}','json').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'])

  # form parameters
  form_params = {}

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

#put_contacts(account_id, contact_mod_request) ⇒ ContactUpdateResponse

Replaces contacts associated with an account for the DocuSign service.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • contact_mod_request (optional parameter)

Returns:



1224
1225
1226
1227
 
# File 'lib/docusign_esign/api/users_api.rb', line 1224

def put_contacts(, contact_mod_request)
  data, _status_code, _headers = put_contacts_with_http_info(,  contact_mod_request)
  return data
end

#put_contacts_with_http_info(account_id, contact_mod_request) ⇒ Array<(ContactUpdateResponse, Fixnum, Hash)>

Replaces contacts associated with an account for the DocuSign service.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • contact_mod_request (optional parameter)

Returns:

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

    ContactUpdateResponse data, response status code and response headers



1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File 'lib/docusign_esign/api/users_api.rb', line 1234

def put_contacts_with_http_info(, contact_mod_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.put_contacts ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.put_contacts" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/contacts".sub('{format}','json').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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(contact_mod_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactUpdateResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#put_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_custom_settings(account_id, user_id, custom_settings_information) ⇒ CustomSettingsInformation

Adds or updates custom user settings for the specified user. Adds or updates custom user settings for the specified user. ###### Note: Custom user settings are not the same as user account settings. Custom settings provide a flexible way to store and retrieve custom user information that you can use in your own system. Important: There is a limit on the size for all the custom user settings for a single user. The limit is 4,000 characters, which includes the XML and JSON structure for the settings. ### Grouping Custom User Settings ### You can group custom user settings when adding them. Grouping allows you to retrieve settings that are in a specific group, instead of retrieving all the user custom settings. To group custom user settings, add the following information in the header, after Content-Type: ‘X-DocuSign-User-Settings-Key:group_name` Where the `group_name` is your designated name for the group of customer user settings. Grouping is shown in the Example Request Body below. When getting or deleting grouped custom user settings, you must include the extra header information. Grouping custom user settings is not required and if the extra header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the additional header.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • custom_settings_information (optional parameter)

Returns:



1276
1277
1278
1279
 
# File 'lib/docusign_esign/api/users_api.rb', line 1276

def update_custom_settings(, user_id, custom_settings_information)
  data, _status_code, _headers = update_custom_settings_with_http_info(, user_id,  custom_settings_information)
  return data
end

#update_custom_settings_with_http_info(account_id, user_id, custom_settings_information) ⇒ Array<(CustomSettingsInformation, Fixnum, Hash)>

Adds or updates custom user settings for the specified user. Adds or updates custom user settings for the specified user. ###### Note: Custom user settings are not the same as user account settings. Custom settings provide a flexible way to store and retrieve custom user information that you can use in your own system. Important: There is a limit on the size for all the custom user settings for a single user. The limit is 4,000 characters, which includes the XML and JSON structure for the settings. ### Grouping Custom User Settings ### You can group custom user settings when adding them. Grouping allows you to retrieve settings that are in a specific group, instead of retrieving all the user custom settings. To group custom user settings, add the following information in the header, after Content-Type: &#x60;X-DocuSign-User-Settings-Key:group_name&#x60; Where the &#x60;group_name&#x60; is your designated name for the group of customer user settings. Grouping is shown in the Example Request Body below. When getting or deleting grouped custom user settings, you must include the extra header information. Grouping custom user settings is not required and if the extra header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the additional header.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • custom_settings_information (optional parameter)

Returns:

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

    CustomSettingsInformation data, response status code and response headers



1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'lib/docusign_esign/api/users_api.rb', line 1287

def update_custom_settings_with_http_info(, user_id, custom_settings_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.update_custom_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_custom_settings" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_custom_settings" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/custom_settings".sub('{format}','json').sub('{' + 'accountId' + '}', .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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(custom_settings_information)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CustomSettingsInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_custom_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_profile(account_id, user_id, user_profile) ⇒ nil

Updates the user profile information for the specified user. Updates the user’s detail information, profile information, privacy settings, and personal information in the user ID card. You can also change a user’s name by changing the information in the ‘userDetails` property. When changing a user’s name, you can either change the information in the ‘userName` property OR change the information in `firstName`, `middleName`, `lastName, suffixName`, and `title` properties. Changes to `firstName`, `middleName`, `lastName`, `suffixName`, and `title` properties take precedence over changes to the `userName` property.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • user_profile (optional parameter)

Returns:

  • (nil) 


1331
1332
1333
1334
 
# File 'lib/docusign_esign/api/users_api.rb', line 1331

def update_profile(, user_id, )
  update_profile_with_http_info(, user_id,  )
  return nil
end

#update_profile_image(account_id, user_id) ⇒ nil

Updates the user profile image for a specified user. Updates the user profile image by uploading an image to the user profile. The supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, DocuSign recommends that the image is no more than 79 pixels wide and high.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

  • (nil) 


1384
1385
1386
1387
 
# File 'lib/docusign_esign/api/users_api.rb', line 1384

def update_profile_image(, user_id)
  update_profile_image_with_http_info(, user_id)
  return nil
end

#update_profile_image_with_http_info(account_id, user_id) ⇒ Array<(nil, Fixnum, Hash)>

Updates the user profile image for a specified user. Updates the user profile image by uploading an image to the user profile. The supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, DocuSign recommends that the image is no more than 79 pixels wide and high.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

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

    nil, response status code and response headers



1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
 
# File 'lib/docusign_esign/api/users_api.rb', line 1394

def update_profile_image_with_http_info(, user_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.update_profile_image ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_profile_image" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_profile_image" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/profile/image".sub('{format}','json').sub('{' + 'accountId' + '}', .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(['image/gif'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_profile_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_profile_with_http_info(account_id, user_id, user_profile) ⇒ Array<(nil, Fixnum, Hash)>

Updates the user profile information for the specified user. Updates the user&#39;s detail information, profile information, privacy settings, and personal information in the user ID card. You can also change a user&#39;s name by changing the information in the &#x60;userDetails&#x60; property. When changing a user&#39;s name, you can either change the information in the &#x60;userName&#x60; property OR change the information in &#x60;firstName&#x60;, &#x60;middleName&#x60;, &#x60;lastName, suffixName&#x60;, and &#x60;title&#x60; properties. Changes to &#x60;firstName&#x60;, &#x60;middleName&#x60;, &#x60;lastName&#x60;, &#x60;suffixName&#x60;, and &#x60;title&#x60; properties take precedence over changes to the &#x60;userName&#x60; property.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • user_profile (optional parameter)

Returns:

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

    nil, response status code and response headers



1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/docusign_esign/api/users_api.rb', line 1342

def update_profile_with_http_info(, user_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.update_profile ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_profile" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_profile" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/profile".sub('{format}','json').sub('{' + 'accountId' + '}', .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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body()
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_settings(account_id, user_id, user_settings_information) ⇒ nil

Updates the user account settings for a specified user. Updates the account settings list and email notification types for the specified user.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • user_settings_information (optional parameter)

Returns:

  • (nil) 


1439
1440
1441
1442
 
# File 'lib/docusign_esign/api/users_api.rb', line 1439

def update_settings(, user_id, )
  update_settings_with_http_info(, user_id,  )
  return nil
end

#update_settings_with_http_info(account_id, user_id, user_settings_information) ⇒ Array<(nil, Fixnum, Hash)>

Updates the user account settings for a specified user. Updates the account settings list and email notification types for the specified user.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • user_settings_information (optional parameter)

Returns:

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

    nil, response status code and response headers



1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
 
# File 'lib/docusign_esign/api/users_api.rb', line 1450

def update_settings_with_http_info(, user_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.update_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_settings" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_settings" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/settings".sub('{format}','json').sub('{' + 'accountId' + '}', .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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body()
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_signature(account_id, signature_id, user_id, user_signature_definition, options = DocuSign_eSign::UpdateSignatureOptions.default) ⇒ UserSignature

Updates the user signature for a specified user. Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature. ###### Note: This will also create a default signature for the user when one does not exist. The userId property specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account. The ‘signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith".

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • signature_id —

    The ID of the signature being accessed.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • user_signature_definition (optional parameter)
  • DocuSign_eSign::UpdateSignatureOptions —

    Options for modifying the behavior of the function.

Returns:



1495
1496
1497
1498
 
# File 'lib/docusign_esign/api/users_api.rb', line 1495

def update_signature(, signature_id, user_id, user_signature_definition, options = DocuSign_eSign::UpdateSignatureOptions.default)
  data, _status_code, _headers = update_signature_with_http_info(, signature_id, user_id,  user_signature_definition, options)
  return data
end

#update_signature_image(account_id, image_type, signature_id, user_id) ⇒ UserSignature

Updates the user signature image or user initials image for the specified user. Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K. The userId property specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account. The ‘signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith".

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • image_type —

    One of signature_image or initials_image.

  • signature_id —

    The ID of the signature being accessed.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:



1556
1557
1558
1559
 
# File 'lib/docusign_esign/api/users_api.rb', line 1556

def update_signature_image(, image_type, signature_id, user_id)
  data, _status_code, _headers = update_signature_image_with_http_info(, image_type, signature_id, user_id)
  return data
end

#update_signature_image_with_http_info(account_id, image_type, signature_id, user_id) ⇒ Array<(UserSignature, Fixnum, Hash)>

Updates the user signature image or user initials image for the specified user. Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K. The userId property specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the account. The &#x60;signatureId&#x60; parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode &quot;Bob Smith&quot; as &quot;Bob%20Smith&quot;.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • image_type —

    One of signature_image or initials_image.

  • signature_id —

    The ID of the signature being accessed.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Returns:

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

    UserSignature data, response status code and response headers



1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
 
# File 'lib/docusign_esign/api/users_api.rb', line 1568

def update_signature_image_with_http_info(, image_type, signature_id, user_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.update_signature_image ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_signature_image" if .nil?
  # verify the required parameter 'image_type' is set
  fail ArgumentError, "Missing the required parameter 'image_type' when calling UsersApi.update_signature_image" if image_type.nil?
  # verify the required parameter 'signature_id' is set
  fail ArgumentError, "Missing the required parameter 'signature_id' when calling UsersApi.update_signature_image" if signature_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_signature_image" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'imageType' + '}', image_type.to_s).sub('{' + 'signatureId' + '}', signature_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(['image/gif'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserSignature')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_signature_with_http_info(account_id, signature_id, user_id, user_signature_definition, options = DocuSign_eSign::UpdateSignatureOptions.default) ⇒ Array<(UserSignature, Fixnum, Hash)>

Updates the user signature for a specified user. Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature. ###### Note: This will also create a default signature for the user when one does not exist. The userId property specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the account. The &#x60;signatureId&#x60; parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode &quot;Bob Smith&quot; as &quot;Bob%20Smith&quot;.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • signature_id —

    The ID of the signature being accessed.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • user_signature_definition (optional parameter)
  • DocuSign_eSign::UpdateSignatureOptions —

    Options for modifying the behavior of the function.

Returns:

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

    UserSignature data, response status code and response headers



1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'lib/docusign_esign/api/users_api.rb', line 1508

def update_signature_with_http_info(, signature_id, user_id, user_signature_definition, options = DocuSign_eSign::UpdateSignatureOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.update_signature ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_signature" if .nil?
  # verify the required parameter 'signature_id' is set
  fail ArgumentError, "Missing the required parameter 'signature_id' when calling UsersApi.update_signature" if signature_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_signature" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'signatureId' + '}', signature_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(user_signature_definition)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserSignature')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_signatures(account_id, user_id, user_signatures_information) ⇒ UserSignaturesInformation

Adds/updates a user signature.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • user_signatures_information (optional parameter)

Returns:



1618
1619
1620
1621
 
# File 'lib/docusign_esign/api/users_api.rb', line 1618

def update_signatures(, user_id, user_signatures_information)
  data, _status_code, _headers = update_signatures_with_http_info(, user_id,  user_signatures_information)
  return data
end

#update_signatures_with_http_info(account_id, user_id, user_signatures_information) ⇒ Array<(UserSignaturesInformation, Fixnum, Hash)>

Adds/updates a user signature.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • user_signatures_information (optional parameter)

Returns:

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

    UserSignaturesInformation data, response status code and response headers



1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
 
# File 'lib/docusign_esign/api/users_api.rb', line 1629

def update_signatures_with_http_info(, user_id, user_signatures_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.update_signatures ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_signatures" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_signatures" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures".sub('{format}','json').sub('{' + 'accountId' + '}', .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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(user_signatures_information)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserSignaturesInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_signatures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_user(account_id, user_id, user_information) ⇒ UserInformation

Updates the specified user information.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • user_information (optional parameter)

Returns:



1673
1674
1675
1676
 
# File 'lib/docusign_esign/api/users_api.rb', line 1673

def update_user(, user_id, user_information)
  data, _status_code, _headers = update_user_with_http_info(, user_id,  user_information)
  return data
end

#update_user_with_http_info(account_id, user_id, user_information) ⇒ Array<(UserInformation, Fixnum, Hash)>

Updates the specified user information.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_id —

    The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

  • user_information (optional parameter)

Returns:

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

    UserInformation data, response status code and response headers



1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
 
# File 'lib/docusign_esign/api/users_api.rb', line 1684

def update_user_with_http_info(, user_id, user_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.update_user ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_user" if .nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_user" if user_id.nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users/{userId}".sub('{format}','json').sub('{' + 'accountId' + '}', .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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(user_information)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserInformation')
  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

#update_users(account_id, user_information_list) ⇒ UserInformationList

Change one or more user in the specified account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_information_list (optional parameter)

Returns:



1727
1728
1729
1730
 
# File 'lib/docusign_esign/api/users_api.rb', line 1727

def update_users(, user_information_list)
  data, _status_code, _headers = update_users_with_http_info(,  user_information_list)
  return data
end

#update_users_with_http_info(account_id, user_information_list) ⇒ Array<(UserInformationList, Fixnum, Hash)>

Change one or more user in the specified account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • user_information_list (optional parameter)

Returns:

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

    UserInformationList data, response status code and response headers



1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
 
# File 'lib/docusign_esign/api/users_api.rb', line 1737

def update_users_with_http_info(, user_information_list)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.update_users ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_users" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/users".sub('{format}','json').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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(user_information_list)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserInformationList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#update_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end