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.



365
366
367
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 365

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



363
364
365
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 363

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 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:



374
375
376
377
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 374

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

#create_account_signatures(account_id, account_signatures_information, options = DocuSign_eSign::CreateAccountSignaturesOptions.default) ⇒ AccountSignaturesInformation

Adds/updates one or more account signatures. This request may include images in multi-part format.

Parameters:

  • account_id —

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

  • account_signatures_information (optional parameter)
  • DocuSign_eSign::CreateAccountSignaturesOptions —

    Options for modifying the behavior of the function.

Returns:



425
426
427
428
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 425

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

#create_account_signatures_with_http_info(account_id, account_signatures_information, options = DocuSign_eSign::CreateAccountSignaturesOptions.default) ⇒ Array<(AccountSignaturesInformation, Fixnum, Hash)>

Adds/updates one or more account signatures. This request may include images in multi-part format.

Parameters:

  • account_id —

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

  • account_signatures_information (optional parameter)
  • DocuSign_eSign::CreateAccountSignaturesOptions —

    Options for modifying the behavior of the function.

Returns:



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 436

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

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



478
479
480
481
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 478

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 `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:

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

    BrandsResponse data, response status code and response headers



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 488

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. This method creates a custom field and makes it available for all new envelopes associated with an account.

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:



530
531
532
533
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 530

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. This method creates a custom field and makes it available for all new envelopes associated with an account.

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



541
542
543
544
545
546
547
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
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 541

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. This method creates a new permission profile for an account. ### Related topics - How to create a permission profile

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:



584
585
586
587
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 584

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. This method creates a new permission profile for an account. ### Related topics - How to create a permission profile

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



595
596
597
598
599
600
601
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
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 595

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_user_authorization(account_id, user_id, user_authorization_create_request) ⇒ UserAuthorization

Creates the user authorization

Parameters:

  • account_id —

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

  • user_id —

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

  • user_authorization_create_request (optional parameter)

Returns:



638
639
640
641
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 638

def create_user_authorization(, user_id, user_authorization_create_request)
  data, _status_code, _headers = create_user_authorization_with_http_info(, user_id,  user_authorization_create_request)
  return data
end

#create_user_authorization_with_http_info(account_id, user_id, user_authorization_create_request) ⇒ Array<(UserAuthorization, Fixnum, Hash)>

Creates the user authorization

Parameters:

  • account_id —

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

  • user_id —

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

  • user_authorization_create_request (optional parameter)

Returns:

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

    UserAuthorization data, response status code and response headers



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 649

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#create_user_authorizations(account_id, user_id, user_authorizations_request) ⇒ UserAuthorizationsResponse

Creates ot updates user authorizations

Parameters:

  • account_id —

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

  • user_id —

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

  • user_authorizations_request (optional parameter)

Returns:



693
694
695
696
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 693

def create_user_authorizations(, user_id, user_authorizations_request)
  data, _status_code, _headers = create_user_authorizations_with_http_info(, user_id,  user_authorizations_request)
  return data
end

#create_user_authorizations_with_http_info(account_id, user_id, user_authorizations_request) ⇒ Array<(UserAuthorizationsResponse, Fixnum, Hash)>

Creates ot updates user authorizations

Parameters:

  • account_id —

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

  • user_id —

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

  • user_authorizations_request (optional parameter)

Returns:

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

    UserAuthorizationsResponse data, response status code and response headers



704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 704

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(user_authorizations_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserAuthorizationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#create_user_authorizations\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 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:

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

    NewAccountSummary data, response status code and response headers



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 384

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, options = DocuSign_eSign::DeleteOptions.default) ⇒ 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.

  • DocuSign_eSign::DeleteOptions —

    Options for modifying the behavior of the function.

Returns:

  • (nil) 


747
748
749
750
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 747

def delete(, options = DocuSign_eSign::DeleteOptions.default)
  delete_with_http_info(, options)
  return nil
end

#delete_account_signature(account_id, signature_id) ⇒ nil

Close the specified signature by Id.

Parameters:

  • account_id —

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

  • signature_id —

    The ID of the signature being accessed.

Returns:

  • (nil) 


798
799
800
801
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 798

def (, signature_id)
  (, signature_id)
  return nil
end

#delete_account_signature_image(account_id, image_type, signature_id) ⇒ AccountSignature

Deletes a signature, initials, or stamps image.

Parameters:

  • account_id —

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

  • image_type —

    One of signature_image or initials_image.

  • signature_id —

    The ID of the signature being accessed.

Returns:



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

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

#delete_account_signature_image_with_http_info(account_id, image_type, signature_id) ⇒ Array<(AccountSignature, Fixnum, Hash)>

Deletes a signature, initials, or stamps image.

Parameters:

  • account_id —

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

  • image_type —

    One of signature_image or initials_image.

  • signature_id —

    The ID of the signature being accessed.

Returns:

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

    AccountSignature data, response status code and response headers



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
896
897
898
899
900
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 862

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Close the specified signature by Id.

Parameters:

  • account_id —

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

  • signature_id —

    The ID of the signature being accessed.

Returns:

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

    nil, response status code and response headers



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

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

#delete_brand(account_id, brand_id) ⇒ nil

Removes a brand. This method deletes a brand from an account. Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

Returns:

  • (nil) 


907
908
909
910
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 907

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. This method deletes a single logo from an account brand. Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

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) 


960
961
962
963
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 960

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. This method deletes a single logo from an account brand. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).

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



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
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 971

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. This method deletes a brand from an account. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).

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



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
948
949
950
951
952
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 917

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:



1015
1016
1017
1018
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1015

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 `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:

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

    BrandsResponse data, response status code and response headers



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1025

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:



