Skip to content

Commit f35e22b

Browse files
alyx-dbalyx-db
committed
more updates
1 parent 88e9922 commit f35e22b

239 files changed

Lines changed: 12824 additions & 157 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎sdks/java-v1/docs/AccountApi.md‎

Lines changed: 345 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,345 @@
1+
# AccountApi
2+
3+
All URIs are relative to *https://api.hellosign.com/v3*
4+
5+
| Method | HTTP request | Description |
6+
|------------- | ------------- | -------------|
7+
[**accountCreate**](AccountApi.md#accountCreate) | **POST** /account/create | Create Account
8+
[**accountGet**](AccountApi.md#accountGet) | **GET** /account | Get Account
9+
[**accountUpdate**](AccountApi.md#accountUpdate) | **PUT** /account | Update Account
10+
[**accountVerify**](AccountApi.md#accountVerify) | **POST** /account/verify | Verify Account
11+
12+
13+
14+
## accountCreate
15+
16+
> AccountCreateResponse accountCreate(accountCreateRequest)
17+
18+
Create Account
19+
20+
Creates a new Dropbox Sign Account that is associated with the specified `email_address`.
21+
22+
### Example
23+
24+
```java
25+
package com.dropbox.sign_sandbox;
26+
27+
import com.dropbox.sign.ApiException;
28+
import com.dropbox.sign.Configuration;
29+
import com.dropbox.sign.api.*;
30+
import com.dropbox.sign.auth.*;
31+
import com.dropbox.sign.JSON;
32+
import com.dropbox.sign.model.*;
33+
34+
import java.io.File;
35+
import java.time.LocalDate;
36+
import java.time.OffsetDateTime;
37+
import java.util.ArrayList;
38+
import java.util.List;
39+
import java.util.Map;
40+
41+
public class AccountCreateExample
42+
{
43+
public static void main(String[] args)
44+
{
45+
var config = Configuration.getDefaultApiClient();
46+
config.setUsername("YOUR_API_KEY");
47+
// config.setAccessToken("YOUR_ACCESS_TOKEN");
48+
49+
var accountCreateRequest = new AccountCreateRequest();
50+
accountCreateRequest.emailAddress("newuser@dropboxsign.com");
51+
52+
try
53+
{
54+
var response = new AccountApi(config).accountCreate(
55+
accountCreateRequest
56+
);
57+
58+
System.out.println(response);
59+
} catch (ApiException e) {
60+
System.err.println("Exception when calling AccountApi#accountCreate");
61+
System.err.println("Status code: " + e.getCode());
62+
System.err.println("Reason: " + e.getResponseBody());
63+
System.err.println("Response headers: " + e.getResponseHeaders());
64+
e.printStackTrace();
65+
}
66+
}
67+
}
68+
69+
```
70+
71+
### Parameters
72+
73+
74+
| Name | Type | Description | Notes |
75+
|------------- | ------------- | ------------- | -------------|
76+
**accountCreateRequest** | [**AccountCreateRequest**](AccountCreateRequest.md)| |
77+
78+
### Return type
79+
80+
[**AccountCreateResponse**](AccountCreateResponse.md)
81+
82+
### Authorization
83+
84+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
85+
86+
### HTTP request headers
87+
88+
- **Content-Type**: application/json
89+
- **Accept**: application/json
90+
91+
### HTTP response details
92+
| Status code | Description | Response headers |
93+
|-------------|-------------|------------------|
94+
| **200** | successful operation | * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> |
95+
| **4XX** | failed_operation | - |
96+
97+
98+
## accountGet
99+
100+
> AccountGetResponse accountGet(accountId, emailAddress)
101+
102+
Get Account
103+
104+
Returns the properties and settings of your Account.
105+
106+
### Example
107+
108+
```java
109+
package com.dropbox.sign_sandbox;
110+
111+
import com.dropbox.sign.ApiException;
112+
import com.dropbox.sign.Configuration;
113+
import com.dropbox.sign.api.*;
114+
import com.dropbox.sign.auth.*;
115+
import com.dropbox.sign.JSON;
116+
import com.dropbox.sign.model.*;
117+
118+
import java.io.File;
119+
import java.time.LocalDate;
120+
import java.time.OffsetDateTime;
121+
import java.util.ArrayList;
122+
import java.util.List;
123+
import java.util.Map;
124+
125+
public class AccountGetExample
126+
{
127+
public static void main(String[] args)
128+
{
129+
var config = Configuration.getDefaultApiClient();
130+
config.setUsername("YOUR_API_KEY");
131+
// config.setAccessToken("YOUR_ACCESS_TOKEN");
132+
133+
try
134+
{
135+
var response = new AccountApi(config).accountGet();
136+
137+
System.out.println(response);
138+
} catch (ApiException e) {
139+
System.err.println("Exception when calling AccountApi#accountGet");
140+
System.err.println("Status code: " + e.getCode());
141+
System.err.println("Reason: " + e.getResponseBody());
142+
System.err.println("Response headers: " + e.getResponseHeaders());
143+
e.printStackTrace();
144+
}
145+
}
146+
}
147+
148+
```
149+
150+
### Parameters
151+
152+
153+
| Name | Type | Description | Notes |
154+
|------------- | ------------- | ------------- | -------------|
155+
**accountId** | **String**| `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. | [optional]
156+
**emailAddress** | **String**| `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. | [optional]
157+
158+
### Return type
159+
160+
[**AccountGetResponse**](AccountGetResponse.md)
161+
162+
### Authorization
163+
164+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
165+
166+
### HTTP request headers
167+
168+
- **Content-Type**: Not defined
169+
- **Accept**: application/json
170+
171+
### HTTP response details
172+
| Status code | Description | Response headers |
173+
|-------------|-------------|------------------|
174+
| **200** | successful operation | * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> |
175+
| **4XX** | failed_operation | - |
176+
177+
178+
## accountUpdate
179+
180+
> AccountGetResponse accountUpdate(accountUpdateRequest)
181+
182+
Update Account
183+
184+
Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale.
185+
186+
### Example
187+
188+
```java
189+
package com.dropbox.sign_sandbox;
190+
191+
import com.dropbox.sign.ApiException;
192+
import com.dropbox.sign.Configuration;
193+
import com.dropbox.sign.api.*;
194+
import com.dropbox.sign.auth.*;
195+
import com.dropbox.sign.JSON;
196+
import com.dropbox.sign.model.*;
197+
198+
import java.io.File;
199+
import java.time.LocalDate;
200+
import java.time.OffsetDateTime;
201+
import java.util.ArrayList;
202+
import java.util.List;
203+
import java.util.Map;
204+
205+
public class AccountUpdateExample
206+
{
207+
public static void main(String[] args)
208+
{
209+
var config = Configuration.getDefaultApiClient();
210+
config.setUsername("YOUR_API_KEY");
211+
// config.setAccessToken("YOUR_ACCESS_TOKEN");
212+
213+
var accountUpdateRequest = new AccountUpdateRequest();
214+
accountUpdateRequest.callbackUrl("https://www.example.com/callback");
215+
accountUpdateRequest.locale("en-US");
216+
217+
try
218+
{
219+
var response = new AccountApi(config).accountUpdate(
220+
accountUpdateRequest
221+
);
222+
223+
System.out.println(response);
224+
} catch (ApiException e) {
225+
System.err.println("Exception when calling AccountApi#accountUpdate");
226+
System.err.println("Status code: " + e.getCode());
227+
System.err.println("Reason: " + e.getResponseBody());
228+
System.err.println("Response headers: " + e.getResponseHeaders());
229+
e.printStackTrace();
230+
}
231+
}
232+
}
233+
234+
```
235+
236+
### Parameters
237+
238+
239+
| Name | Type | Description | Notes |
240+
|------------- | ------------- | ------------- | -------------|
241+
**accountUpdateRequest** | [**AccountUpdateRequest**](AccountUpdateRequest.md)| |
242+
243+
### Return type
244+
245+
[**AccountGetResponse**](AccountGetResponse.md)
246+
247+
### Authorization
248+
249+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
250+
251+
### HTTP request headers
252+
253+
- **Content-Type**: application/json
254+
- **Accept**: application/json
255+
256+
### HTTP response details
257+
| Status code | Description | Response headers |
258+
|-------------|-------------|------------------|
259+
| **200** | successful operation | * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> |
260+
| **4XX** | failed_operation | - |
261+
262+
263+
## accountVerify
264+
265+
> AccountVerifyResponse accountVerify(accountVerifyRequest)
266+
267+
Verify Account
268+
269+
Verifies whether an Dropbox Sign Account exists for the given email address.
270+
271+
### Example
272+
273+
```java
274+
package com.dropbox.sign_sandbox;
275+
276+
import com.dropbox.sign.ApiException;
277+
import com.dropbox.sign.Configuration;
278+
import com.dropbox.sign.api.*;
279+
import com.dropbox.sign.auth.*;
280+
import com.dropbox.sign.JSON;
281+
import com.dropbox.sign.model.*;
282+
283+
import java.io.File;
284+
import java.time.LocalDate;
285+
import java.time.OffsetDateTime;
286+
import java.util.ArrayList;
287+
import java.util.List;
288+
import java.util.Map;
289+
290+
public class AccountVerifyExample
291+
{
292+
public static void main(String[] args)
293+
{
294+
var config = Configuration.getDefaultApiClient();
295+
config.setUsername("YOUR_API_KEY");
296+
// config.setAccessToken("YOUR_ACCESS_TOKEN");
297+
298+
var accountVerifyRequest = new AccountVerifyRequest();
299+
accountVerifyRequest.emailAddress("some_user@dropboxsign.com");
300+
301+
try
302+
{
303+
var response = new AccountApi(config).accountVerify(
304+
accountVerifyRequest
305+
);
306+
307+
System.out.println(response);
308+
} catch (ApiException e) {
309+
System.err.println("Exception when calling AccountApi#accountVerify");
310+
System.err.println("Status code: " + e.getCode());
311+
System.err.println("Reason: " + e.getResponseBody());
312+
System.err.println("Response headers: " + e.getResponseHeaders());
313+
e.printStackTrace();
314+
}
315+
}
316+
}
317+
318+
```
319+
320+
### Parameters
321+
322+
323+
| Name | Type | Description | Notes |
324+
|------------- | ------------- | ------------- | -------------|
325+
**accountVerifyRequest** | [**AccountVerifyRequest**](AccountVerifyRequest.md)| |
326+
327+
### Return type
328+
329+
[**AccountVerifyResponse**](AccountVerifyResponse.md)
330+
331+
### Authorization
332+
333+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
334+
335+
### HTTP request headers
336+
337+
- **Content-Type**: application/json
338+
- **Accept**: application/json
339+
340+
### HTTP response details
341+
| Status code | Description | Response headers |
342+
|-------------|-------------|------------------|
343+
| **200** | successful operation | * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> |
344+
| **4XX** | failed_operation | - |
345+

‎sdks/java-v1/docs/AccountCreateRequest.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
3+
# AccountCreateRequest
4+
5+
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
| `emailAddress`<sup>*_required_</sup> | ```String``` | The email address which will be associated with the new Account. | |
12+
| `clientId` | ```String``` | Used when creating a new account with OAuth authorization.<br><br>See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) | |
13+
| `clientSecret` | ```String``` | Used when creating a new account with OAuth authorization.<br><br>See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) | |
14+
| `locale` | ```String``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | |
15+
16+
17+

‎sdks/java-v1/docs/AccountCreateResponse.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
3+
# AccountCreateResponse
4+
5+
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
| `account`<sup>*_required_</sup> | [```AccountResponse```](AccountResponse.md) | | |
12+
| `oauthData` | [```OAuthTokenResponse```](OAuthTokenResponse.md) | | |
13+
| `warnings` | [```List<WarningResponse>```](WarningResponse.md) | A list of warnings. | |
14+
15+
16+

‎sdks/java-v1/docs/AccountGetResponse.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
3+
# AccountGetResponse
4+
5+
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
| `account`<sup>*_required_</sup> | [```AccountResponse```](AccountResponse.md) | | |
12+
| `warnings` | [```List<WarningResponse>```](WarningResponse.md) | A list of warnings. | |
13+
14+
15+

0 commit comments

Comments
 (0)