Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for DocuSign.eSign.Api.CustomTabsApi:

Classes
class	ListOptions
	Gets a list of all account tabs. Retrieves a list of all tabs associated with the account. More...

Public Member Functions
	CustomTabsApi (DocuSignClient aplClient)
	Initializes a new instance of the CustomTabsApi class using AplClient object More...

String	GetBasePath ()
	Gets the base path of the API client. More...

TabMetadata	Create (string accountId, TabMetadata tabMetadata=null)
	Creates a custom tab. Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application. Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs. More...

ApiResponse< TabMetadata >	CreateWithHttpInfo (string accountId, TabMetadata tabMetadata=null)
	Creates a custom tab. Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application. Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs. More...

async System.Threading.Tasks.Task< TabMetadata >	CreateAsync (string accountId, TabMetadata tabMetadata=null)
	Creates a custom tab. Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application. Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs. More...

async System.Threading.Tasks.Task< ApiResponse< TabMetadata > >	CreateAsyncWithHttpInfo (string accountId, TabMetadata tabMetadata=null)
	Creates a custom tab. Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application. Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs. More...

void	Delete (string accountId, string customTabId)
	Deletes custom tab information. Deletes the custom from the specified account. More...

ApiResponse< Object >	DeleteWithHttpInfo (string accountId, string customTabId)
	Deletes custom tab information. Deletes the custom from the specified account. More...

async System.Threading.Tasks.Task	DeleteAsync (string accountId, string customTabId)
	Deletes custom tab information. Deletes the custom from the specified account. More...

async System.Threading.Tasks.Task< ApiResponse< Object > >	DeleteAsyncWithHttpInfo (string accountId, string customTabId)
	Deletes custom tab information. Deletes the custom from the specified account. More...

TabMetadata	Get (string accountId, string customTabId)
	Gets custom tab information. Retrieves information about the requested custom tab on the specified account. More...

ApiResponse< TabMetadata >	GetWithHttpInfo (string accountId, string customTabId)
	Gets custom tab information. Retrieves information about the requested custom tab on the specified account. More...

async System.Threading.Tasks.Task< TabMetadata >	GetAsync (string accountId, string customTabId)
	Gets custom tab information. Retrieves information about the requested custom tab on the specified account. More...

async System.Threading.Tasks.Task< ApiResponse< TabMetadata > >	GetAsyncWithHttpInfo (string accountId, string customTabId)
	Gets custom tab information. Retrieves information about the requested custom tab on the specified account. More...

TabMetadataList	List (string accountId, CustomTabsApi.ListOptions options=null)
	Gets a list of all account tabs. Retrieves a list of all tabs associated with the account. More...

ApiResponse< TabMetadataList >	ListWithHttpInfo (string accountId, CustomTabsApi.ListOptions options=null)
	Gets a list of all account tabs. Retrieves a list of all tabs associated with the account. More...

async System.Threading.Tasks.Task< TabMetadataList >	ListAsync (string accountId, CustomTabsApi.ListOptions options=null)
	Gets a list of all account tabs. Retrieves a list of all tabs associated with the account. More...

async System.Threading.Tasks.Task< ApiResponse< TabMetadataList > >	ListAsyncWithHttpInfo (string accountId, CustomTabsApi.ListOptions options=null)
	Gets a list of all account tabs. Retrieves a list of all tabs associated with the account. More...

TabMetadata	Update (string accountId, string customTabId, TabMetadata tabMetadata=null)
	Updates custom tab information. Updates the information in a custom tab for the specified account. More...

ApiResponse< TabMetadata >	UpdateWithHttpInfo (string accountId, string customTabId, TabMetadata tabMetadata=null)
	Updates custom tab information. Updates the information in a custom tab for the specified account. More...

async System.Threading.Tasks.Task< TabMetadata >	UpdateAsync (string accountId, string customTabId, TabMetadata tabMetadata=null)
	Updates custom tab information. Updates the information in a custom tab for the specified account. More...

async System.Threading.Tasks.Task< ApiResponse< TabMetadata > >	UpdateAsyncWithHttpInfo (string accountId, string customTabId, TabMetadata tabMetadata=null)
	Updates custom tab information. Updates the information in a custom tab for the specified account. More...

Public Member Functions inherited from DocuSign.eSign.Api.ICustomTabsApi
TabMetadataList	List (string accountId, CustomTabsApi.ListOptions options=null)
	Gets a list of all account tabs. More...