1067
1068
1069
1070
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1067

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:



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

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. This method deletes 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) 


1122
1123
1124
1125
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1122

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. This method deletes 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



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

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) 


1175
1176
1177
1178
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1175

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



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

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, options = DocuSign_eSign::DeletePermissionProfileOptions.default) ⇒ nil

Deletes a permissions profile within the specified account. This method deletes a permission profile from an account. To delete a permission profile, it must not have any users associated with it. When you use this method to delete a permission profile, you can reassign the users associated with it to a new permission profile at the same time by using the move_users_to query parameter. ### Related topics - How to delete a permission profile

Parameters:

  • account_id —

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

  • permission_profile_id
  • DocuSign_eSign::DeletePermissionProfileOptions —

    Options for modifying the behavior of the function.

Returns:

  • (nil) 


1225
1226
1227
1228
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1225

def delete_permission_profile(, permission_profile_id, options = DocuSign_eSign::DeletePermissionProfileOptions.default)
  delete_permission_profile_with_http_info(, permission_profile_id, options)
  return nil
end

#delete_permission_profile_with_http_info(account_id, permission_profile_id, options = DocuSign_eSign::DeletePermissionProfileOptions.default) ⇒ Array<(nil, Fixnum, Hash)>

Deletes a permissions profile within the specified account. This method deletes a permission profile from an account. To delete a permission profile, it must not have any users associated with it. When you use this method to delete a permission profile, you can reassign the users associated with it to a new permission profile at the same time by using the `move_users_to` query parameter. ### Related topics - How to delete a permission profile

Parameters:

  • account_id —

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

  • permission_profile_id
  • DocuSign_eSign::DeletePermissionProfileOptions —

    Options for modifying the behavior of the function.

Returns:

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

    nil, response status code and response headers



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

def delete_permission_profile_with_http_info(, permission_profile_id, options = DocuSign_eSign::DeletePermissionProfileOptions.default)
  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 = {}
  query_params[:'move_users_to'] = options.move_users_to if !options.move_users_to.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_permission_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_user_authorization(account_id, authorization_id, user_id) ⇒ nil

Deletes the user authorization

Parameters:

  • account_id —

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

  • authorization_id
  • user_id —

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

Returns:

  • (nil) 


1280
1281
1282
1283
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1280

def delete_user_authorization(, authorization_id, user_id)
  delete_user_authorization_with_http_info(, authorization_id, user_id)
  return nil
end

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

Deletes the user authorization

Parameters:

  • account_id —

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

  • authorization_id
  • user_id —

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

Returns:

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

    nil, response status code and response headers



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

