Class: DocuSign_eSign::AccountsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/api/accounts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = AccountsApi.default) ⇒ AccountsApi

Returns a new instance of AccountsApi.



218
219
220
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 218

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



216
217
218
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 216

def api_client
  @api_client
end

Instance Method Details

#create(new_account_definition, options = DocuSign_eSign::CreateOptions.default) ⇒ NewAccountSummary

Creates new accounts. Creates new DocuSign service accounts. This is used to create multiple DocuSign accounts with one call. It uses the same information and formats as the normal a [Accounts:create](accounts_create) call with the information included within a ‘newAccountRequests` element. A maximum of 100 new accounts can be created at one time. Note that the structure of the XML request is slightly different than the JSON request, in that the new account information is included in a `newAccountDefinition` property inside the `newAccountRequests` element. Response The response returns the new account ID, password and the default user information for each newly created account. A 201 code is returned if the call succeeded. While the call may have succeed, some of the individual account requests may have failed. In the case of failures to create the account, an `errorDetails` node is added in the response to each specific request that failed.

Parameters:

  • new_account_definition (optional parameter)
  • DocuSign_eSign::CreateOptions —

    Options for modifying the behavior of the function.

Returns:



227
228
229
230
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 227

def create(, options = DocuSign_eSign::CreateOptions.default)
  data, _status_code, _headers = create_with_http_info( , options)
  return data
end

#create_brand(account_id, brand) ⇒ BrandsResponse

Creates one or more brand profile files for the account. Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties ‘canSelfBrandSend` and `canSelfBrandSig`) must be set to true for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.

Parameters:

  • account_id —

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

  • brand (optional parameter)

Returns:



277
278
279
280
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 277

def create_brand(, brand)
  data, _status_code, _headers = create_brand_with_http_info(,  brand)
  return data
end

#create_brand_with_http_info(account_id, brand) ⇒ Array<(BrandsResponse, Fixnum, Hash)>

Creates one or more brand profile files for the account. Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSig&#x60;) must be set to true for the account to use this call. An error is returned if &#x60;brandId&#x60; property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the &#x60;Content-Type&#x60; must be &#x60;application/zip&#x60;.

Parameters:

  • account_id —

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

  • brand (optional parameter)

Returns:

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

    BrandsResponse data, response status code and response headers



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 287

def create_brand_with_http_info(, brand)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.create_brand ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_brand" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/brands".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(brand)
  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 => 'BrandsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#create_brand\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_custom_field(account_id, custom_field, options = DocuSign_eSign::CreateCustomFieldOptions.default) ⇒ CustomFields

Creates an acount custom field.

Parameters:

  • account_id —

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

  • custom_field (optional parameter)
  • DocuSign_eSign::CreateCustomFieldOptions —

    Options for modifying the behavior of the function.

Returns:



329
330
331
332
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 329

def create_custom_field(, custom_field, options = DocuSign_eSign::CreateCustomFieldOptions.default)
  data, _status_code, _headers = create_custom_field_with_http_info(,  custom_field, options)
  return data
end

#create_custom_field_with_http_info(account_id, custom_field, options = DocuSign_eSign::CreateCustomFieldOptions.default) ⇒ Array<(CustomFields, Fixnum, Hash)>

Creates an acount custom field.

Parameters:

  • account_id —

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

  • custom_field (optional parameter)
  • DocuSign_eSign::CreateCustomFieldOptions —

    Options for modifying the behavior of the function.

Returns:

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

    CustomFields data, response status code and response headers



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 340

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

  # query parameters
  query_params = {}
  query_params[:'apply_to_templates'] = options.apply_to_templates if !options.apply_to_templates.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(custom_field)
  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 => 'CustomFields')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#create_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_permission_profile(account_id, permission_profile, options = DocuSign_eSign::CreatePermissionProfileOptions.default) ⇒ PermissionProfile

Creates a new permission profile in the specified account.

Parameters:

  • account_id —

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

  • permission_profile (optional parameter)
  • DocuSign_eSign::CreatePermissionProfileOptions —

    Options for modifying the behavior of the function.

Returns:



383
384
385
386
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 383

def create_permission_profile(, permission_profile, options = DocuSign_eSign::CreatePermissionProfileOptions.default)
  data, _status_code, _headers = create_permission_profile_with_http_info(,  permission_profile, options)
  return data
end

#create_permission_profile_with_http_info(account_id, permission_profile, options = DocuSign_eSign::CreatePermissionProfileOptions.default) ⇒ Array<(PermissionProfile, Fixnum, Hash)>

Creates a new permission profile in the specified account.

Parameters:

  • account_id —

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

  • permission_profile (optional parameter)
  • DocuSign_eSign::CreatePermissionProfileOptions —

    Options for modifying the behavior of the function.

Returns:

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

    PermissionProfile data, response status code and response headers



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 394

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

  # query parameters
  query_params = {}
  query_params[:'include'] = options.include if !options.include.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(permission_profile)
  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 => 'PermissionProfile')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#create_permission_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_with_http_info(new_account_definition, options = DocuSign_eSign::CreateOptions.default) ⇒ Array<(NewAccountSummary, Fixnum, Hash)>

Creates new accounts. Creates new DocuSign service accounts. This is used to create multiple DocuSign accounts with one call. It uses the same information and formats as the normal a [Accounts:create](accounts_create) call with the information included within a &#x60;newAccountRequests&#x60; element. A maximum of 100 new accounts can be created at one time. Note that the structure of the XML request is slightly different than the JSON request, in that the new account information is included in a &#x60;newAccountDefinition&#x60; property inside the &#x60;newAccountRequests&#x60; element. Response The response returns the new account ID, password and the default user information for each newly created account. A 201 code is returned if the call succeeded. While the call may have succeed, some of the individual account requests may have failed. In the case of failures to create the account, an &#x60;errorDetails&#x60; node is added in the response to each specific request that failed.

Parameters:

  • new_account_definition (optional parameter)
  • DocuSign_eSign::CreateOptions —

    Options for modifying the behavior of the function.

Returns:

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

    NewAccountSummary data, response status code and response headers



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

def create_with_http_info(, options = DocuSign_eSign::CreateOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.create ..."
  end
  # resource path
  local_var_path = "/v2.1/accounts".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'preview_billing_plan'] = options.preview_billing_plan if !options.preview_billing_plan.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(: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 => 'NewAccountSummary')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete(account_id) ⇒ nil

Deletes the specified account. This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.

Parameters:

  • account_id —

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

Returns:

  • (nil) 


435
436
437
438
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 435

def delete()
  delete_with_http_info()
  return nil
end

#delete_brand(account_id, brand_id) ⇒ nil

Removes a brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

Returns:

  • (nil) 


484
485
486
487
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 484

def delete_brand(, brand_id)
  delete_brand_with_http_info(, brand_id)
  return nil
end

#delete_brand_logo_by_type(account_id, brand_id, logo_type) ⇒ nil

Delete one branding logo.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • logo_type —

    One of Primary, Secondary or Email.

Returns:

  • (nil) 


537
538
539
540
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 537

def delete_brand_logo_by_type(, brand_id, logo_type)
  delete_brand_logo_by_type_with_http_info(, brand_id, logo_type)
  return nil
end

#delete_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type) ⇒ Array<(nil, Fixnum, Hash)>

Delete one branding logo.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • logo_type —

    One of Primary, Secondary or Email.

Returns:

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

    nil, response status code and response headers



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 548

def delete_brand_logo_by_type_with_http_info(, brand_id, logo_type)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.delete_brand_logo_by_type ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_brand_logo_by_type" if .nil?
  # verify the required parameter 'brand_id' is set
  fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.delete_brand_logo_by_type" if brand_id.nil?
  # verify the required parameter 'logo_type' is set
  fail ArgumentError, "Missing the required parameter 'logo_type' when calling AccountsApi.delete_brand_logo_by_type" if logo_type.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.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: AccountsApi#delete_brand_logo_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_brand_with_http_info(account_id, brand_id) ⇒ Array<(nil, Fixnum, Hash)>

