Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
39 changes: 39 additions & 0 deletions docs/Account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@

# Account

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created** | [**Date**](Date.md) | Date when the account was created. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional]
**accountType** | [**AccountTypeEnum**](#AccountTypeEnum) | The provisioned type of the account. This is a server generated attributed and can not be provided in POST/PUT calls. | [optional]
**name** | **String** | The name which the account is known. This is a server generated attributed and can not be provided in POST/PUT calls. | [optional]
**modified** | [**Date**](Date.md) | The last date that the account information was updated. This is a server generated attributed and can not be provided in POST/PUT calls. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time | [optional]
**company** | **String** | The company associated with the account. This is a server generated attributed and can not be provided in POST/PUT calls. | [optional]
**id** | **String** | Identifier of the account. This is a server generated attributed and can not be provided in POST/PUT calls. | [optional]


<a name="AccountTypeEnum"></a>
## Enum: AccountTypeEnum
Name | Value
---- | -----
FREE | &quot;FREE&quot;
FREE_LEGACY | &quot;FREE_LEGACY&quot;
TEAM_TRIAL | &quot;TEAM_TRIAL&quot;
TEAM | &quot;TEAM&quot;
TEAM_LEGACY | &quot;TEAM_LEGACY&quot;
ENTERPRISE_TRIAL | &quot;ENTERPRISE_TRIAL&quot;
ENTERPRISE | &quot;ENTERPRISE&quot;
ENTERPRISE_LEGACY | &quot;ENTERPRISE_LEGACY&quot;
GLOBAL_TRIAL | &quot;GLOBAL_TRIAL&quot;
GLOBAL | &quot;GLOBAL&quot;
DEVELOPER | &quot;DEVELOPER&quot;
PRO_DOC_CLOUD | &quot;PRO_DOC_CLOUD&quot;
TEAM_DOC_CLOUD | &quot;TEAM_DOC_CLOUD&quot;
TRIAL_EXPIRED | &quot;TRIAL_EXPIRED&quot;
ANONYMOUS | &quot;ANONYMOUS&quot;
PRO_DOC_CLOUD_MULTI | &quot;PRO_DOC_CLOUD_MULTI&quot;
PRO_PLUS_DOC_CLOUD | &quot;PRO_PLUS_DOC_CLOUD&quot;
PRO_PLUS_DOC_CLOUD_MULTI | &quot;PRO_PLUS_DOC_CLOUD_MULTI&quot;



22 changes: 22 additions & 0 deletions docs/AccountSharerInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

# AccountSharerInfo

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**permissions** | [**List&lt;PermissionsEnum&gt;**](#List&lt;PermissionsEnum&gt;) | A list of permissions given for this account sharing. | [optional]
**fullName** | **String** | Full name of this account sharer. | [optional]
**userId** | **String** | A unique identifier of the user resource for REST APIs as issued by Sign. | [optional]
**email** | **String** | The email address of the user | [optional]


<a name="List<PermissionsEnum>"></a>
## Enum: List&lt;PermissionsEnum&gt;
Name | Value
---- | -----
VIEW | &quot;VIEW&quot;
SEND | &quot;SEND&quot;
MODIFY | &quot;MODIFY&quot;



56 changes: 56 additions & 0 deletions docs/AccountsApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# AccountsApi

All URIs are relative to *https://secure.au1.echosign.com/api/rest/v6*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getAccount**](AccountsApi.md#getAccount) | **GET** /accounts/{accountId} | Retrieves the information for an account.


<a name="getAccount"></a>
# **getAccount**
> Account getAccount(authorization, accountId, xApiUser)

Retrieves the information for an account.

### Example
```java
// Import classes:
//import io.swagger.client.model.ApiException;
//import io.swagger.client.api.AccountsApi;


AccountsApi apiInstance = new AccountsApi();
String authorization = "authorization_example"; // String | An <a href=\"#\" onclick=\"this.href=oauthDoc()\" oncontextmenu=\"this.href=oauthDoc()\" target=\"oauthDoc\">OAuth Access Token</a> with scopes:<ul><li style='list-style-type: square'><a href=\"#\" onclick=\"this.href=oauthDoc('user_read')\" oncontextmenu=\"this.href=oauthDoc('user_read')\" target=\"oauthDoc\">user_read</a></li></ul>in the format <b>'Bearer {accessToken}'.
String accountId = "accountId_example"; // String | The account identifier.
String xApiUser = "xApiUser_example"; // String | The userId or email of API caller using the account or group token in the format <b>userid:{userId} OR email:{email}.</b> If it is not specified, then the caller is inferred from the token.
try {
Account result = apiInstance.getAccount(authorization, accountId, xApiUser);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccountsApi#getAccount");
e.printStackTrace();
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**authorization** | **String**| An &lt;a href&#x3D;\&quot;#\&quot; onclick&#x3D;\&quot;this.href&#x3D;oauthDoc()\&quot; oncontextmenu&#x3D;\&quot;this.href&#x3D;oauthDoc()\&quot; target&#x3D;\&quot;oauthDoc\&quot;&gt;OAuth Access Token&lt;/a&gt; with scopes:&lt;ul&gt;&lt;li style&#x3D;&#39;list-style-type: square&#39;&gt;&lt;a href&#x3D;\&quot;#\&quot; onclick&#x3D;\&quot;this.href&#x3D;oauthDoc(&#39;user_read&#39;)\&quot; oncontextmenu&#x3D;\&quot;this.href&#x3D;oauthDoc(&#39;user_read&#39;)\&quot; target&#x3D;\&quot;oauthDoc\&quot;&gt;user_read&lt;/a&gt;&lt;/li&gt;&lt;/ul&gt;in the format &lt;b&gt;&#39;Bearer {accessToken}&#39;. |
**accountId** | **String**| The account identifier. |
**xApiUser** | **String**| The userId or email of API caller using the account or group token in the format &lt;b&gt;userid:{userId} OR email:{email}.&lt;/b&gt; If it is not specified, then the caller is inferred from the token. | [optional]

### Return type

[**Account**](Account.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

4 changes: 2 additions & 2 deletions docs/AgreementCcInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **String** | Email of the CC participant of the agreement | [optional]
**label** | **String** | Label of the CC list as returned in workflow description | [optional]
**visiblePages** | **List&lt;String&gt;** | When you enable limited document visibility (documentVisibilityEnabled), you can specify which file (fileInfo) should be made visible to which specific participant set.&lt;br&gt;Specify one or more label values of a fileInfos element.&lt;br&gt;Each signer participant sets must contain at least one required signature field in at least one visible file included in this API call; if not a page with a signature field is automatically appended for any missing participant sets. If there is a possibility that one or more participant sets do not have a required signature field in the files included in the API call, all signer participant sets should include a special index value of &#39;0&#39; to make this automatically appended signature page visible to the signer. Not doing so may result in an error. For all other roles, you may omit this value to exclude this page. | [optional]
**label** | **String** | Label of the CC list as returned in workflow description | [optional]
**email** | **String** | Email of the CC participant of the agreement | [optional]



Loading