def delete_user_authorization_with_http_info(, authorization_id, user_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.delete_user_authorization ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_user_authorization" if .nil?
  # verify the required parameter 'authorization_id' is set
  fail ArgumentError, "Missing the required parameter 'authorization_id' when calling AccountsApi.delete_user_authorization" if authorization_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.delete_user_authorization" if user_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'authorizationId' + '}', authorization_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#delete_user_authorizations(account_id, user_id, user_authorizations_delete_request) ⇒ UserAuthorizationsDeleteResponse

Creates ot updates user authorizations

Parameters:

  • account_id —

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

  • user_id —

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

  • user_authorizations_delete_request (optional parameter)

Returns:



1336
1337
1338
1339
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1336

def delete_user_authorizations(, user_id, user_authorizations_delete_request)
  data, _status_code, _headers = delete_user_authorizations_with_http_info(, user_id,  user_authorizations_delete_request)
  return data
end

#delete_user_authorizations_with_http_info(account_id, user_id, user_authorizations_delete_request) ⇒ Array<(UserAuthorizationsDeleteResponse, Fixnum, Hash)>

Creates ot updates user authorizations

Parameters:

  • account_id —

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

  • user_id —

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

  • user_authorizations_delete_request (optional parameter)

Returns:



1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1347

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#delete_with_http_info(account_id, options = DocuSign_eSign::DeleteOptions.default) ⇒ 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.

  • DocuSign_eSign::DeleteOptions —

    Options for modifying the behavior of the function.

Returns:

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

    nil, response status code and response headers



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

def delete_with_http_info(, options = DocuSign_eSign::DeleteOptions.default)
  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 = {}
  query_params[:'redact_user_data'] = options.redact_user_data if !options.redact_user_data.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\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_identity_verification(account_id, options = DocuSign_eSign::GetAccountIdentityVerificationOptions.default) ⇒ AccountIdentityVerificationResponse

Get the list of identity verification options for an account This method returns a list of Identity Verification workflows that are available to an account. Note: To use this method, you must either be an account administrator or a sender. ### Related topics - How to require ID Verification (IDV) for a recipient

Parameters:

  • account_id —

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

  • DocuSign_eSign::GetAccountIdentityVerificationOptions —

    Options for modifying the behavior of the function.

Returns:



1390
1391
1392
1393
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1390

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

#get_account_identity_verification_with_http_info(account_id, options = DocuSign_eSign::GetAccountIdentityVerificationOptions.default) ⇒ Array<(AccountIdentityVerificationResponse, Fixnum, Hash)>

Get the list of identity verification options for an account This method returns a list of Identity Verification workflows that are available to an account. Note: To use this method, you must either be an account administrator or a sender. ### Related topics - How to require ID Verification (IDV) for a recipient

Parameters:

  • account_id —

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

  • DocuSign_eSign::GetAccountIdentityVerificationOptions —

    Options for modifying the behavior of the function.

Returns:



1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1400

def (, options = DocuSign_eSign::GetAccountIdentityVerificationOptions.default)
  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 = {}
  query_params[:'identity_verification_workflow_status'] = options.identity_verification_workflow_status if !options.identity_verification_workflow_status.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 => '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:



1442
1443
1444
1445
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1442

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 `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:

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

    AccountInformation data, response status code and response headers



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

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?
  query_params[:'include_trial_eligibility'] = options.include_trial_eligibility if !options.include_trial_eligibility.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_signature(account_id, signature_id) ⇒ AccountSignature

Returns information about a single signature by specifed signatureId.

Parameters:

  • account_id —

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

  • signature_id —

    The ID of the signature being accessed.

Returns:



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

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

#get_account_signature_image(account_id, image_type, signature_id, options = DocuSign_eSign::GetAccountSignatureImageOptions.default) ⇒ File

Returns a signature, initials, or stamps image.

Parameters:

  • account_id —

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

  • image_type —

    One of signature_image or initials_image.

  • signature_id —

    The ID of the signature being accessed.

  • DocuSign_eSign::GetAccountSignatureImageOptions —

    Options for modifying the behavior of the function.

Returns:

  • (File) 


1550
1551
1552
1553
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1550

def (, image_type, signature_id, options = DocuSign_eSign::GetAccountSignatureImageOptions.default)
  data, _status_code, _headers = (, image_type, signature_id, options)
  return data
end

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

Returns a signature, initials, or stamps image.

Parameters:

  • account_id —

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

  • image_type —

    One of signature_image or initials_image.

  • signature_id —

    The ID of the signature being accessed.

  • DocuSign_eSign::GetAccountSignatureImageOptions —

    Options for modifying the behavior of the function.

Returns:

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

    File data, response status code and response headers



1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1562

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

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

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

  # form parameters
  form_params = {}

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

#get_account_signature_with_http_info(account_id, signature_id) ⇒ Array<(AccountSignature, Fixnum, Hash)>

Returns information about a single signature by specifed signatureId.

Parameters:

  • account_id —

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

  • signature_id —

    The ID of the signature being accessed.

Returns:

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

    AccountSignature data, response status code and response headers



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
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1505

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

#get_account_signatures(account_id, options = DocuSign_eSign::GetAccountSignaturesOptions.default) ⇒ AccountSignaturesInformation

Returns the managed signature definitions for the account

Parameters:

  • account_id —

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

  • DocuSign_eSign::GetAccountSignaturesOptions —

    Options for modifying the behavior of the function.

Returns:



1608
1609
1610
1611
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1608

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

#get_account_signatures_with_http_info(account_id, options = DocuSign_eSign::GetAccountSignaturesOptions.default) ⇒ Array<(AccountSignaturesInformation, Fixnum, Hash)>

Returns the managed signature definitions for the account

Parameters:

  • account_id —

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

  • DocuSign_eSign::GetAccountSignaturesOptions —

    Options for modifying the behavior of the function.

Returns:



1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1618

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

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AccountSignaturesInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_account_signatures\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 This method returns information about the tab types and tab functionality that is currently enabled for an account.

Parameters:

  • account_id —

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

Returns:



1661
1662
1663
1664
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1661

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 This method returns information about the tab types and tab functionality that is currently enabled for an 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



1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1670

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_agent_user_authorizations(account_id, user_id, options = DocuSign_eSign::GetAgentUserAuthorizationsOptions.default) ⇒ UserAuthorizations

Returns the agent user authorizations

Parameters:

  • account_id —

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

  • user_id —

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

  • DocuSign_eSign::GetAgentUserAuthorizationsOptions —

    Options for modifying the behavior of the function.

Returns:



1712
1713
1714
1715
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1712

def get_agent_user_authorizations(, user_id, options = DocuSign_eSign::GetAgentUserAuthorizationsOptions.default)
  data, _status_code, _headers = get_agent_user_authorizations_with_http_info(, user_id, options)
  return data
end

#get_agent_user_authorizations_with_http_info(account_id, user_id, options = DocuSign_eSign::GetAgentUserAuthorizationsOptions.default) ⇒ Array<(UserAuthorizations, Fixnum, Hash)>

Returns the agent user authorizations

Parameters:

  • account_id —

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

  • user_id —

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

  • DocuSign_eSign::GetAgentUserAuthorizationsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    UserAuthorizations data, response status code and response headers



1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1723

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

  # query parameters
  query_params = {}
  query_params[:'active_only'] = options.active_only if !options.active_only.nil?
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'email_substring'] = options.email_substring if !options.email_substring.nil?
  query_params[:'include_closed_users'] = options.include_closed_users if !options.include_closed_users.nil?
  query_params[:'permissions'] = options.permissions if !options.permissions.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
  query_params[:'task_source'] = options.task_source if !options.task_source.nil?
  query_params[:'task_type'] = options.task_type if !options.task_type.nil?
  query_params[:'user_name_substring'] = options.user_name_substring if !options.user_name_substring.nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserAuthorizations')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_agent_user_authorizations\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 This method returns a list of payment gateway accounts and basic information about them.

Parameters:

  • account_id —

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

Returns:



1774
1775
1776
1777
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1774

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 This method returns a list of payment gateway accounts and basic information about them.

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



1783
1784
1785
1786
1787
1788
1789
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
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1783

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:



1824
1825
1826
1827
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1824

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



1834
1835
1836
1837
1838
1839
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
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1834

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. This method returns details about an account brand. Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

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:



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

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. This method exports information about a brand to an XML file. Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

Returns:

  • (nil) 


1933
1934
1935
1936
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1933

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. This method exports information about a brand to an XML file. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).

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



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
1971
1972
1973
1974
1975
1976
1977
1978
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1943

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. This method returns a specific logo that is used in a brand. Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

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) 


1986
1987
1988
1989
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1986

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. This method returns a specific logo that is used in a brand. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).

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



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
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1997

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). This method returns metadata about the branding resources that are associated with an account. Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

Returns:



2042
2043
2044
2045
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2042

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. This method returns a specific branding resource file. A brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience. Important: When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

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) 


2097
2098
2099
2100
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2097

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. This method returns a specific branding resource file. A brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience. Important: When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).

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



2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2109

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's list of branding resources (metadata). This method returns metadata about the branding resources that are associated with an account. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).

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



2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2052

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. This method returns details about an account brand. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).

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



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
1922
1923
1924
1925
1926
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1888

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), Armenian (hy), 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:



2155
2156
2157
2158
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2155

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:



2208
2209
2210
2211
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2208

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



2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2218

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), Armenian (hy), 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



2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2165

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:



2259
2260
2261
2262
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2259

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



2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2268

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. An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (retentionDays). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator.

Parameters:

  • account_id —

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

Returns:



2308
2309
2310
2311
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2308

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. An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator.

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



2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2317

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:



2357
2358
2359
2360
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2357

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



2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2366

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 This method returns the default settings for the email notifications that signers and senders receive about envelopes.

Parameters:

  • account_id —

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

Returns:



2406
2407
2408
2409
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2406

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 This method returns the default settings for the email notifications that signers and senders receive about envelopes.

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



2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2415

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 This method retrieves the password rules for an account.

Parameters:

  • account_id —

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

Returns:



2455
2456
2457
2458
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2455

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:



2503
2504
2505
2506
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2503

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



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
2536
2537
2538
2539
2540
2541
2542
2543
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2511

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 This method retrieves the password rules for an account.

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



2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2464

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. This method returns information about a specific permission profile that is associated with an account. ### Related topics - How to set a permission profile

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:



2551
2552
2553
2554
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2551

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. This method returns information about a specific permission profile that is associated with an account. ### Related topics - How to set a permission profile

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



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
2591
2592
2593
2594
2595
2596
2597
2598
2599
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2562

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_principal_user_authorizations(account_id, user_id, options = DocuSign_eSign::GetPrincipalUserAuthorizationsOptions.default) ⇒ UserAuthorizations

Returns the principal user authorizations

Parameters:

  • account_id —

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

  • user_id —

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

  • DocuSign_eSign::GetPrincipalUserAuthorizationsOptions —

    Options for modifying the behavior of the function.

Returns:



2607
2608
2609
2610
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2607

def get_principal_user_authorizations(, user_id, options = DocuSign_eSign::GetPrincipalUserAuthorizationsOptions.default)
  data, _status_code, _headers = get_principal_user_authorizations_with_http_info(, user_id, options)
  return data
end

#get_principal_user_authorizations_with_http_info(account_id, user_id, options = DocuSign_eSign::GetPrincipalUserAuthorizationsOptions.default) ⇒ Array<(UserAuthorizations, Fixnum, Hash)>

Returns the principal user authorizations

Parameters:

  • account_id —

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

  • user_id —

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

  • DocuSign_eSign::GetPrincipalUserAuthorizationsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    UserAuthorizations data, response status code and response headers



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
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2618

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

  # query parameters
  query_params = {}
  query_params[:'active_only'] = options.active_only if !options.active_only.nil?
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'email_substring'] = options.email_substring if !options.email_substring.nil?
  query_params[:'include_closed_users'] = options.include_closed_users if !options.include_closed_users.nil?
  query_params[:'permissions'] = options.permissions if !options.permissions.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
  query_params[:'task_source'] = options.task_source if !options.task_source.nil?
  query_params[:'task_type'] = options.task_type if !options.task_type.nil?
  query_params[:'user_name_substring'] = options.user_name_substring if !options.user_name_substring.nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserAuthorizations')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_principal_user_authorizations\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:



2668
2669
2670
2671
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2668

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



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

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. Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient. For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. Note: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the emailBody and emailSubject of the notification is not translated, and appears exactly as you enter it. For more information, see Set Recipient Language and Specify Custom Email Messages.

Parameters:

  • account_id —

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

Returns:



2714
2715
2716
2717
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2714

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. Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient. For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. Note: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. For more information, see Set Recipient Language and Specify Custom Email Messages.

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



2723
2724
2725
2726
2727
2728
2729
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
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2723

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_user_authorization(account_id, authorization_id, user_id) ⇒ UserAuthorization

Returns the user authorization for a given authorization id

Parameters:

  • account_id —

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

  • authorization_id
  • user_id —

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

Returns:



2765
2766
2767
2768
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2765

def get_user_authorization(, authorization_id, user_id)
  data, _status_code, _headers = get_user_authorization_with_http_info(, authorization_id, user_id)
  return data
end

#get_user_authorization_with_http_info(account_id, authorization_id, user_id) ⇒ Array<(UserAuthorization, Fixnum, Hash)>

Returns the user authorization for a given authorization id

Parameters:

  • account_id —

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

  • authorization_id
  • user_id —

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

Returns:

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

    UserAuthorization data, response status code and response headers



2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
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
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2776

def get_user_authorization_with_http_info(, authorization_id, user_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.get_user_authorization ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_user_authorization" if .nil?
  # verify the required parameter 'authorization_id' is set
  fail ArgumentError, "Missing the required parameter 'authorization_id' when calling AccountsApi.get_user_authorization" if authorization_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.get_user_authorization" if user_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'authorizationId' + '}', authorization_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserAuthorization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_user_authorization\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:



2820
2821
2822
2823
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2820

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:



2870
2871
2872
2873
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2870

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



2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2880

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



2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2829

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:



2921
2922
2923
2924
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2921

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 `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:

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

    BrandsResponse data, response status code and response headers



2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2931

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:



2973
2974
2975
2976
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2973

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



2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2982

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:



3023
3024
3025
3026
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3023

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:



3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3033

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_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:



3074
3075
3076
3077
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3074

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



3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3083

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:



3124
3125
3126
3127
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3124

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=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



3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3134

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. Returns a list of signature providers that the specified account can use.

Parameters:

  • account_id —

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

Returns:



3182
3183
3184
3185
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3182

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. Returns a list of signature providers that the specified account can use.

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



3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3191

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:



3231
3232
3233
3234
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3231

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



3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3240

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:



3281
3282
3283
3284
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3281

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



3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3291

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_signature(account_id, account_signatures_information) ⇒ AccountSignaturesInformation

Updates a account signature.

Parameters:

  • account_id —

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

  • account_signatures_information (optional parameter)

Returns:



3332
3333
3334
3335
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3332

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

#update_account_signature_by_id(account_id, signature_id, account_signature_definition, options = DocuSign_eSign::UpdateAccountSignatureByIdOptions.default) ⇒ AccountSignature

Updates a account signature.

Parameters:

  • account_id —

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

  • signature_id —

    The ID of the signature being accessed.

  • account_signature_definition (optional parameter)
  • DocuSign_eSign::UpdateAccountSignatureByIdOptions —

    Options for modifying the behavior of the function.

Returns:



3385
3386
3387
3388
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3385

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

#update_account_signature_by_id_with_http_info(account_id, signature_id, account_signature_definition, options = DocuSign_eSign::UpdateAccountSignatureByIdOptions.default) ⇒ Array<(AccountSignature, Fixnum, Hash)>

Updates a account signature.

Parameters:

  • account_id —

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

  • signature_id —

    The ID of the signature being accessed.

  • account_signature_definition (optional parameter)
  • DocuSign_eSign::UpdateAccountSignatureByIdOptions —

    Options for modifying the behavior of the function.

Returns:

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

    AccountSignature data, response status code and response headers



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3397

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

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

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

  # form parameters
  form_params = {}

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

#update_account_signature_image(account_id, image_type, signature_id, options = DocuSign_eSign::UpdateAccountSignatureImageOptions.default) ⇒ AccountSignature

Sets a signature, initials, or stamps image.

Parameters:

  • account_id —

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

  • image_type —

    One of signature_image or initials_image.

  • signature_id —

    The ID of the signature being accessed.

  • DocuSign_eSign::UpdateAccountSignatureImageOptions —

    Options for modifying the behavior of the function.

Returns:



3443
3444
3445
3446
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3443

def (, image_type, signature_id, options = DocuSign_eSign::UpdateAccountSignatureImageOptions.default)
  data, _status_code, _headers = (, image_type, signature_id, options)
  return data
end

#update_account_signature_image_with_http_info(account_id, image_type, signature_id, options = DocuSign_eSign::UpdateAccountSignatureImageOptions.default) ⇒ Array<(AccountSignature, Fixnum, Hash)>

Sets a signature, initials, or stamps image.

Parameters:

  • account_id —

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

  • image_type —

    One of signature_image or initials_image.

  • signature_id —

    The ID of the signature being accessed.

  • DocuSign_eSign::UpdateAccountSignatureImageOptions —

    Options for modifying the behavior of the function.

Returns:

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

    AccountSignature data, response status code and response headers



3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3455

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

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['image/gif'])

  # form parameters
  form_params = {}

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