Removes a brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

Returns:

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

    nil, response status code and response headers



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 494

def delete_brand_with_http_info(, brand_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.delete_brand ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_brand" if .nil?
  # verify the required parameter 'brand_id' is set
  fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.delete_brand" if brand_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'brandId' + '}', brand_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: AccountsApi#delete_brand\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_brands(account_id, brands_request) ⇒ BrandsResponse

Deletes one or more brand profiles. Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties ‘canSelfBrandSend` and `canSelfBrandSend`) must be set to true to use this call.

Parameters:

  • account_id —

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

  • brands_request (optional parameter)

Returns:



592
593
594
595
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 592

def delete_brands(, brands_request)
  data, _status_code, _headers = delete_brands_with_http_info(,  brands_request)
  return data
end

#delete_brands_with_http_info(account_id, brands_request) ⇒ Array<(BrandsResponse, Fixnum, Hash)>

Deletes one or more brand profiles. Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSend&#x60;) must be set to true to use this call.

Parameters:

  • account_id —

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

  • brands_request (optional parameter)

Returns:

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

    BrandsResponse data, response status code and response headers



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 602

def delete_brands_with_http_info(, brands_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.delete_brands ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_brands" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/brands".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(brands_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 => 'BrandsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#delete_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_captive_recipient(account_id, recipient_part, captive_recipient_information) ⇒ CaptiveRecipientInformation

Deletes the signature for one or more captive recipient records. Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.

Parameters:

  • account_id —

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

  • recipient_part
  • captive_recipient_information (optional parameter)

Returns:



644
645
646
647
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 644

def delete_captive_recipient(, recipient_part, captive_recipient_information)
  data, _status_code, _headers = delete_captive_recipient_with_http_info(, recipient_part,  captive_recipient_information)
  return data
end

#delete_captive_recipient_with_http_info(account_id, recipient_part, captive_recipient_information) ⇒ Array<(CaptiveRecipientInformation, Fixnum, Hash)>

Deletes the signature for one or more captive recipient records. Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.

Parameters:

  • account_id —

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

  • recipient_part
  • captive_recipient_information (optional parameter)

Returns:



655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 655

def delete_captive_recipient_with_http_info(, recipient_part, captive_recipient_information)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.delete_captive_recipient ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_captive_recipient" if .nil?
  # verify the required parameter 'recipient_part' is set
  fail ArgumentError, "Missing the required parameter 'recipient_part' when calling AccountsApi.delete_captive_recipient" if recipient_part.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/captive_recipients/{recipientPart}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'recipientPart' + '}', recipient_part.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(captive_recipient_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 => 'CaptiveRecipientInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#delete_captive_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_custom_field(account_id, custom_field_id, options = DocuSign_eSign::DeleteCustomFieldOptions.default) ⇒ nil

Delete an existing account custom field.

Parameters:

  • account_id —

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

  • custom_field_id
  • DocuSign_eSign::DeleteCustomFieldOptions —

    Options for modifying the behavior of the function.

Returns:

  • (nil) 


699
700
701
702
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 699

def delete_custom_field(, custom_field_id, options = DocuSign_eSign::DeleteCustomFieldOptions.default)
  delete_custom_field_with_http_info(, custom_field_id, options)
  return nil
end

#delete_custom_field_with_http_info(account_id, custom_field_id, options = DocuSign_eSign::DeleteCustomFieldOptions.default) ⇒ Array<(nil, Fixnum, Hash)>

Delete an existing account custom field.

Parameters:

  • account_id —

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

  • custom_field_id
  • DocuSign_eSign::DeleteCustomFieldOptions —

    Options for modifying the behavior of the function.

Returns:

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

    nil, response status code and response headers



710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 710

def delete_custom_field_with_http_info(, custom_field_id, options = DocuSign_eSign::DeleteCustomFieldOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.delete_custom_field ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_custom_field" if .nil?
  # verify the required parameter 'custom_field_id' is set
  fail ArgumentError, "Missing the required parameter 'custom_field_id' when calling AccountsApi.delete_custom_field" if custom_field_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/custom_fields/{customFieldId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'customFieldId' + '}', custom_field_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'apply_to_templates'] = options.apply_to_templates if !options.apply_to_templates.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(: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: AccountsApi#delete_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_e_note_configuration(account_id) ⇒ nil

Deletes configuration information for the eNote eOriginal integration.

Parameters:

  • account_id —

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

Returns:

  • (nil) 


752
753
754
755
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 752

def delete_e_note_configuration()
  delete_e_note_configuration_with_http_info()
  return nil
end

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

Deletes configuration information for the eNote eOriginal integration.

Parameters:

  • account_id —

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

Returns:

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

    nil, response status code and response headers



761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 761

def delete_e_note_configuration_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.delete_e_note_configuration ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_e_note_configuration" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/enote_configuration".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 = 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: AccountsApi#delete_e_note_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_permission_profile(account_id, permission_profile_id) ⇒ nil

Deletes a permissions profile within the specified account.

Parameters:

  • account_id —

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

  • permission_profile_id

Returns:

  • (nil) 


801
802
803
804
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 801

def delete_permission_profile(, permission_profile_id)
  delete_permission_profile_with_http_info(, permission_profile_id)
  return nil
end

#delete_permission_profile_with_http_info(account_id, permission_profile_id) ⇒ Array<(nil, Fixnum, Hash)>

Deletes a permissions profile within the specified account.

Parameters:

  • account_id —

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

  • permission_profile_id

Returns:

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

    nil, response status code and response headers



811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 811

def delete_permission_profile_with_http_info(, permission_profile_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.delete_permission_profile ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_permission_profile" if .nil?
  # verify the required parameter 'permission_profile_id' is set
  fail ArgumentError, "Missing the required parameter 'permission_profile_id' when calling AccountsApi.delete_permission_profile" if permission_profile_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_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: AccountsApi#delete_permission_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Deletes the specified account. This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.

Parameters:

  • account_id —

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

Returns:

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

    nil, response status code and response headers



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 444

def delete_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.delete ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}".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 = 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: AccountsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_identity_verification(account_id) ⇒ AccountIdentityVerificationResponse

Get the list of identity verification options for an account

Parameters:

  • account_id —

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

Returns:



852
853
854
855
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 852

def ()
  data, _status_code, _headers = ()
  return data
end

#get_account_identity_verification_with_http_info(account_id) ⇒ Array<(AccountIdentityVerificationResponse, Fixnum, Hash)>

Get the list of identity verification options for an account

Parameters:

  • account_id —

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

Returns:



861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 861

def ()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_account_identity_verification ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_identity_verification" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/identity_verification".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 = 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 => 'AccountIdentityVerificationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_account_identity_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_information(account_id, options = DocuSign_eSign::GetAccountInformationOptions.default) ⇒ AccountInformation

Retrieves the account information for the specified account. Retrieves the account information for the specified account. Response The ‘canUpgrade` property contains is a Boolean that indicates whether the account can be upgraded through the API.

Parameters:

  • account_id —

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

  • DocuSign_eSign::GetAccountInformationOptions —

    Options for modifying the behavior of the function.

Returns:



902
903
904
905
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 902

def (, options = DocuSign_eSign::GetAccountInformationOptions.default)
  data, _status_code, _headers = (, options)
  return data
end

#get_account_information_with_http_info(account_id, options = DocuSign_eSign::GetAccountInformationOptions.default) ⇒ Array<(AccountInformation, Fixnum, Hash)>

Retrieves the account information for the specified account. Retrieves the account information for the specified account. Response The &#x60;canUpgrade&#x60; property contains is a Boolean that indicates whether the account can be upgraded through the API.

Parameters:

  • account_id —

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

  • DocuSign_eSign::GetAccountInformationOptions —

    Options for modifying the behavior of the function.

Returns:

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

    AccountInformation data, response status code and response headers



912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 912

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

  # query parameters
  query_params = {}
  query_params[:'include_account_settings'] = options. if !options..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 => 'AccountInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_account_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_tab_settings(account_id) ⇒ TabAccountSettings

Returns tab settings list for specified account

Parameters:

  • account_id —

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

Returns:



953
954
955
956
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 953

def ()
  data, _status_code, _headers = ()
  return data
end

#get_account_tab_settings_with_http_info(account_id) ⇒ Array<(TabAccountSettings, Fixnum, Hash)>

Returns tab settings list for specified account

Parameters:

  • account_id —

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

Returns:

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

    TabAccountSettings data, response status code and response headers



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/accounts_api.rb', line 962

def ()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_account_tab_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_tab_settings" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/tabs".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 = 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 => 'TabAccountSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_account_tab_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_payment_gateway_accounts(account_id) ⇒ PaymentGatewayAccountsInfo

Get all payment gateway account for the provided accountId

Parameters:

  • account_id —

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

Returns:



1002
1003
1004
1005
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1002

def get_all_payment_gateway_accounts()
  data, _status_code, _headers = get_all_payment_gateway_accounts_with_http_info()
  return data
end

#get_all_payment_gateway_accounts_with_http_info(account_id) ⇒ Array<(PaymentGatewayAccountsInfo, Fixnum, Hash)>

Get all payment gateway account for the provided accountId

Parameters:

  • account_id —

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

Returns:

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

    PaymentGatewayAccountsInfo data, response status code and response headers



1011
1012
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
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1011

def get_all_payment_gateway_accounts_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_all_payment_gateway_accounts ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_all_payment_gateway_accounts" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/payment_gateway_accounts".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 = 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 => 'PaymentGatewayAccountsInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_all_payment_gateway_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_billing_charges(account_id, options = DocuSign_eSign::GetBillingChargesOptions.default) ⇒ BillingChargeResponse

Gets list of recurring and usage charges for the account. Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator

Parameters:

  • account_id —

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

  • DocuSign_eSign::GetBillingChargesOptions —

    Options for modifying the behavior of the function.

Returns:



1052
1053
1054
1055
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1052

def get_billing_charges(, options = DocuSign_eSign::GetBillingChargesOptions.default)
  data, _status_code, _headers = get_billing_charges_with_http_info(, options)
  return data
end

#get_billing_charges_with_http_info(account_id, options = DocuSign_eSign::GetBillingChargesOptions.default) ⇒ Array<(BillingChargeResponse, Fixnum, Hash)>

Gets list of recurring and usage charges for the account. Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator

Parameters:

  • account_id —

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

  • DocuSign_eSign::GetBillingChargesOptions —

    Options for modifying the behavior of the function.

Returns:

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

    BillingChargeResponse data, response status code and response headers



1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1062

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

  # query parameters
  query_params = {}
  query_params[:'include_charges'] = options.include_charges if !options.include_charges.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 => 'BillingChargeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_billing_charges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_brand(account_id, brand_id, options = DocuSign_eSign::GetBrandOptions.default) ⇒ Brand

Get information for a specific brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • DocuSign_eSign::GetBrandOptions —

    Options for modifying the behavior of the function.

Returns:



1105
1106
1107
1108
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1105

def get_brand(, brand_id, options = DocuSign_eSign::GetBrandOptions.default)
  data, _status_code, _headers = get_brand_with_http_info(, brand_id, options)
  return data
end

#get_brand_export_file(account_id, brand_id) ⇒ nil

Export a specific brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

Returns:

  • (nil) 


1161
1162
1163
1164
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1161

def get_brand_export_file(, brand_id)
  get_brand_export_file_with_http_info(, brand_id)
  return nil
end

#get_brand_export_file_with_http_info(account_id, brand_id) ⇒ Array<(nil, Fixnum, Hash)>

Export a specific brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

Returns:

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

    nil, response status code and response headers



1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1171

def get_brand_export_file_with_http_info(, brand_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_brand_export_file ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand_export_file" if .nil?
  # verify the required parameter 'brand_id' is set
  fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand_export_file" if brand_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/file".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'brandId' + '}', brand_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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_brand_export_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_brand_logo_by_type(account_id, brand_id, logo_type) ⇒ File

Obtains the specified image for a brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • logo_type —

    One of Primary, Secondary or Email.

Returns:

  • (File) 


1214
1215
1216
1217
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1214

def get_brand_logo_by_type(, brand_id, logo_type)
  data, _status_code, _headers = get_brand_logo_by_type_with_http_info(, brand_id, logo_type)
  return data
end

#get_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type) ⇒ Array<(File, Fixnum, Hash)>

Obtains the specified image for a brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • logo_type —

    One of Primary, Secondary or Email.

Returns:

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

    File data, response status code and response headers



1225
1226
1227
1228
1229
1230
1231
1232
1233
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
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1225

def get_brand_logo_by_type_with_http_info(, brand_id, logo_type)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_brand_logo_by_type ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand_logo_by_type" if .nil?
  # verify the required parameter 'brand_id' is set
  fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand_logo_by_type" if brand_id.nil?
  # verify the required parameter 'logo_type' is set
  fail ArgumentError, "Missing the required parameter 'logo_type' when calling AccountsApi.get_brand_logo_by_type" if logo_type.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.to_s)

  # query parameters
  query_params = {}

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

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

#get_brand_resources(account_id, brand_id) ⇒ BrandResourcesList

Returns the specified account’s list of branding resources (metadata).

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

Returns:



1270
1271
1272
1273
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1270

def get_brand_resources(, brand_id)
  data, _status_code, _headers = get_brand_resources_with_http_info(, brand_id)
  return data
end

#get_brand_resources_by_content_type(account_id, brand_id, resource_content_type, options = DocuSign_eSign::GetBrandResourcesByContentTypeOptions.default) ⇒ nil

Returns the specified branding resource file.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • resource_content_type
  • DocuSign_eSign::GetBrandResourcesByContentTypeOptions —

    Options for modifying the behavior of the function.

Returns:

  • (nil) 


1325
1326
1327
1328
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1325

def get_brand_resources_by_content_type(, brand_id, resource_content_type, options = DocuSign_eSign::GetBrandResourcesByContentTypeOptions.default)
  get_brand_resources_by_content_type_with_http_info(, brand_id, resource_content_type, options)
  return nil
end

#get_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type, options = DocuSign_eSign::GetBrandResourcesByContentTypeOptions.default) ⇒ Array<(nil, Fixnum, Hash)>

Returns the specified branding resource file.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • resource_content_type
  • DocuSign_eSign::GetBrandResourcesByContentTypeOptions —

    Options for modifying the behavior of the function.

Returns:

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

    nil, response status code and response headers



1337
1338
1339
1340
1341
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
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1337

def get_brand_resources_by_content_type_with_http_info(, brand_id, resource_content_type, options = DocuSign_eSign::GetBrandResourcesByContentTypeOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_brand_resources_by_content_type ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand_resources_by_content_type" if .nil?
  # verify the required parameter 'brand_id' is set
  fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand_resources_by_content_type" if brand_id.nil?
  # verify the required parameter 'resource_content_type' is set
  fail ArgumentError, "Missing the required parameter 'resource_content_type' when calling AccountsApi.get_brand_resources_by_content_type" if resource_content_type.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'resourceContentType' + '}', resource_content_type.to_s)

  # query parameters
  query_params = {}
  query_params[:'langcode'] = options.langcode if !options.langcode.nil?
  query_params[:'return_master'] = options.return_master if !options.return_master.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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_brand_resources_by_content_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_brand_resources_with_http_info(account_id, brand_id) ⇒ Array<(BrandResourcesList, Fixnum, Hash)>

Returns the specified account&#39;s list of branding resources (metadata).

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

Returns:

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

    BrandResourcesList data, response status code and response headers



1280
1281
1282
1283
1284
1285
1286
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
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1280

def get_brand_resources_with_http_info(, brand_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_brand_resources ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand_resources" if .nil?
  # verify the required parameter 'brand_id' is set
  fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand_resources" if brand_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/resources".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'brandId' + '}', brand_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 => 'BrandResourcesList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_brand_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_brand_with_http_info(account_id, brand_id, options = DocuSign_eSign::GetBrandOptions.default) ⇒ Array<(Brand, Fixnum, Hash)>

Get information for a specific brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • DocuSign_eSign::GetBrandOptions —

    Options for modifying the behavior of the function.

Returns:

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

    Brand data, response status code and response headers



1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
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
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1116

def get_brand_with_http_info(, brand_id, options = DocuSign_eSign::GetBrandOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_brand ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand" if .nil?
  # verify the required parameter 'brand_id' is set
  fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand" if brand_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'brandId' + '}', brand_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include_external_references'] = options.include_external_references if !options.include_external_references.nil?
  query_params[:'include_logos'] = options.include_logos if !options.include_logos.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 => 'Brand')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_brand\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_consumer_disclosure(account_id, lang_code) ⇒ ConsumerDisclosure

Gets the Electronic Record and Signature Disclosure. Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.

Parameters:

  • account_id —

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

  • lang_code —

    The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.

Returns:



1383
1384
1385
1386
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1383

def get_consumer_disclosure(, lang_code)
  data, _status_code, _headers = get_consumer_disclosure_with_http_info(, lang_code)
  return data
end

#get_consumer_disclosure_default(account_id, options = DocuSign_eSign::GetConsumerDisclosureDefaultOptions.default) ⇒ ConsumerDisclosure

Gets the Electronic Record and Signature Disclosure for the account. Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure.

Parameters:

  • account_id —

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

  • DocuSign_eSign::GetConsumerDisclosureDefaultOptions —

    Options for modifying the behavior of the function.

Returns:



1436
1437
1438
1439
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1436

def get_consumer_disclosure_default(, options = DocuSign_eSign::GetConsumerDisclosureDefaultOptions.default)
  data, _status_code, _headers = get_consumer_disclosure_default_with_http_info(, options)
  return data
end

#get_consumer_disclosure_default_with_http_info(account_id, options = DocuSign_eSign::GetConsumerDisclosureDefaultOptions.default) ⇒ Array<(ConsumerDisclosure, Fixnum, Hash)>

Gets the Electronic Record and Signature Disclosure for the account. Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure.

Parameters:

  • account_id —

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

  • DocuSign_eSign::GetConsumerDisclosureDefaultOptions —

    Options for modifying the behavior of the function.

Returns:

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

    ConsumerDisclosure data, response status code and response headers



1446
1447
1448
1449
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
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1446

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

  # query parameters
  query_params = {}
  query_params[:'langCode'] = options.lang_code if !options.lang_code.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 => 'ConsumerDisclosure')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_consumer_disclosure_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_consumer_disclosure_with_http_info(account_id, lang_code) ⇒ Array<(ConsumerDisclosure, Fixnum, Hash)>

Gets the Electronic Record and Signature Disclosure. Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.

Parameters:

  • account_id —

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

  • lang_code —

    The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.

Returns:

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

    ConsumerDisclosure data, response status code and response headers



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

def get_consumer_disclosure_with_http_info(, lang_code)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_consumer_disclosure ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_consumer_disclosure" if .nil?
  # verify the required parameter 'lang_code' is set
  fail ArgumentError, "Missing the required parameter 'lang_code' when calling AccountsApi.get_consumer_disclosure" if lang_code.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'langCode' + '}', lang_code.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 => 'ConsumerDisclosure')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_consumer_disclosure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_e_note_configuration(account_id) ⇒ ENoteConfiguration

