Skip to content

Commit 2708c62

Browse files
Release 1.9.0 (#24)
* Release 1.9.0 * Add edit&resend to OpenAPI docs, and note that it uses quota
1 parent a130fff commit 2708c62

306 files changed

Lines changed: 26558 additions & 22849 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.

README.md

Lines changed: 20 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -47,58 +47,30 @@ Please follow the [installation procedure](#installation--usage) and then run th
4747
### TypeScript Example
4848

4949
```typescript
50-
import * as DropboxSign from "@dropbox/sign";
50+
import * as fs from 'fs';
51+
import api from "@dropbox/sign"
52+
import models from "@dropbox/sign"
5153

52-
const accountApi = new DropboxSign.AccountApi();
54+
const apiCaller = new api.AccountApi();
55+
apiCaller.username = "YOUR_API_KEY";
56+
// apiCaller.accessToken = "YOUR_ACCESS_TOKEN";
5357

54-
// Configure HTTP basic authorization: api_key
55-
accountApi.username = "YOUR_API_KEY";
56-
57-
// or, configure Bearer (JWT) authorization: oauth2
58-
// accountApi.accessToken = "YOUR_ACCESS_TOKEN";
59-
60-
const data: DropboxSign.AccountCreateRequest = {
58+
const accountCreateRequest: models.AccountCreateRequest = {
6159
emailAddress: "newuser@dropboxsign.com",
6260
};
6361

64-
const result = accountApi.accountCreate(data);
65-
result.then(response => {
62+
apiCaller.accountCreate(
63+
accountCreateRequest,
64+
).then(response => {
6665
console.log(response.body);
6766
}).catch(error => {
68-
console.log("Exception when calling Dropbox Sign API:");
67+
console.log("Exception when calling AccountApi#accountCreate:");
6968
console.log(error.body);
7069
});
7170

7271

7372
```
7473

75-
### JavaScript Example
76-
77-
```javascript
78-
import * as DropboxSign from "@dropbox/sign";
79-
80-
const accountApi = new DropboxSign.AccountApi();
81-
82-
// Configure HTTP basic authorization: api_key
83-
accountApi.username = "YOUR_API_KEY";
84-
85-
// or, configure Bearer (JWT) authorization: oauth2
86-
// accountApi.accessToken = "YOUR_ACCESS_TOKEN";
87-
88-
const data = {
89-
emailAddress: "newuser@dropboxsign.com",
90-
};
91-
92-
const result = accountApi.accountCreate(data);
93-
result.then(response => {
94-
console.log(response.body);
95-
}).catch(error => {
96-
console.log("Exception when calling Dropbox Sign API:");
97-
console.log(error.body);
98-
});
99-
100-
```
101-
10274

10375

10476
## API Endpoints
@@ -121,7 +93,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
12193
| *EmbeddedApi* | [**embeddedEditUrl**](./docs/api/EmbeddedApi.md#embeddedediturl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL |
12294
| *EmbeddedApi* | [**embeddedSignUrl**](./docs/api/EmbeddedApi.md#embeddedsignurl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL |
12395
| *FaxApi* | [**faxDelete**](./docs/api/FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax |
124-
| *FaxApi* | [**faxFiles**](./docs/api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files |
96+
| *FaxApi* | [**faxFiles**](./docs/api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | Download Fax Files |
12597
| *FaxApi* | [**faxGet**](./docs/api/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax |
12698
| *FaxApi* | [**faxList**](./docs/api/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes |
12799
| *FaxApi* | [**faxSend**](./docs/api/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax |
@@ -140,6 +112,10 @@ All URIs are relative to *https://api.hellosign.com/v3*
140112
| *SignatureRequestApi* | [**signatureRequestCancel**](./docs/api/SignatureRequestApi.md#signaturerequestcancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request |
141113
| *SignatureRequestApi* | [**signatureRequestCreateEmbedded**](./docs/api/SignatureRequestApi.md#signaturerequestcreateembedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request |
142114
| *SignatureRequestApi* | [**signatureRequestCreateEmbeddedWithTemplate**](./docs/api/SignatureRequestApi.md#signaturerequestcreateembeddedwithtemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template |
115+
| *SignatureRequestApi* | [**signatureRequestEdit**](./docs/api/SignatureRequestApi.md#signaturerequestedit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request |
116+
| *SignatureRequestApi* | [**signatureRequestEditEmbedded**](./docs/api/SignatureRequestApi.md#signaturerequesteditembedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request |
117+
| *SignatureRequestApi* | [**signatureRequestEditEmbeddedWithTemplate**](./docs/api/SignatureRequestApi.md#signaturerequesteditembeddedwithtemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template |
118+
| *SignatureRequestApi* | [**signatureRequestEditWithTemplate**](./docs/api/SignatureRequestApi.md#signaturerequesteditwithtemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template |
143119
| *SignatureRequestApi* | [**signatureRequestFiles**](./docs/api/SignatureRequestApi.md#signaturerequestfiles) | **GET** /signature_request/files/{signature_request_id} | Download Files |
144120
| *SignatureRequestApi* | [**signatureRequestFilesAsDataUri**](./docs/api/SignatureRequestApi.md#signaturerequestfilesasdatauri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri |
145121
| *SignatureRequestApi* | [**signatureRequestFilesAsFileUrl**](./docs/api/SignatureRequestApi.md#signaturerequestfilesasfileurl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url |
@@ -242,6 +218,10 @@ All URIs are relative to *https://api.hellosign.com/v3*
242218
- [SignatureRequestBulkSendWithTemplateRequest](./docs/model/SignatureRequestBulkSendWithTemplateRequest.md)
243219
- [SignatureRequestCreateEmbeddedRequest](./docs/model/SignatureRequestCreateEmbeddedRequest.md)
244220
- [SignatureRequestCreateEmbeddedWithTemplateRequest](./docs/model/SignatureRequestCreateEmbeddedWithTemplateRequest.md)
221+
- [SignatureRequestEditEmbeddedRequest](./docs/model/SignatureRequestEditEmbeddedRequest.md)
222+
- [SignatureRequestEditEmbeddedWithTemplateRequest](./docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md)
223+
- [SignatureRequestEditRequest](./docs/model/SignatureRequestEditRequest.md)
224+
- [SignatureRequestEditWithTemplateRequest](./docs/model/SignatureRequestEditWithTemplateRequest.md)
245225
- [SignatureRequestGetResponse](./docs/model/SignatureRequestGetResponse.md)
246226
- [SignatureRequestListResponse](./docs/model/SignatureRequestListResponse.md)
247227
- [SignatureRequestRemindRequest](./docs/model/SignatureRequestRemindRequest.md)

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.8.0
1+
1.9.0

api/apis.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export const queryParamsSerializer = (params) => {
3838
return Qs.stringify(params, { arrayFormat: "brackets" });
3939
};
4040

41-
export const USER_AGENT = "OpenAPI-Generator/1.8.0/node";
41+
export const USER_AGENT = "OpenAPI-Generator/1.9.0/node";
4242

4343
/**
4444
* Generates an object containing form data.

api/faxApi.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ export class FaxApi {
119119
}
120120

121121
/**
122-
* Deletes the specified Fax from the system.
122+
* Deletes the specified Fax from the system
123123
* @summary Delete Fax
124124
* @param faxId Fax ID
125125
* @param options
@@ -220,8 +220,8 @@ export class FaxApi {
220220
});
221221
}
222222
/**
223-
* Returns list of fax files
224-
* @summary List Fax Files
223+
* Downloads files associated with a Fax
224+
* @summary Download Fax Files
225225
* @param faxId Fax ID
226226
* @param options
227227
*/
@@ -337,7 +337,7 @@ export class FaxApi {
337337
});
338338
}
339339
/**
340-
* Returns information about fax
340+
* Returns information about a Fax
341341
* @summary Get Fax
342342
* @param faxId Fax ID
343343
* @param options
@@ -454,10 +454,10 @@ export class FaxApi {
454454
});
455455
}
456456
/**
457-
* Returns properties of multiple faxes
457+
* Returns properties of multiple Faxes
458458
* @summary Lists Faxes
459-
* @param page Page
460-
* @param pageSize Page size
459+
* @param page Which page number of the Fax List to return. Defaults to `1`.
460+
* @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
461461
* @param options
462462
*/
463463
public async faxList(
@@ -575,7 +575,7 @@ export class FaxApi {
575575
});
576576
}
577577
/**
578-
* Action to prepare and send a fax
578+
* Creates and sends a new Fax with the submitted file(s)
579579
* @summary Send Fax
580580
* @param faxSendRequest
581581
* @param options

api/faxLineApi.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -261,12 +261,12 @@ export class FaxLineApi {
261261
});
262262
}
263263
/**
264-
* Returns a response with the area codes available for a given state/provice and city.
264+
* Returns a list of available area codes for a given state/province and city
265265
* @summary Get Available Fax Line Area Codes
266-
* @param country Filter area codes by country.
267-
* @param state Filter area codes by state.
268-
* @param province Filter area codes by province.
269-
* @param city Filter area codes by city.
266+
* @param country Filter area codes by country
267+
* @param state Filter area codes by state
268+
* @param province Filter area codes by province
269+
* @param city Filter area codes by city
270270
* @param options
271271
*/
272272
public async faxLineAreaCodeGet(
@@ -473,7 +473,7 @@ export class FaxLineApi {
473473
});
474474
}
475475
/**
476-
* Purchases a new Fax Line.
476+
* Purchases a new Fax Line
477477
* @summary Purchase Fax Line
478478
* @param faxLineCreateRequest
479479
* @param options
@@ -735,7 +735,7 @@ export class FaxLineApi {
735735
/**
736736
* Returns the properties and settings of a Fax Line.
737737
* @summary Get Fax Line
738-
* @param number The Fax Line number.
738+
* @param number The Fax Line number
739739
* @param options
740740
*/
741741
public async faxLineGet(
@@ -855,9 +855,9 @@ export class FaxLineApi {
855855
* Returns the properties and settings of multiple Fax Lines.
856856
* @summary List Fax Lines
857857
* @param accountId Account ID
858-
* @param page Page
859-
* @param pageSize Page size
860-
* @param showTeamLines Show team lines
858+
* @param page Which page number of the Fax Line List to return. Defaults to `1`.
859+
* @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
860+
* @param showTeamLines Include Fax Lines belonging to team members in the list
861861
* @param options
862862
*/
863863
public async faxLineList(
@@ -993,7 +993,7 @@ export class FaxLineApi {
993993
});
994994
}
995995
/**
996-
* Removes a user\'s access to the specified Fax Line.
996+
* Removes a user\'s access to the specified Fax Line
997997
* @summary Remove Fax Line Access
998998
* @param faxLineRemoveUserRequest
999999
* @param options

0 commit comments

Comments
 (0)