#update_account_signature_with_http_info(account_id, account_signatures_information) ⇒ Array<(AccountSignaturesInformation, Fixnum, Hash)>

Updates a account signature.

Parameters:

  • account_id —

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

  • account_signatures_information (optional parameter)

Returns:



3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3342

def (, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_account_signature ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_account_signature" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/signatures".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 => 'AccountSignaturesInformation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_account_signature\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 This method modifies the tab types and tab functionality that is enabled for an account.

Parameters:

  • account_id —

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

  • tab_account_settings (optional parameter)

Returns:



3503
3504
3505
3506
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3503

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 This method modifies the tab types and tab functionality that is enabled for an 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



3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3513

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, options = DocuSign_eSign::UpdateBrandOptions.default) ⇒ Brand

Updates an existing brand. This method updates an account brand. Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • brand (optional parameter)
  • DocuSign_eSign::UpdateBrandOptions —

    Options for modifying the behavior of the function.

Returns:



3556
3557
3558
3559
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3556

def update_brand(, brand_id, brand, options = DocuSign_eSign::UpdateBrandOptions.default)
  data, _status_code, _headers = update_brand_with_http_info(, brand_id,  brand, options)
  return data
end

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

Put one branding logo. This method updates a single brand logo. You pass in the new version of the resource in the Content-Disposition header. Example: Content-Disposition: form-data; name=\"file\"; filename=\"logo.jpg\" Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

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) 