Returns the configuration information for the eNote eOriginal integration.

Parameters:

  • account_id —

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

Returns:



1487
1488
1489
1490
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1487

def get_e_note_configuration()
  data, _status_code, _headers = get_e_note_configuration_with_http_info()
  return data
end

#get_e_note_configuration_with_http_info(account_id) ⇒ Array<(ENoteConfiguration, Fixnum, Hash)>

Returns the configuration information for the eNote eOriginal integration.

Parameters:

  • account_id —

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

Returns:

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

    ENoteConfiguration data, response status code and response headers



1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1496

def get_e_note_configuration_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_e_note_configuration ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_e_note_configuration" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/enote_configuration".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 = 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 => 'ENoteConfiguration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_e_note_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_envelope_purge_configuration(account_id) ⇒ EnvelopePurgeConfiguration

Select envelope purge configuration.

Parameters:

  • account_id —

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

Returns:



1536
1537
1538
1539
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1536

def get_envelope_purge_configuration()
  data, _status_code, _headers = get_envelope_purge_configuration_with_http_info()
  return data
end

#get_envelope_purge_configuration_with_http_info(account_id) ⇒ Array<(EnvelopePurgeConfiguration, Fixnum, Hash)>

Select envelope purge configuration.

Parameters:

  • account_id —

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

