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

Inheritance diagram for DocuSign.eSign.Api.ICustomTabsApi:

Public Member Functions
TabMetadata	Create (string accountId, TabMetadata tabMetadata=null)
	Creates a custom tab. More...

ApiResponse< TabMetadata >	CreateWithHttpInfo (string accountId, TabMetadata tabMetadata=null)
	Creates a custom tab. More...

void	Delete (string accountId, string customTabId)
	Deletes custom tab information. More...

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

TabMetadata	Get (string accountId, string customTabId)
	Gets custom tab information. More...

ApiResponse< TabMetadata >	GetWithHttpInfo (string accountId, string customTabId)
	Gets custom tab information. More...

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

TabMetadata	Update (string accountId, string customTabId, TabMetadata tabMetadata=null)
	Updates custom tab information. More...

ApiResponse< TabMetadata >	UpdateWithHttpInfo (string accountId, string customTabId, TabMetadata tabMetadata=null)
	Updates custom tab information. More...

System.Threading.Tasks.Task< TabMetadata >	CreateAsync (string accountId, TabMetadata tabMetadata=null)
	Creates a custom tab. More...

System.Threading.Tasks.Task< ApiResponse< TabMetadata > >	CreateAsyncWithHttpInfo (string accountId, TabMetadata tabMetadata=null)
	Creates a custom tab. More...

System.Threading.Tasks.Task	DeleteAsync (string accountId, string customTabId)
	Deletes custom tab information. More...

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

System.Threading.Tasks.Task< TabMetadata >	GetAsync (string accountId, string customTabId)
	Gets custom tab information. More...

System.Threading.Tasks.Task< ApiResponse< TabMetadata > >	GetAsyncWithHttpInfo (string accountId, string customTabId)
	Gets custom tab information. 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...

System.Threading.Tasks.Task< TabMetadata >	UpdateAsync (string accountId, string customTabId, TabMetadata tabMetadata=null)
	Updates custom tab information. More...

System.Threading.Tasks.Task< ApiResponse< TabMetadata > >	UpdateAsyncWithHttpInfo (string accountId, string customTabId, TabMetadata tabMetadata=null)
	Updates custom tab information. More...

Public Member Functions inherited from DocuSign.eSign.Client.IApiAccessor
String	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
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

Member Function Documentation

◆ Create()

TabMetadata DocuSign.eSign.Api.ICustomTabsApi.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.

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

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ CreateAsync()

System.Threading.Tasks.Task<TabMetadata> DocuSign.eSign.Api.ICustomTabsApi.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.

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

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ CreateAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<TabMetadata> > DocuSign.eSign.Api.ICustomTabsApi.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.

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)

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ CreateWithHttpInfo()

ApiResponse<TabMetadata> DocuSign.eSign.Api.ICustomTabsApi.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.

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

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ Delete()

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

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

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ DeleteAsync()

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

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

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ DeleteAsyncWithHttpInfo()

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

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

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ DeleteWithHttpInfo()

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

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)

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ Get()

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

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

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ GetAsync()

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

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

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ GetAsyncWithHttpInfo()

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

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)

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ GetWithHttpInfo()

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

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

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ List()

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

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

◆ ListAsync()

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

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

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

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.ICustomTabsApi.ListWithHttpInfo	(	string	accountId,
		CustomTabsApi.ListOptions	options = `null`
	)

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

◆ Update()

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

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

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ UpdateAsync()

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

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

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ UpdateAsyncWithHttpInfo()

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

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)

Implemented in DocuSign.eSign.Api.CustomTabsApi.

◆ UpdateWithHttpInfo()

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

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

Implemented in DocuSign.eSign.Api.CustomTabsApi.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Create()

◆ CreateAsync()

◆ CreateAsyncWithHttpInfo()

◆ CreateWithHttpInfo()

◆ Delete()

◆ DeleteAsync()

◆ DeleteAsyncWithHttpInfo()

◆ DeleteWithHttpInfo()

◆ Get()

◆ GetAsync()

◆ GetAsyncWithHttpInfo()

◆ GetWithHttpInfo()

◆ List()

◆ ListAsync()

◆ ListAsyncWithHttpInfo()

◆ ListWithHttpInfo()

◆ Update()

◆ UpdateAsync()

◆ UpdateAsyncWithHttpInfo()

◆ UpdateWithHttpInfo()