3614
3615
3616
3617
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3614

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. This method updates a single brand logo. You pass in the new version of the resource in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name=&quot;file&quot;; filename=&quot;logo.jpg&quot;` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).

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



3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3626

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, file_xml) ⇒ BrandResources

Uploads a branding resource file. This method updates a branding resource file. You pass in the new version of the resource file in the Content-Disposition header. Example: Content-Disposition: form-data; name=\"file\"; filename=\"DocuSign_SigningResource_4328673.xml\" Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true). Important: Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.

Parameters:

  • account_id —

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

  • brand_id —

    The ID of the brand.

  • resource_content_type —

    The type of brand resource file that you are updating. Valid values are: - sending - signing - email - signing_captive

  • file_xml —

    Brand resource XML file.

Returns:



3676
3677
3678
3679
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3676

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

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

Uploads a branding resource file. This method updates a branding resource file. You pass in the new version of the resource file in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name=&quot;file&quot;; filename=&quot;DocuSign_SigningResource_4328673.xml&quot;` Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). Important: Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.

Parameters:

  • account_id —

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

  • brand_id —

    The ID of the brand.

  • resource_content_type —

    The type of brand resource file that you are updating. Valid values are: - sending - signing - email - signing_captive

  • file_xml —

    Brand resource XML file.

Returns:

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

    BrandResources data, response status code and response headers