Returns:

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

    EnvelopePurgeConfiguration data, response status code and response headers



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1545

def get_envelope_purge_configuration_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_envelope_purge_configuration ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_envelope_purge_configuration" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/envelope_purge_configuration".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 = 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 => 'EnvelopePurgeConfiguration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_envelope_purge_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_favorite_templates(account_id) ⇒ FavoriteTemplatesInfo

Retrieves the list of favorited templates for this caller

Parameters:

  • account_id —

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

Returns:



1585
1586
1587
1588
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1585

def get_favorite_templates()
  data, _status_code, _headers = get_favorite_templates_with_http_info()
  return data
end

#get_favorite_templates_with_http_info(account_id) ⇒ Array<(FavoriteTemplatesInfo, Fixnum, Hash)>

Retrieves the list of favorited templates for this caller

Parameters:

  • account_id —

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

Returns:

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

    FavoriteTemplatesInfo data, response status code and response headers



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1594

def get_favorite_templates_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_favorite_templates ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_favorite_templates" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/favorite_templates".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 = 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 => 'FavoriteTemplatesInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_favorite_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_notification_defaults(account_id) ⇒ NotificationDefaults

Returns default user level settings for a specified account

Parameters:

  • account_id —

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

Returns:



1634
1635
1636
1637
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1634

def get_notification_defaults()
  data, _status_code, _headers = get_notification_defaults_with_http_info()
  return data
end

#get_notification_defaults_with_http_info(account_id) ⇒ Array<(NotificationDefaults, Fixnum, Hash)>

Returns default user level settings for a specified account

Parameters:

  • account_id —

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

Returns:

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

    NotificationDefaults data, response status code and response headers



1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1643

def get_notification_defaults_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_notification_defaults ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_notification_defaults" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/notification_defaults".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 = 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 => 'NotificationDefaults')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_notification_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_password_rules(account_id) ⇒ AccountPasswordRules

Get the password rules

Parameters:

  • account_id —

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

Returns:



1683
1684
1685
1686
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1683

def get_password_rules()
  data, _status_code, _headers = get_password_rules_with_http_info()
  return data
end

#get_password_rules_0 ⇒ UserPasswordRules

Get membership account password rules

Returns:



1731
1732
1733
1734
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1731

def get_password_rules_0()
  data, _status_code, _headers = get_password_rules_0_with_http_info()
  return data
end

#get_password_rules_0_with_http_info ⇒ Array<(UserPasswordRules, Fixnum, Hash)>

Get membership account password rules

Returns:

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

    UserPasswordRules data, response status code and response headers



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/accounts_api.rb', line 1739

def get_password_rules_0_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_password_rules_0 ..."
  end
  # resource path
  local_var_path = "/v2.1/current_user/password_rules".sub('{format}','json')

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

#get_password_rules_with_http_info(account_id) ⇒ Array<(AccountPasswordRules, Fixnum, Hash)>

Get the password rules