ApiResponse< TabMetadataList >	ListWithHttpInfo (string accountId, CustomTabsApi.ListOptions options=null)
	Gets a list of all account tabs. More...

System.Threading.Tasks.Task< TabMetadataList >	ListAsync (string accountId, CustomTabsApi.ListOptions options=null)
	Gets a list of all account tabs. More...

System.Threading.Tasks.Task< ApiResponse< TabMetadataList > >	ListAsyncWithHttpInfo (string accountId, CustomTabsApi.ListOptions options=null)
	Gets a list of all account tabs. More...

Properties
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

DocuSign.eSign.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Properties inherited from DocuSign.eSign.Client.IApiAccessor
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ CustomTabsApi()

DocuSign.eSign.Api.CustomTabsApi.CustomTabsApi ( DocuSignClient aplClient )

inline

Initializes a new instance of the CustomTabsApi class using AplClient object

Parameters

aplClient An instance of AplClient

Returns

Member Function Documentation

◆ Create()

TabMetadata DocuSign.eSign.Api.CustomTabsApi.Create	(	string	accountId,
		TabMetadata	tabMetadata = `null`
	)

inline

Creates a custom tab. Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application. Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
tabMetadata	(optional)

Returns: TabMetadata

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ CreateAsync()

async System.Threading.Tasks.Task<TabMetadata> DocuSign.eSign.Api.CustomTabsApi.CreateAsync	(	string	accountId,
		TabMetadata	tabMetadata = `null`
	)

inline

Creates a custom tab. Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application. Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
tabMetadata	(optional)

Returns: Task of TabMetadata

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ CreateAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<TabMetadata> > DocuSign.eSign.Api.CustomTabsApi.CreateAsyncWithHttpInfo	(	string	accountId,
		TabMetadata	tabMetadata = `null`
	)

inline

Creates a custom tab. Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application. Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
tabMetadata	(optional)

Returns: Task of ApiResponse (TabMetadata)

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ CreateWithHttpInfo()

ApiResponse<TabMetadata> DocuSign.eSign.Api.CustomTabsApi.CreateWithHttpInfo	(	string	accountId,
		TabMetadata	tabMetadata = `null`
	)

inline

Creates a custom tab. Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application. Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
tabMetadata	(optional)

Returns: ApiResponse of TabMetadata

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ Delete()

void DocuSign.eSign.Api.CustomTabsApi.Delete	(	string	accountId,
		string	customTabId
	)

inline

Deletes custom tab information. Deletes the custom from the specified account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ DeleteAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.CustomTabsApi.DeleteAsync	(	string	accountId,
		string	customTabId
	)

inline

Deletes custom tab information. Deletes the custom from the specified account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of void

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ DeleteAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.CustomTabsApi.DeleteAsyncWithHttpInfo	(	string	accountId,
		string	customTabId
	)

inline

Deletes custom tab information. Deletes the custom from the specified account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of ApiResponse

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ DeleteWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.CustomTabsApi.DeleteWithHttpInfo	(	string	accountId,
		string	customTabId
	)

inline

Deletes custom tab information. Deletes the custom from the specified account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: ApiResponse of Object(void)

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ Get()

TabMetadata DocuSign.eSign.Api.CustomTabsApi.Get	(	string	accountId,
		string	customTabId
	)

inline

Gets custom tab information. Retrieves information about the requested custom tab on the specified account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: TabMetadata

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ GetAsync()

async System.Threading.Tasks.Task<TabMetadata> DocuSign.eSign.Api.CustomTabsApi.GetAsync	(	string	accountId,
		string	customTabId
	)

inline

Gets custom tab information. Retrieves information about the requested custom tab on the specified account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of TabMetadata

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ GetAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<TabMetadata> > DocuSign.eSign.Api.CustomTabsApi.GetAsyncWithHttpInfo	(	string	accountId,
		string	customTabId
	)

inline

Gets custom tab information. Retrieves information about the requested custom tab on the specified account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of ApiResponse (TabMetadata)

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ GetBasePath()

String DocuSign.eSign.Api.CustomTabsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

◆ GetWithHttpInfo()

ApiResponse<TabMetadata> DocuSign.eSign.Api.CustomTabsApi.GetWithHttpInfo	(	string	accountId,
		string	customTabId
	)

inline