3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3688

def update_brand_resources_by_content_type_with_http_info(, brand_id, resource_content_type, file_xml)
  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?
  # verify the required parameter 'file_xml' is set
  fail ArgumentError, "Missing the required parameter 'file_xml' when calling AccountsApi.update_brand_resources_by_content_type" if file_xml.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["file.xml"] = file_xml

  # 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, options = DocuSign_eSign::UpdateBrandOptions.default) ⇒ Array<(Brand, Fixnum, Hash)>

Updates an existing brand. This method updates an account brand. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true).

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • brand (optional parameter)
  • DocuSign_eSign::UpdateBrandOptions —

    Options for modifying the behavior of the function.

Returns:

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

    Brand data, response status code and response headers



3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3568

def update_brand_with_http_info(, brand_id, brand, options = DocuSign_eSign::UpdateBrandOptions.default)
  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 = {}
  query_params[:'replace_brand'] = options.replace_brand if !options.replace_brand.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(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. Account administrators can use this method to perform the following tasks: - Customize values in the default disclosure. - Switch to a custom disclosure that uses your own text and HTML formatting. - Change values in your existing consumer disclosure. To specify the signer language version of the disclosure that you are updating, use the optional langCode query parameter. Note: Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. ## Updating the default disclosure When you update the default disclosure, you can edit all properties except for the following ones: - accountEsignId: This property is read-only. - custom: The default value is false. Editing this property causes the default disclosure to switch to a custom disclosure. - esignAgreement: This property is read-only. - esignText: You cannot edit this property when custom is set to false. The API returns a 200 OK HTTP response, but does not update the esignText. - Metadata properties: These properties are read-only. Note: The text of the default disclosure is always in English. ## Switching to a custom disclosure To switch to a custom disclosure, set the custom property to true and customize the value for the eSignText property. You can also edit all of the other properties except for the following ones: - accountEsignId: This property is read-only. - esignAgreement: This property is read-only. - Metadata properties: These properties are read-only. Note: When you use a custom disclosure, you can create versions of it in different signer languages and se the langCode parameter to specify the signer language version that you are updating. Important: When you switch from a default to a custom disclosure, note the following information: - You will not be able to return to using the default disclosure. - Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use. ## Updating a custom disclosure When you update a custom disclosure, you can update all of the properties except for the following ones: - accountEsignId: This property is read-only. - esignAgreement: This property is read-only. - Metadata properties: These properties are read-only. Important: Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.

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), Armenian (hy), 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:



