CustomTabsApi
in package
CustomTabsApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- callList() : TabMetadataList
- Operation callList
- callListWithHttpInfo() : array<string|int, mixed>
- Operation callListWithHttpInfo
- create() : TabMetadata
- Operation create
- createWithHttpInfo() : array<string|int, mixed>
- Operation createWithHttpInfo
- delete() : mixed
- Operation delete
- deleteWithHttpInfo() : array<string|int, mixed>
- Operation deleteWithHttpInfo
- get() : TabMetadata
- Operation get
- getApiClient() : ApiClient
- Get API client
- getWithHttpInfo() : array<string|int, mixed>
- Operation getWithHttpInfo
- setApiClient() : self
- Set the API client
- update() : TabMetadata
- Operation update
- updateResourcePath() : string
- Update $resourcePath with $
- updateWithHttpInfo() : array<string|int, mixed>
- Operation updateWithHttpInfo
Properties
$apiClient
API Client
protected
ApiClient
$apiClient
instance of the ApiClient
Methods
__construct()
Constructor
public
__construct([ApiClient|null $apiClient = null ]) : void
Parameters
- $apiClient : ApiClient|null = null
-
The api client to use
Return values
void —callList()
Operation callList
public
callList(string|null $account_id[, ListOptions $options = null ]) : TabMetadataList
Gets a list of all account tabs.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
TabMetadataList —callListWithHttpInfo()
Operation callListWithHttpInfo
public
callListWithHttpInfo(string|null $account_id[, ListOptions $options = null ]) : array<string|int, mixed>
Gets a list of all account tabs.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\TabMetadataList, HTTP status code, HTTP response headers (array of strings)
create()
Operation create
public
create(string|null $account_id[, TabMetadata $tab_metadata = null ]) : TabMetadata
Creates a custom tab.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $tab_metadata : TabMetadata = null
-
(optional)
Tags
Return values
TabMetadata —createWithHttpInfo()
Operation createWithHttpInfo
public
createWithHttpInfo(string|null $account_id[, TabMetadata $tab_metadata = null ]) : array<string|int, mixed>
Creates a custom tab.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $tab_metadata : TabMetadata = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\TabMetadata, HTTP status code, HTTP response headers (array of strings)
delete()
Operation delete
public
delete(string|null $account_id, string|null $custom_tab_id) : mixed
Deletes custom tab information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $custom_tab_id : string|null
Tags
Return values
mixed —deleteWithHttpInfo()
Operation deleteWithHttpInfo
public
deleteWithHttpInfo(string|null $account_id, string|null $custom_tab_id) : array<string|int, mixed>
Deletes custom tab information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $custom_tab_id : string|null
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
get()
Operation get
public
get(string|null $account_id, string|null $custom_tab_id) : TabMetadata
Gets custom tab information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $custom_tab_id : string|null
Tags
Return values
TabMetadata —getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getWithHttpInfo()
Operation getWithHttpInfo
public
getWithHttpInfo(string|null $account_id, string|null $custom_tab_id) : array<string|int, mixed>
Gets custom tab information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $custom_tab_id : string|null
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\TabMetadata, HTTP status code, HTTP response headers (array of strings)
setApiClient()
Set the API client
public
setApiClient(ApiClient $apiClient) : self
Parameters
- $apiClient : ApiClient
-
set the API client
Return values
self —update()
Operation update
public
update(string|null $account_id, string|null $custom_tab_id[, TabMetadata $tab_metadata = null ]) : TabMetadata
Updates custom tab information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $custom_tab_id : string|null
- $tab_metadata : TabMetadata = null
-
(optional)
Tags
Return values
TabMetadata —updateResourcePath()
Update $resourcePath with $
public
updateResourcePath(string $resourcePath, string $baseName, string $paramName) : string
Parameters
- $resourcePath : string
-
the resource path to use
- $baseName : string
-
the base name param
- $paramName : string
-
the parameter name
Return values
string —updateWithHttpInfo()
Operation updateWithHttpInfo
public
updateWithHttpInfo(string|null $account_id, string|null $custom_tab_id[, TabMetadata $tab_metadata = null ]) : array<string|int, mixed>
Updates custom tab information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $custom_tab_id : string|null
- $tab_metadata : TabMetadata = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\TabMetadata, HTTP status code, HTTP response headers (array of strings)