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.



179
180
181
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 179

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



177
178
179
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 177

def api_client
  @api_client
end

Instance Method Details

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

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

Parameters:

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

    Options for modifying the behavior of the function.

Returns:



188
189
190
191
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 188

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

#create_brand(account_id, brand) ⇒ BrandsResponse

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

Parameters:

  • account_id —

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

  • brand (optional parameter)

Returns:



238
239
240
241
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 238

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

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

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

Parameters:

  • account_id —

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

  • brand (optional parameter)

Returns:

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

    BrandsResponse data, response status code and response headers



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 248

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/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_e_mortgage_transaction(account_id, post_transactions_request) ⇒ PostTransactionsResponse

Starts a new eMortgage Transaction

Parameters:

  • account_id —

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

  • post_transactions_request (optional parameter)

Returns:



289
290
291
292
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 289

def create_e_mortgage_transaction(, post_transactions_request)
  data, _status_code, _headers = create_e_mortgage_transaction_with_http_info(,  post_transactions_request)
  return data
end

#create_e_mortgage_transaction_with_http_info(account_id, post_transactions_request) ⇒ Array<(PostTransactionsResponse, Fixnum, Hash)>

Starts a new eMortgage Transaction

Parameters:

  • account_id —

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

  • post_transactions_request (optional parameter)

Returns:

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

    PostTransactionsResponse data, response status code and response headers



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 299

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

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

Creates a new permission profile in the specified account.

Parameters:

  • account_id —

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

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

    Options for modifying the behavior of the function.

Returns:



341
342
343
344
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 341

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

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

Creates a new permission profile in the specified account.

Parameters:

  • account_id —

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

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

    Options for modifying the behavior of the function.

Returns:

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

    PermissionProfile data, response status code and response headers



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 352

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/accounts/{accountId}/permission_profiles".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

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

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

  # form parameters
  form_params = {}

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

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

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

Parameters:

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

    Options for modifying the behavior of the function.

Returns:

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

    NewAccountSummary data, response status code and response headers



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 198

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/accounts".sub('{format}','json')

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

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

  # form parameters
  form_params = {}

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

#delete(account_id) ⇒ nil

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

Parameters:

  • account_id —

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

Returns:

  • (nil) 


393
394
395
396
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 393

def delete()
  delete_with_http_info()
  return nil
end

#delete_brand(account_id, brand_id) ⇒ nil

Removes a brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

Returns:

  • (nil) 


442
443
444
445
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 442

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

#delete_brand_logo_by_type(account_id, brand_id, logo_type) ⇒ nil

Delete one branding logo.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • logo_type —

    One of Primary, Secondary or Email.

Returns:

  • (nil) 


495
496
497
498
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 495

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

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

Delete one branding logo.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • logo_type —

    One of Primary, Secondary or Email.

Returns:

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

    nil, response status code and response headers



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 506

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/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Removes a brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

Returns:

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

    nil, response status code and response headers



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

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



550
551
552
553
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 550

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

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

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

Parameters:

  • account_id —

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

  • brands_request (optional parameter)

Returns:

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

    BrandsResponse data, response status code and response headers



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 560

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



602
603
604
605
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 602

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:



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 613

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/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_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) 


655
656
657
658
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 655

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



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 664

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/accounts/{accountId}/settings/enote_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#delete_permission_profile(account_id, permission_profile_id) ⇒ nil

Deletes a permissions profile within the specified account.

Parameters:

  • account_id —

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

  • permission_profile_id

Returns:

  • (nil) 


704
705
706
707
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 704

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

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

Deletes a permissions profile within the specified account.

Parameters:

  • account_id —

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

  • permission_profile_id

Returns:

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

    nil, response status code and response headers



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

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

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

Parameters:

  • account_id —

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

Returns:

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

    nil, response status code and response headers



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 402

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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



756
757
758
759
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 756

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

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

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

Parameters:

  • account_id —

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

  • DocuSign_eSign::GetAccountInformationOptions —

    Options for modifying the behavior of the function.

Returns:

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

    AccountInformation data, response status code and response headers