Gets custom tab information. Retrieves information about the requested custom tab on the specified account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: ApiResponse of TabMetadata

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ List()

TabMetadataList DocuSign.eSign.Api.CustomTabsApi.List	(	string	accountId,
		CustomTabsApi.ListOptions	options = `null`
	)

inline

Gets a list of all account tabs. Retrieves a list of all tabs associated with the account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: TabMetadataList

◆ ListAsync()

async System.Threading.Tasks.Task<TabMetadataList> DocuSign.eSign.Api.CustomTabsApi.ListAsync	(	string	accountId,
		CustomTabsApi.ListOptions	options = `null`
	)

inline

Gets a list of all account tabs. Retrieves a list of all tabs associated with the account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of TabMetadataList

◆ ListAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<TabMetadataList> > DocuSign.eSign.Api.CustomTabsApi.ListAsyncWithHttpInfo	(	string	accountId,
		CustomTabsApi.ListOptions	options = `null`
	)

inline

Gets a list of all account tabs. Retrieves a list of all tabs associated with the account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (TabMetadataList)

◆ ListWithHttpInfo()

ApiResponse<TabMetadataList> DocuSign.eSign.Api.CustomTabsApi.ListWithHttpInfo	(	string	accountId,
		CustomTabsApi.ListOptions	options = `null`
	)

inline

Gets a list of all account tabs. Retrieves a list of all tabs associated with the account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of TabMetadataList

◆ Update()

TabMetadata DocuSign.eSign.Api.CustomTabsApi.Update	(	string	accountId,
		string	customTabId,
		TabMetadata	tabMetadata = `null`
	)

inline

Updates custom tab information. Updates the information in a custom tab for the specified account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
customTabId
tabMetadata	(optional)

Returns: TabMetadata

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ UpdateAsync()

async System.Threading.Tasks.Task<TabMetadata> DocuSign.eSign.Api.CustomTabsApi.UpdateAsync	(	string	accountId,
		string	customTabId,
		TabMetadata	tabMetadata = `null`
	)

inline

Updates custom tab information. Updates the information in a custom tab for the specified account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
customTabId
tabMetadata	(optional)

Returns: Task of TabMetadata

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ UpdateAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<TabMetadata> > DocuSign.eSign.Api.CustomTabsApi.UpdateAsyncWithHttpInfo	(	string	accountId,
		string	customTabId,
		TabMetadata	tabMetadata = `null`
	)

inline

Updates custom tab information. Updates the information in a custom tab for the specified account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
customTabId
tabMetadata	(optional)

Returns: Task of ApiResponse (TabMetadata)

Implements DocuSign.eSign.Api.ICustomTabsApi.

◆ UpdateWithHttpInfo()

ApiResponse<TabMetadata> DocuSign.eSign.Api.CustomTabsApi.UpdateWithHttpInfo	(	string	accountId,
		string	customTabId,
		TabMetadata	tabMetadata = `null`
	)

inline

Updates custom tab information. Updates the information in a custom tab for the specified account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
customTabId
tabMetadata	(optional)

Returns: ApiResponse of TabMetadata

Implements DocuSign.eSign.Api.ICustomTabsApi.

Property Documentation

◆ ApiClient

DocuSignClient DocuSign.eSign.Api.CustomTabsApi.ApiClient

getset

Gets or sets the ApiClient object

An instance of the ApiClient

◆ ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.CustomTabsApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

The documentation for this class was generated from the following file:

sdk/src/DocuSign.eSign/Api/CustomTabsApi.cs

Classes

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ CustomTabsApi()

Member Function Documentation

◆ Create()

◆ CreateAsync()

◆ CreateAsyncWithHttpInfo()

◆ CreateWithHttpInfo()

◆ Delete()

◆ DeleteAsync()

◆ DeleteAsyncWithHttpInfo()

◆ DeleteWithHttpInfo()

◆ Get()

◆ GetAsync()

◆ GetAsyncWithHttpInfo()

◆ GetBasePath()

◆ GetWithHttpInfo()

◆ List()

◆ ListAsync()

◆ ListAsyncWithHttpInfo()

◆ ListWithHttpInfo()

◆ Update()

◆ UpdateAsync()

◆ UpdateAsyncWithHttpInfo()

◆ UpdateWithHttpInfo()

Property Documentation

◆ ApiClient

◆ ExceptionFactory