Parameters:

  • account_id —

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

Returns:

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

    AccountPasswordRules data, response status code and response headers



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
1721
1722
1723
1724
1725
1726
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1692

def get_password_rules_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_password_rules ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_password_rules" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/password_rules".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 = 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 => 'AccountPasswordRules')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_password_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_permission_profile(account_id, permission_profile_id, options = DocuSign_eSign::GetPermissionProfileOptions.default) ⇒ PermissionProfile

Returns a permissions profile in the specified account.

Parameters:

  • account_id —

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

  • permission_profile_id
  • DocuSign_eSign::GetPermissionProfileOptions —

    Options for modifying the behavior of the function.

Returns:



1779
1780
1781
1782
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1779

def get_permission_profile(, permission_profile_id, options = DocuSign_eSign::GetPermissionProfileOptions.default)
  data, _status_code, _headers = get_permission_profile_with_http_info(, permission_profile_id, options)
  return data
end

#get_permission_profile_with_http_info(account_id, permission_profile_id, options = DocuSign_eSign::GetPermissionProfileOptions.default) ⇒ Array<(PermissionProfile, Fixnum, Hash)>

Returns a permissions profile in the specified account.

Parameters:

  • account_id —

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

  • permission_profile_id
  • DocuSign_eSign::GetPermissionProfileOptions —

    Options for modifying the behavior of the function.

Returns:

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

    PermissionProfile data, response status code and response headers



1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1790

def get_permission_profile_with_http_info(, permission_profile_id, options = DocuSign_eSign::GetPermissionProfileOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_permission_profile ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_permission_profile" if .nil?
  # verify the required parameter 'permission_profile_id' is set
  fail ArgumentError, "Missing the required parameter 'permission_profile_id' when calling AccountsApi.get_permission_profile" if permission_profile_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include'] = options.include if !options.include.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 => 'PermissionProfile')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_permission_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_provisioning ⇒ ProvisioningInformation

Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account.

Returns:



1832
1833
1834
1835
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1832

def get_provisioning()
  data, _status_code, _headers = get_provisioning_with_http_info()
  return data
end

#get_provisioning_with_http_info ⇒ Array<(ProvisioningInformation, Fixnum, Hash)>

Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account.

Returns:

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

    ProvisioningInformation data, response status code and response headers



1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1840

def get_provisioning_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_provisioning ..."
  end
  # resource path
  local_var_path = "/v2.1/accounts/provisioning".sub('{format}','json')

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

#get_supported_languages(account_id) ⇒ SupportedLanguages

Gets list of supported languages for recipient language setting.

Parameters:

  • account_id —

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

Returns:



1878
1879
1880
1881
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1878

def get_supported_languages()
  data, _status_code, _headers = get_supported_languages_with_http_info()
  return data
end

#get_supported_languages_with_http_info(account_id) ⇒ Array<(SupportedLanguages, Fixnum, Hash)>

Gets list of supported languages for recipient language setting.

Parameters:

  • account_id —

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

Returns:

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

    SupportedLanguages data, response status code and response headers



1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1887

def get_supported_languages_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_supported_languages ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_supported_languages" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/supported_languages".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 = 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 => 'SupportedLanguages')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_supported_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_watermark(account_id) ⇒ Watermark

Get watermark information.

Parameters:

  • account_id —

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

Returns:



1927
1928
1929
1930
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1927

def get_watermark()
  data, _status_code, _headers = get_watermark_with_http_info()
  return data
end

#get_watermark_preview(account_id, watermark) ⇒ Watermark

Get watermark preview.

Parameters:

  • account_id —

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

  • watermark (optional parameter)

Returns:



1977
1978
1979
1980
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1977

def get_watermark_preview(, watermark)
  data, _status_code, _headers = get_watermark_preview_with_http_info(,  watermark)
  return data
end

#get_watermark_preview_with_http_info(account_id, watermark) ⇒ Array<(Watermark, Fixnum, Hash)>

Get watermark preview.

Parameters:

  • account_id —

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

  • watermark (optional parameter)

Returns:

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

    Watermark data, response status code and response headers



1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1987

def get_watermark_preview_with_http_info(, watermark)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_watermark_preview ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_watermark_preview" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/watermark/preview".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(watermark)
  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 => 'Watermark')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_watermark_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_watermark_with_http_info(account_id) ⇒ Array<(Watermark, Fixnum, Hash)>

Get watermark information.

Parameters:

  • account_id —

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

Returns:

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

    Watermark data, response status code and response headers



1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1936

def get_watermark_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_watermark ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_watermark" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/watermark".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 = 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 => 'Watermark')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_watermark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_brands(account_id, options = DocuSign_eSign::ListBrandsOptions.default) ⇒ BrandsResponse