766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 766

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/accounts/{accountId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

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

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

  # form parameters
  form_params = {}

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

#get_account_tab_settings(account_id) ⇒ TabAccountSettings

Returns tab settings list for specified account

Parameters:

  • account_id —

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

Returns:



807
808
809
810
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 807

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

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

Returns tab settings list for specified account

Parameters:

  • account_id —

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

Returns:

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

    TabAccountSettings data, response status code and response headers



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

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



857
858
859
860
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 857

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



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

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/accounts/{accountId}/billing_charges".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

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

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

  # form parameters
  form_params = {}

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

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

Get information for a specific brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • DocuSign_eSign::GetBrandOptions —

    Options for modifying the behavior of the function.

Returns:



910
911
912
913
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 910

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_logo_by_type(account_id, brand_id, logo_type) ⇒ nil

Obtains the specified image for a brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • logo_type —

    One of Primary, Secondary or Email.

Returns:

  • (nil) 


967
968
969
970
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 967

def get_brand_logo_by_type(, brand_id, logo_type)
  get_brand_logo_by_type_with_http_info(, brand_id, logo_type)
  return nil
end

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

Obtains the specified image for a brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • logo_type —

    One of Primary, Secondary or Email.

Returns:

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

    nil, response status code and response headers



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
1009
1010
1011
1012
1013
1014
1015
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 978

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

#get_brand_resources(account_id, brand_id) ⇒ BrandResourcesList

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

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

Returns:



1022
1023
1024
1025
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1022

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

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

Returns the specified branding resource file.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • resource_content_type
  • DocuSign_eSign::GetBrandResourcesByContentTypeOptions —

    Options for modifying the behavior of the function.

Returns:

  • (nil) 


1077
1078
1079
1080
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1077

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

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

Returns the specified branding resource file.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • resource_content_type
  • DocuSign_eSign::GetBrandResourcesByContentTypeOptions —

    Options for modifying the behavior of the function.

Returns:

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

    nil, response status code and response headers



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

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/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'resourceContentType' + '}', resource_content_type.to_s)

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

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

  # form parameters
  form_params = {}

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

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

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

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

Returns:

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

    BrandResourcesList data, response status code and response headers



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
1060
1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1032

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/accounts/{accountId}/brands/{brandId}/resources".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'brandId' + '}', brand_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Get information for a specific brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • DocuSign_eSign::GetBrandOptions —

    Options for modifying the behavior of the function.

Returns:

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

    Brand data, response status code and response headers



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
953
954
955
956
957
958
959
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 921

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/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'brandId' + '}', brand_id.to_s)

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

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

  # form parameters
  form_params = {}

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

#get_consumer_disclosure(account_id, lang_code) ⇒ ConsumerDisclosure

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

Parameters:

  • account_id —

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

  • lang_code —

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

Returns:



1135
1136
1137
1138
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1135

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:



1188
1189
1190
1191
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1188

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



1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1198

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/accounts/{accountId}/consumer_disclosure".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

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

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

  # form parameters
  form_params = {}

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

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

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

Parameters:

  • account_id —

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

  • lang_code —

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

Returns:

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

    ConsumerDisclosure data, response status code and response headers



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
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1145

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



1239
1240
1241
1242
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1239

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



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
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1248

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/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_permission_profile(account_id, permission_profile_id, options = DocuSign_eSign::GetPermissionProfileOptions.default) ⇒ PermissionProfile

Returns a permissions profile in the specified account.

Parameters:

  • account_id —

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

  • permission_profile_id
  • DocuSign_eSign::GetPermissionProfileOptions —

    Options for modifying the behavior of the function.

Returns:



1290
1291
1292
1293
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1290

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

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

Returns a permissions profile in the specified account.

Parameters:

  • account_id —

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

  • permission_profile_id
  • DocuSign_eSign::GetPermissionProfileOptions —

    Options for modifying the behavior of the function.

Returns:

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

    PermissionProfile data, response status code and response headers



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
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1301

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/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s)

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

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

  # form parameters
  form_params = {}

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

#get_provisioning ⇒ ProvisioningInformation

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

Returns:



1343
1344
1345
1346
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1343

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



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 1351

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

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



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

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

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

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

Parameters:

  • account_id —

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

  • DocuSign_eSign::ListBrandsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    BrandsResponse data, response status code and response headers



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

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



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

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



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

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



1492
1493
1494
1495
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1492

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:



1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1502

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/accounts/{accountId}/permission_profiles".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

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

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

  # form parameters
  form_params = {}

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

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

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

Parameters:

  • account_id —

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

  • DocuSign_eSign::ListRecipientNamesByEmailOptions —

    Options for modifying the behavior of the function.

Returns:



1544
1545
1546
1547
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1544

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

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

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

Parameters:

  • account_id —

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

  • DocuSign_eSign::ListRecipientNamesByEmailOptions —

    Options for modifying the behavior of the function.

Returns:

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

    RecipientNamesResponse data, response status code and response headers



1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1554

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

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

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

  # form parameters
  form_params = {}

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

#list_settings(account_id) ⇒ AccountSettingsInformation

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

Parameters:

  • account_id —

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

Returns:



1595
1596
1597
1598
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1595

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



1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1604

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



1645
1646
1647
1648
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1645

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

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

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

Parameters:

  • account_id —

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

  • DocuSign_eSign::ListSharedAccessOptions —

    Options for modifying the behavior of the function.

Returns:

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

    AccountSharedAccess data, response status code and response headers



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
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
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1655

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/accounts/{accountId}/shared_access".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'envelopes_not_shared_user_status'] = options.envelopes_not_shared_user_status if !options.envelopes_not_shared_user_status.nil?
  query_params[:'folder_ids'] = options.folder_ids if !options.folder_ids.nil?
  query_params[:'item_type'] = options.item_type if !options.item_type.nil?
  query_params[:'search_text'] = options.search_text if !options.search_text.nil?
  query_params[:'shared'] = options.shared if !options.shared.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?
  query_params[:'user_ids'] = options.user_ids if !options.user_ids.nil?

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

  # form parameters
  form_params = {}

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

#list_signature_providers(account_id) ⇒ AccountSignatureProviders

Returns Account available signature providers for specified account.

Parameters:

  • account_id —

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

Returns:



1703
1704
1705
1706
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1703

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

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

Returns Account available signature providers for specified account.

Parameters:

  • account_id —

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

Returns:

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

    AccountSignatureProviders data, response status code and response headers



1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1712

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



1752
1753
1754
1755
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1752

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



1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1761

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

#update_account_tab_settings(account_id, tab_account_settings) ⇒ TabAccountSettings

Modifies tab settings for specified account

Parameters:

  • account_id —

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

  • tab_account_settings (optional parameter)

Returns:



1802
1803
1804
1805
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1802

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

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

Modifies tab settings for specified account

Parameters:

  • account_id —

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

  • tab_account_settings (optional parameter)

Returns:

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

    TabAccountSettings data, response status code and response headers



1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1812

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/accounts/{accountId}/settings/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_brand(account_id, brand_id, brand) ⇒ Brand

Updates an existing brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • brand (optional parameter)

Returns:



1854
1855
1856
1857
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1854

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

#update_brand_logo_by_type(account_id, brand_id, logo_type) ⇒ nil

Put one branding logo.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • logo_type —

    One of Primary, Secondary or Email.

Returns:

  • (nil) 


1909
1910
1911
1912
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1909

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

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

Put one branding logo.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • logo_type —

    One of Primary, Secondary or Email.

Returns:

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

    nil, response status code and response headers



1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1920

def update_brand_logo_by_type_with_http_info(, brand_id, logo_type)
  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?
  # resource path
  local_var_path = "/v2/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(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_brand_logo_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_brand_resources_by_content_type(account_id, brand_id, resource_content_type) ⇒ BrandResources

Uploads a branding resource file.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • resource_content_type

Returns:



1965
1966
1967
1968
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1965

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

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

Uploads a branding resource file.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • resource_content_type

Returns:

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

    BrandResources data, response status code and response headers



1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1976

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Updates an existing brand.

Parameters:

  • account_id —

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

  • brand_id —

    The unique identifier of a brand.

  • brand (optional parameter)

Returns:

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

    Brand data, response status code and response headers



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 1865

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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



2021
2022
2023
2024
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2021

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



2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2031

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/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_permission_profile(account_id, permission_profile_id, permission_profile, options = DocuSign_eSign::UpdatePermissionProfileOptions.default) ⇒ PermissionProfile

Updates a permission profile within the specified account.

Parameters:

  • account_id —

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

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

    Options for modifying the behavior of the function.

Returns:



2074
2075
2076
2077
 
# File 'lib/docusign_esign/api/accounts_api.rb', line 2074

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

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

Updates a permission profile within the specified account.

Parameters:

  • account_id —

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

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

    Options for modifying the behavior of the function.

Returns:

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

    PermissionProfile data, response status code and response headers



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

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/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) 


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

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



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

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



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

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



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

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/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[:'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