3740
3741
3742
3743
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3740

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. Account administrators can use this method to perform the following tasks: - Customize values in the default disclosure. - Switch to a custom disclosure that uses your own text and HTML formatting. - Change values in your existing consumer disclosure. To specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter. Note: Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. ## Updating the default disclosure When you update the default disclosure, you can edit all properties except for the following ones: - `accountEsignId`: This property is read-only. - `custom`: The default value is false. Editing this property causes the default disclosure to switch to a custom disclosure. - `esignAgreement`: This property is read-only. - `esignText`: You cannot edit this property when `custom` is set to false. The API returns a 200 OK HTTP response, but does not update the `esignText`. - Metadata properties: These properties are read-only. Note: The text of the default disclosure is always in English. ## Switching to a custom disclosure To switch to a custom disclosure, set the `custom` property to true and customize the value for the `eSignText` property. You can also edit all of the other properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. Note: When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating. Important: When you switch from a default to a custom disclosure, note the following information: - You will not be able to return to using the default disclosure. - Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use. ## Updating a custom disclosure When you update a custom disclosure, you can update all of the properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. Important: Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.

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), Armenian (hy), 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



3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3752

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. This method 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:



3798
3799
3800
3801
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3798

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. This method 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



3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3810

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:



3854
3855
3856
3857
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3854

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