Gets a list of brand profiles. Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties ‘canSelfBrandSend` and `canSelfBrandSend`) must be set to true for the account to use this call.

Parameters:

  • account_id —

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

  • DocuSign_eSign::ListBrandsOptions —

    Options for modifying the behavior of the function.

Returns:



2028
2029
2030
2031
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2028

def list_brands(, options = DocuSign_eSign::ListBrandsOptions.default)
  data, _status_code, _headers = list_brands_with_http_info(, options)
  return data
end

#list_brands_with_http_info(account_id, options = DocuSign_eSign::ListBrandsOptions.default) ⇒ Array<(BrandsResponse, Fixnum, Hash)>

Gets a list of brand profiles. Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSend&#x60;) must be set to true for the account to use this call.

Parameters:

  • account_id —

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

  • DocuSign_eSign::ListBrandsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    BrandsResponse data, response status code and response headers



2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2038

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

  # query parameters
  query_params = {}
  query_params[:'exclude_distributor_brand'] = options.exclude_distributor_brand if !options.exclude_distributor_brand.nil?
  query_params[:'include_logos'] = options.include_logos if !options.include_logos.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 => 'BrandsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#list_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_custom_fields(account_id) ⇒ CustomFields

Gets a list of custom fields associated with the account. Retrieves a list of envelope custom fields associated with the account. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. The list custom field lets the sender select the value of the field from a list you provide.

Parameters:

  • account_id —

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

Returns:



2080
2081
2082
2083
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2080

def list_custom_fields()
  data, _status_code, _headers = list_custom_fields_with_http_info()
  return data
end

#list_custom_fields_with_http_info(account_id) ⇒ Array<(CustomFields, Fixnum, Hash)>

Gets a list of custom fields associated with the account. Retrieves a list of envelope custom fields associated with the account. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. The list custom field lets the sender select the value of the field from a list you provide.

Parameters:

  • account_id —

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

Returns:

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

    CustomFields data, response status code and response headers



2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2089

def list_custom_fields_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.list_custom_fields ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_custom_fields" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/custom_fields".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 = 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 => 'CustomFields')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#list_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_permissions(account_id, options = DocuSign_eSign::ListPermissionsOptions.default) ⇒ PermissionProfileInformation

Gets a list of permission profiles. Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently, Permission Profiles can only be created and modified in the DocuSign console.

Parameters:

  • account_id —

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

  • DocuSign_eSign::ListPermissionsOptions —

    Options for modifying the behavior of the function.

Returns:



2130
2131
2132
2133
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2130

def list_permissions(, options = DocuSign_eSign::ListPermissionsOptions.default)
  data, _status_code, _headers = list_permissions_with_http_info(, options)
  return data
end

#list_permissions_with_http_info(account_id, options = DocuSign_eSign::ListPermissionsOptions.default) ⇒ Array<(PermissionProfileInformation, Fixnum, Hash)>

Gets a list of permission profiles. Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently, Permission Profiles can only be created and modified in the DocuSign console.

Parameters:

  • account_id —

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

  • DocuSign_eSign::ListPermissionsOptions —

    Options for modifying the behavior of the function.

Returns:



2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2140

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

  # query parameters
  query_params = {}
  query_params[:'include'] = options.include if !options.include.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 => 'PermissionProfileInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#list_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_recipient_names_by_email(account_id, options = DocuSign_eSign::ListRecipientNamesByEmailOptions.default) ⇒ RecipientNamesResponse

Gets recipient names associated with an email address. Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string.

Parameters:

  • account_id —

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

  • DocuSign_eSign::ListRecipientNamesByEmailOptions —

    Options for modifying the behavior of the function.

Returns:



2182
2183
2184
2185
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2182

def list_recipient_names_by_email(, options = DocuSign_eSign::ListRecipientNamesByEmailOptions.default)
  data, _status_code, _headers = list_recipient_names_by_email_with_http_info(, options)
  return data
end

#list_recipient_names_by_email_with_http_info(account_id, options = DocuSign_eSign::ListRecipientNamesByEmailOptions.default) ⇒ Array<(RecipientNamesResponse, Fixnum, Hash)>

Gets recipient names associated with an email address. Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string.

Parameters:

  • account_id —

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

  • DocuSign_eSign::ListRecipientNamesByEmailOptions —

    Options for modifying the behavior of the function.

Returns:

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

    RecipientNamesResponse data, response status code and response headers



2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2192

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

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

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

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

#list_settings(account_id) ⇒ AccountSettingsInformation

Gets account settings information. Retrieves the account settings information for the specified account.

Parameters:

  • account_id —

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

Returns:



2233
2234
2235
2236
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2233

def list_settings()
  data, _status_code, _headers = list_settings_with_http_info()
  return data
end

#list_settings_with_http_info(account_id) ⇒ Array<(AccountSettingsInformation, Fixnum, Hash)>

Gets account settings information. Retrieves the account settings information for the specified account.

Parameters:

  • account_id —

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

Returns:

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

    AccountSettingsInformation data, response status code and response headers



2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2242

def list_settings_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.list_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_settings" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings".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 = 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 => 'AccountSettingsInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#list_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_shared_access(account_id, options = DocuSign_eSign::ListSharedAccessOptions.default) ⇒ AccountSharedAccess

Reserved: Gets the shared item status for one or more users. Reserved: Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from.

Parameters:

  • account_id —

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

  • DocuSign_eSign::ListSharedAccessOptions —

    Options for modifying the behavior of the function.

Returns:



2283
2284
2285
2286
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2283

def list_shared_access(, options = DocuSign_eSign::ListSharedAccessOptions.default)
  data, _status_code, _headers = list_shared_access_with_http_info(, options)
  return data
end

#list_shared_access_with_http_info(account_id, options = DocuSign_eSign::ListSharedAccessOptions.default) ⇒ Array<(AccountSharedAccess, Fixnum, Hash)>

Reserved: Gets the shared item status for one or more users. Reserved: Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared&#x3D;shared_from.

Parameters:

  • account_id —

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

  • DocuSign_eSign::ListSharedAccessOptions —

    Options for modifying the behavior of the function.

Returns:

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

    AccountSharedAccess data, response status code and response headers



2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2293

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

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'envelopes_not_shared_user_status'] = options.envelopes_not_shared_user_status if !options.envelopes_not_shared_user_status.nil?
  query_params[:'folder_ids'] = options.folder_ids if !options.folder_ids.nil?
  query_params[:'item_type'] = options.item_type if !options.item_type.nil?
  query_params[:'search_text'] = options.search_text if !options.search_text.nil?
  query_params[:'shared'] = options.shared if !options.shared.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
  query_params[:'user_ids'] = options.user_ids if !options.user_ids.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 => 'AccountSharedAccess')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#list_shared_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_signature_providers(account_id) ⇒ AccountSignatureProviders

Returns Account available signature providers for specified account.

Parameters:

  • account_id —

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

Returns:



2341
2342
2343
2344
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2341

def list_signature_providers()
  data, _status_code, _headers = list_signature_providers_with_http_info()
  return data
end

#list_signature_providers_with_http_info(account_id) ⇒ Array<(AccountSignatureProviders, Fixnum, Hash)>

Returns Account available signature providers for specified account.

Parameters:

  • account_id —

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

Returns:

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

    AccountSignatureProviders data, response status code and response headers



2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2350

def list_signature_providers_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.list_signature_providers ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_signature_providers" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/signatureProviders".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 = 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 => 'AccountSignatureProviders')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#list_signature_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_unsupported_file_types(account_id) ⇒ FileTypeList

Gets a list of unsupported file types. Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system.

Parameters:

  • account_id —

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

Returns:



2390
2391
2392
2393
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2390

def list_unsupported_file_types()
  data, _status_code, _headers = list_unsupported_file_types_with_http_info()
  return data
end

#list_unsupported_file_types_with_http_info(account_id) ⇒ Array<(FileTypeList, Fixnum, Hash)>

Gets a list of unsupported file types. Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system.

Parameters:

  • account_id —

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

Returns:

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

    FileTypeList data, response status code and response headers



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2399

def list_unsupported_file_types_with_http_info()
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.list_unsupported_file_types ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_unsupported_file_types" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/unsupported_file_types".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 = 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 => 'FileTypeList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#list_unsupported_file_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#un_favorite_template(account_id, favorite_templates_info) ⇒ FavoriteTemplatesInfo

Unfavorite a template

Parameters:

  • account_id —

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

  • favorite_templates_info (optional parameter)

Returns:



2440
2441
2442
2443
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2440

def un_favorite_template(, favorite_templates_info)
  data, _status_code, _headers = un_favorite_template_with_http_info(,  favorite_templates_info)
  return data
end

#un_favorite_template_with_http_info(account_id, favorite_templates_info) ⇒ Array<(FavoriteTemplatesInfo, Fixnum, Hash)>

Unfavorite a template

Parameters:

  • account_id —

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

  • favorite_templates_info (optional parameter)

Returns:

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

    FavoriteTemplatesInfo data, response status code and response headers



2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2450

def un_favorite_template_with_http_info(, favorite_templates_info)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.un_favorite_template ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.un_favorite_template" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/favorite_templates".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(favorite_templates_info)
  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 => 'FavoriteTemplatesInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#un_favorite_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_account_tab_settings(account_id, tab_account_settings) ⇒ TabAccountSettings

Modifies tab settings for specified account

Parameters:

  • account_id —

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

  • tab_account_settings (optional parameter)

Returns:



2491
2492
2493
2494
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2491

def (, )
  data, _status_code, _headers = (,  )
  return data
end

#update_account_tab_settings_with_http_info(account_id, tab_account_settings) ⇒ Array<(TabAccountSettings, Fixnum, Hash)>

Modifies tab settings for specified account

Parameters:

  • account_id —

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

  • tab_account_settings (optional parameter)

Returns:

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

    TabAccountSettings data, response status code and response headers



2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2501

def (, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_account_tab_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_account_tab_settings" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/tabs".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()
  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 => 'TabAccountSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_account_tab_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_brand(account_id, brand_id, brand) ⇒ Brand

Updates an existing brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • brand (optional parameter)

Returns:



2543
2544
2545
2546
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2543

def update_brand(, brand_id, brand)
  data, _status_code, _headers = update_brand_with_http_info(, brand_id,  brand)
  return data
end

#update_brand_logo_by_type(account_id, brand_id, logo_type, logo_file_bytes) ⇒ nil

Put one branding logo.

Parameters:

  • account_id —

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

  • brand_id —

    The id of the brand.

  • logo_type —

    The type of logo. Valid values are: - ‘primary` - `secondary` - `email`

  • logo_file_bytes —

    Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places

Returns:

  • (nil) 


2599
2600
2601
2602
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2599

def update_brand_logo_by_type(, brand_id, logo_type, logo_file_bytes)
  update_brand_logo_by_type_with_http_info(, brand_id, logo_type,  logo_file_bytes)
  return nil
end

#update_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, logo_file_bytes) ⇒ Array<(nil, Fixnum, Hash)>

Put one branding logo.