3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3864

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. An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (retentionDays). This method sets the envelope purge configuration for your account. Note: To use this method, you must be an account administrator. For more information, see Purge Envelopes.

Parameters:

  • account_id —

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

  • envelope_purge_configuration (optional parameter)

Returns:



3905
3906
3907
3908
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3905

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. An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method sets the envelope purge configuration for your account. Note: To use this method, you must be an account administrator. For more information, see Purge Envelopes.

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



3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3915

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:



3956
3957
3958
3959
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3956

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



3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 3966

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 This method changes the default settings for the email notifications that signers and senders receive about envelopes.

Parameters:

  • account_id —

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

  • notification_defaults (optional parameter)

Returns:



4007
4008
4009
4010
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 4007

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 This method changes the default settings for the email notifications that signers and senders receive about envelopes.

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



4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 4017

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 This method updates the password rules for an account. Note: To update the password rules for an account, you must be an account administrator.

Parameters:

  • account_id —

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

  • account_password_rules (optional parameter)

Returns:



4058
4059
4060
4061
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 4058

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 This method updates the password rules for an account. Note: To update the password rules for an account, you must be an account administrator.

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



4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 4068

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. This method updates an account permission profile. ### Related topics - How to update individual permission settings

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:



4111
4112
4113
4114
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 4111

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. This method updates an account permission profile. ### Related topics - How to update individual permission settings

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



4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 4123

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) 


4167
4168
4169
4170
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 4167

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



4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 4177

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:



4218
4219
4220
4221
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 4218

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



4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 4229

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_user_authorization(account_id, authorization_id, user_id, user_authorization_update_request) ⇒ UserAuthorization

Updates the user authorization

Parameters:

  • account_id —

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

  • authorization_id
  • user_id —

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

  • user_authorization_update_request (optional parameter)

Returns:



4275
4276
4277
4278
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 4275

def update_user_authorization(, authorization_id, user_id, user_authorization_update_request)
  data, _status_code, _headers = update_user_authorization_with_http_info(, authorization_id, user_id,  user_authorization_update_request)
  return data
end

#update_user_authorization_with_http_info(account_id, authorization_id, user_id, user_authorization_update_request) ⇒ Array<(UserAuthorization, Fixnum, Hash)>

Updates the user authorization

Parameters:

  • account_id —

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

  • authorization_id
  • user_id —

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

  • user_authorization_update_request (optional parameter)

Returns:

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

    UserAuthorization data, response status code and response headers



4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 4287

def update_user_authorization_with_http_info(, authorization_id, user_id, user_authorization_update_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AccountsApi.update_user_authorization ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_user_authorization" if .nil?
  # verify the required parameter 'authorization_id' is set
  fail ArgumentError, "Missing the required parameter 'authorization_id' when calling AccountsApi.update_user_authorization" if authorization_id.nil?
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.update_user_authorization" if user_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'authorizationId' + '}', authorization_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(user_authorization_update_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserAuthorization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_user_authorization\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:



4332
4333
4334
4335
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 4332

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



4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 4342

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