Parameters:

  • account_id —

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

  • brand_id —

    The id of the brand.

  • logo_type —

    The type of logo. Valid values are: - ‘primary` - `secondary` - `email`

  • logo_file_bytes —

    Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places

Returns:

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

    nil, response status code and response headers



2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2611

def update_brand_logo_by_type_with_http_info(, brand_id, logo_type, logo_file_bytes)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_brand_logo_by_type ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_brand_logo_by_type" if .nil?
  # verify the required parameter 'brand_id' is set
  fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand_logo_by_type" if brand_id.nil?
  # verify the required parameter 'logo_type' is set
  fail ArgumentError, "Missing the required parameter 'logo_type' when calling AccountsApi.update_brand_logo_by_type" if logo_type.nil?
  # verify the required parameter 'logo_file_bytes' is set
  fail ArgumentError, "Missing the required parameter 'logo_file_bytes' when calling AccountsApi.update_brand_logo_by_type" if logo_file_bytes.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.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/png'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(logo_file_bytes)
  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: AccountsApi#update_brand_logo_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_brand_resources_by_content_type(account_id, brand_id, resource_content_type) ⇒ BrandResources

Uploads a branding resource file.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • resource_content_type

Returns:



2660
2661
2662
2663
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2660

def update_brand_resources_by_content_type(, brand_id, resource_content_type)
  data, _status_code, _headers = update_brand_resources_by_content_type_with_http_info(, brand_id, resource_content_type)
  return data
end

#update_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type) ⇒ Array<(BrandResources, Fixnum, Hash)>

Uploads a branding resource file.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • resource_content_type

Returns:

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

    BrandResources data, response status code and response headers



2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2671

def update_brand_resources_by_content_type_with_http_info(, brand_id, resource_content_type)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_brand_resources_by_content_type ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_brand_resources_by_content_type" if .nil?
  # verify the required parameter 'brand_id' is set
  fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand_resources_by_content_type" if brand_id.nil?
  # verify the required parameter 'resource_content_type' is set
  fail ArgumentError, "Missing the required parameter 'resource_content_type' when calling AccountsApi.update_brand_resources_by_content_type" if resource_content_type.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'resourceContentType' + '}', resource_content_type.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(: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 => 'BrandResources')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_brand_resources_by_content_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_brand_with_http_info(account_id, brand_id, brand) ⇒ Array<(Brand, Fixnum, Hash)>

Updates an existing brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • brand (optional parameter)

Returns:

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

    Brand data, response status code and response headers



2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2554

def update_brand_with_http_info(, brand_id, brand)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_brand ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_brand" if .nil?
  # verify the required parameter 'brand_id' is set
  fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand" if brand_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'brandId' + '}', brand_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(brand)
  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 => 'Brand')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_brand\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_consumer_disclosure(account_id, lang_code, consumer_disclosure, options = DocuSign_eSign::UpdateConsumerDisclosureOptions.default) ⇒ ConsumerDisclosure

Update Consumer Disclosure.

Parameters:

  • account_id —

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

  • lang_code —

    The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.

  • consumer_disclosure (optional parameter)
  • DocuSign_eSign::UpdateConsumerDisclosureOptions —

    Options for modifying the behavior of the function.

Returns:



2718
2719
2720
2721
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2718

def update_consumer_disclosure(, lang_code, consumer_disclosure, options = DocuSign_eSign::UpdateConsumerDisclosureOptions.default)
  data, _status_code, _headers = update_consumer_disclosure_with_http_info(, lang_code,  consumer_disclosure, options)
  return data
end

#update_consumer_disclosure_with_http_info(account_id, lang_code, consumer_disclosure, options = DocuSign_eSign::UpdateConsumerDisclosureOptions.default) ⇒ Array<(ConsumerDisclosure, Fixnum, Hash)>

Update Consumer Disclosure.

Parameters:

  • account_id —

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

  • lang_code —

    The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.

  • consumer_disclosure (optional parameter)
  • DocuSign_eSign::UpdateConsumerDisclosureOptions —

    Options for modifying the behavior of the function.

Returns:

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

    ConsumerDisclosure data, response status code and response headers



2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2730

def update_consumer_disclosure_with_http_info(, lang_code, consumer_disclosure, options = DocuSign_eSign::UpdateConsumerDisclosureOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_consumer_disclosure ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_consumer_disclosure" if .nil?
  # verify the required parameter 'lang_code' is set
  fail ArgumentError, "Missing the required parameter 'lang_code' when calling AccountsApi.update_consumer_disclosure" if lang_code.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'langCode' + '}', lang_code.to_s)

  # query parameters
  query_params = {}
  query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.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(consumer_disclosure)
  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 => 'ConsumerDisclosure')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_consumer_disclosure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_custom_field(account_id, custom_field_id, custom_field, options = DocuSign_eSign::UpdateCustomFieldOptions.default) ⇒ CustomFields

Updates an existing account custom field.

Parameters:

  • account_id —

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

  • custom_field_id
  • custom_field (optional parameter)
  • DocuSign_eSign::UpdateCustomFieldOptions —

    Options for modifying the behavior of the function.

Returns:



2776
2777
2778
2779
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2776

def update_custom_field(, custom_field_id, custom_field, options = DocuSign_eSign::UpdateCustomFieldOptions.default)
  data, _status_code, _headers = update_custom_field_with_http_info(, custom_field_id,  custom_field, options)
  return data
end

#update_custom_field_with_http_info(account_id, custom_field_id, custom_field, options = DocuSign_eSign::UpdateCustomFieldOptions.default) ⇒ Array<(CustomFields, Fixnum, Hash)>

Updates an existing account custom field.

Parameters:

  • account_id —

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

  • custom_field_id
  • custom_field (optional parameter)
  • DocuSign_eSign::UpdateCustomFieldOptions —

    Options for modifying the behavior of the function.

Returns:

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

    CustomFields data, response status code and response headers



2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2788

def update_custom_field_with_http_info(, custom_field_id, custom_field, options = DocuSign_eSign::UpdateCustomFieldOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_custom_field ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_custom_field" if .nil?
  # verify the required parameter 'custom_field_id' is set
  fail ArgumentError, "Missing the required parameter 'custom_field_id' when calling AccountsApi.update_custom_field" if custom_field_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/custom_fields/{customFieldId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'customFieldId' + '}', custom_field_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'apply_to_templates'] = options.apply_to_templates if !options.apply_to_templates.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(custom_field)
  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 => 'CustomFields')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_e_note_configuration(account_id, e_note_configuration) ⇒ ENoteConfiguration

Updates configuration information for the eNote eOriginal integration.

Parameters:

  • account_id —

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

  • e_note_configuration (optional parameter)

Returns:



2832
2833
2834
2835
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2832

def update_e_note_configuration(, e_note_configuration)
  data, _status_code, _headers = update_e_note_configuration_with_http_info(,  e_note_configuration)
  return data
end

#update_e_note_configuration_with_http_info(account_id, e_note_configuration) ⇒ Array<(ENoteConfiguration, Fixnum, Hash)>

Updates configuration information for the eNote eOriginal integration.

Parameters:

  • account_id —

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

  • e_note_configuration (optional parameter)

Returns:

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

    ENoteConfiguration data, response status code and response headers



2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2842

def update_e_note_configuration_with_http_info(, e_note_configuration)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_e_note_configuration ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_e_note_configuration" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/enote_configuration".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(e_note_configuration)
  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 => 'ENoteConfiguration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_e_note_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_envelope_purge_configuration(account_id, envelope_purge_configuration) ⇒ EnvelopePurgeConfiguration

Updates envelope purge configuration.

Parameters:

  • account_id —

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

  • envelope_purge_configuration (optional parameter)

Returns:



2883
2884
2885
2886
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2883

def update_envelope_purge_configuration(, envelope_purge_configuration)
  data, _status_code, _headers = update_envelope_purge_configuration_with_http_info(,  envelope_purge_configuration)
  return data
end

#update_envelope_purge_configuration_with_http_info(account_id, envelope_purge_configuration) ⇒ Array<(EnvelopePurgeConfiguration, Fixnum, Hash)>

Updates envelope purge configuration.

Parameters:

  • account_id —

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

  • envelope_purge_configuration (optional parameter)

Returns:

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

    EnvelopePurgeConfiguration data, response status code and response headers



2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2893

def update_envelope_purge_configuration_with_http_info(, envelope_purge_configuration)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_envelope_purge_configuration ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_envelope_purge_configuration" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/envelope_purge_configuration".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(envelope_purge_configuration)
  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 => 'EnvelopePurgeConfiguration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_envelope_purge_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_favorite_template(account_id, favorite_templates_info) ⇒ FavoriteTemplatesInfo

Favorites a template

Parameters:

  • account_id —

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

  • favorite_templates_info (optional parameter)

Returns:



2934
2935
2936
2937
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2934

def update_favorite_template(, favorite_templates_info)
  data, _status_code, _headers = update_favorite_template_with_http_info(,  favorite_templates_info)
  return data
end

#update_favorite_template_with_http_info(account_id, favorite_templates_info) ⇒ Array<(FavoriteTemplatesInfo, Fixnum, Hash)>

Favorites a template

Parameters:

  • account_id —

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

  • favorite_templates_info (optional parameter)

Returns:

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

    FavoriteTemplatesInfo data, response status code and response headers



2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2944

def update_favorite_template_with_http_info(, favorite_templates_info)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_favorite_template ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_favorite_template" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/favorite_templates".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(favorite_templates_info)
  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 => 'FavoriteTemplatesInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_favorite_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_notification_defaults(account_id, notification_defaults) ⇒ NotificationDefaults

Updates default user level settings for a specified account

Parameters:

  • account_id —

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

  • notification_defaults (optional parameter)

Returns:



2985
2986
2987
2988
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2985

def update_notification_defaults(, notification_defaults)
  data, _status_code, _headers = update_notification_defaults_with_http_info(,  notification_defaults)
  return data
end

#update_notification_defaults_with_http_info(account_id, notification_defaults) ⇒ Array<(NotificationDefaults, Fixnum, Hash)>

Updates default user level settings for a specified account

Parameters:

  • account_id —

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

  • notification_defaults (optional parameter)

Returns:

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

    NotificationDefaults data, response status code and response headers



2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2995

def update_notification_defaults_with_http_info(, notification_defaults)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_notification_defaults ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_notification_defaults" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/notification_defaults".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(notification_defaults)
  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 => 'NotificationDefaults')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_notification_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_password_rules(account_id, account_password_rules) ⇒ AccountPasswordRules

Update the password rules

Parameters:

  • account_id —

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

  • account_password_rules (optional parameter)

Returns:



3036
3037
3038
3039
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3036

def update_password_rules(, )
  data, _status_code, _headers = update_password_rules_with_http_info(,  )
  return data
end

#update_password_rules_with_http_info(account_id, account_password_rules) ⇒ Array<(AccountPasswordRules, Fixnum, Hash)>

Update the password rules

Parameters:

  • account_id —

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

  • account_password_rules (optional parameter)

Returns:

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

    AccountPasswordRules data, response status code and response headers



3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3046

def update_password_rules_with_http_info(, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_password_rules ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_password_rules" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/password_rules".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()
  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 => 'AccountPasswordRules')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_password_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_permission_profile(account_id, permission_profile_id, permission_profile, options = DocuSign_eSign::UpdatePermissionProfileOptions.default) ⇒ PermissionProfile

Updates a permission profile within the specified account.

Parameters:

  • account_id —

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

  • permission_profile_id
  • permission_profile (optional parameter)
  • DocuSign_eSign::UpdatePermissionProfileOptions —

    Options for modifying the behavior of the function.

Returns:



3089
3090
3091
3092
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3089

def update_permission_profile(, permission_profile_id, permission_profile, options = DocuSign_eSign::UpdatePermissionProfileOptions.default)
  data, _status_code, _headers = update_permission_profile_with_http_info(, permission_profile_id,  permission_profile, options)
  return data
end

#update_permission_profile_with_http_info(account_id, permission_profile_id, permission_profile, options = DocuSign_eSign::UpdatePermissionProfileOptions.default) ⇒ Array<(PermissionProfile, Fixnum, Hash)>

Updates a permission profile within the specified account.

Parameters:

  • account_id —

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

  • permission_profile_id
  • permission_profile (optional parameter)
  • DocuSign_eSign::UpdatePermissionProfileOptions —

    Options for modifying the behavior of the function.

Returns:

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

    PermissionProfile data, response status code and response headers



3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3101

def update_permission_profile_with_http_info(, permission_profile_id, permission_profile, options = DocuSign_eSign::UpdatePermissionProfileOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_permission_profile ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_permission_profile" if .nil?
  # verify the required parameter 'permission_profile_id' is set
  fail ArgumentError, "Missing the required parameter 'permission_profile_id' when calling AccountsApi.update_permission_profile" if permission_profile_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include'] = options.include if !options.include.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(permission_profile)
  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 => 'PermissionProfile')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_permission_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_settings(account_id, account_settings_information) ⇒ nil

Updates the account settings for an account. Updates the account settings for the specified account.

Parameters:

  • account_id —

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

  • account_settings_information (optional parameter)

Returns:

  • (nil) 


3145
3146
3147
3148
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3145

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

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

Updates the account settings for an account. Updates the account settings for the specified account.

Parameters:

  • account_id —

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

  • account_settings_information (optional parameter)

Returns:

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

    nil, response status code and response headers



3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3155

def update_settings_with_http_info(, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_settings ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_settings" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings".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()
  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: AccountsApi#update_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_shared_access(account_id, account_shared_access, options = DocuSign_eSign::UpdateSharedAccessOptions.default) ⇒ AccountSharedAccess

Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users.

Parameters:

  • account_id —

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

  • account_shared_access (optional parameter)
  • DocuSign_eSign::UpdateSharedAccessOptions —

    Options for modifying the behavior of the function.

Returns:



3196
3197
3198
3199
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3196

def update_shared_access(, , options = DocuSign_eSign::UpdateSharedAccessOptions.default)
  data, _status_code, _headers = update_shared_access_with_http_info(,  , options)
  return data
end

#update_shared_access_with_http_info(account_id, account_shared_access, options = DocuSign_eSign::UpdateSharedAccessOptions.default) ⇒ Array<(AccountSharedAccess, Fixnum, Hash)>

Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users.

Parameters:

  • account_id —

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

  • account_shared_access (optional parameter)
  • DocuSign_eSign::UpdateSharedAccessOptions —

    Options for modifying the behavior of the function.

Returns:

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

    AccountSharedAccess data, response status code and response headers



3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3207

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

  # query parameters
  query_params = {}
  query_params[:'item_type'] = options.item_type if !options.item_type.nil?
  query_params[:'preserve_existing_shared_access'] = options.preserve_existing_shared_access if !options.preserve_existing_shared_access.nil?
  query_params[:'user_ids'] = options.user_ids if !options.user_ids.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(: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 => 'AccountSharedAccess')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_shared_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_watermark(account_id, watermark) ⇒ Watermark

Update watermark information.

Parameters:

  • account_id —

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

  • watermark (optional parameter)

Returns:



3251
3252
3253
3254
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3251

def update_watermark(, watermark)
  data, _status_code, _headers = update_watermark_with_http_info(,  watermark)
  return data
end

#update_watermark_with_http_info(account_id, watermark) ⇒ Array<(Watermark, Fixnum, Hash)>

Update watermark information.

Parameters:

  • account_id —

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

  • watermark (optional parameter)

Returns:

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

    Watermark data, response status code and response headers



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3261

def update_watermark_with_http_info(, watermark)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_watermark ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_watermark" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/watermark".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(watermark)
  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 => 'Watermark')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_watermark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end