Skip to content
Merged
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
  •  
  •  
  •  
60 changes: 20 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,58 +47,30 @@ Please follow the [installation procedure](#installation--usage) and then run th
### TypeScript Example

```typescript
import * as DropboxSign from "@dropbox/sign";
import * as fs from 'fs';
import api from "@dropbox/sign"
import models from "@dropbox/sign"

const accountApi = new DropboxSign.AccountApi();
const apiCaller = new api.AccountApi();
apiCaller.username = "YOUR_API_KEY";
// apiCaller.accessToken = "YOUR_ACCESS_TOKEN";

// Configure HTTP basic authorization: api_key
accountApi.username = "YOUR_API_KEY";

// or, configure Bearer (JWT) authorization: oauth2
// accountApi.accessToken = "YOUR_ACCESS_TOKEN";

const data: DropboxSign.AccountCreateRequest = {
const accountCreateRequest: models.AccountCreateRequest = {
emailAddress: "[email protected]",
};

const result = accountApi.accountCreate(data);
result.then(response => {
apiCaller.accountCreate(
accountCreateRequest,
).then(response => {
console.log(response.body);
}).catch(error => {
console.log("Exception when calling Dropbox Sign API:");
console.log("Exception when calling AccountApi#accountCreate:");
console.log(error.body);
});


```

### JavaScript Example

```javascript
import * as DropboxSign from "@dropbox/sign";

const accountApi = new DropboxSign.AccountApi();

// Configure HTTP basic authorization: api_key
accountApi.username = "YOUR_API_KEY";

// or, configure Bearer (JWT) authorization: oauth2
// accountApi.accessToken = "YOUR_ACCESS_TOKEN";

const data = {
emailAddress: "[email protected]",
};

const result = accountApi.accountCreate(data);
result.then(response => {
console.log(response.body);
}).catch(error => {
console.log("Exception when calling Dropbox Sign API:");
console.log(error.body);
});

```



## API Endpoints
Expand All @@ -121,7 +93,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
| *EmbeddedApi* | [**embeddedEditUrl**](./docs/api/EmbeddedApi.md#embeddedediturl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL |
| *EmbeddedApi* | [**embeddedSignUrl**](./docs/api/EmbeddedApi.md#embeddedsignurl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL |
| *FaxApi* | [**faxDelete**](./docs/api/FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax |
| *FaxApi* | [**faxFiles**](./docs/api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files |
| *FaxApi* | [**faxFiles**](./docs/api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | Download Fax Files |
| *FaxApi* | [**faxGet**](./docs/api/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax |
| *FaxApi* | [**faxList**](./docs/api/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes |
| *FaxApi* | [**faxSend**](./docs/api/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax |
Expand All @@ -140,6 +112,10 @@ All URIs are relative to *https://api.hellosign.com/v3*
| *SignatureRequestApi* | [**signatureRequestCancel**](./docs/api/SignatureRequestApi.md#signaturerequestcancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request |
| *SignatureRequestApi* | [**signatureRequestCreateEmbedded**](./docs/api/SignatureRequestApi.md#signaturerequestcreateembedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request |
| *SignatureRequestApi* | [**signatureRequestCreateEmbeddedWithTemplate**](./docs/api/SignatureRequestApi.md#signaturerequestcreateembeddedwithtemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template |
| *SignatureRequestApi* | [**signatureRequestEdit**](./docs/api/SignatureRequestApi.md#signaturerequestedit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request |
| *SignatureRequestApi* | [**signatureRequestEditEmbedded**](./docs/api/SignatureRequestApi.md#signaturerequesteditembedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request |
| *SignatureRequestApi* | [**signatureRequestEditEmbeddedWithTemplate**](./docs/api/SignatureRequestApi.md#signaturerequesteditembeddedwithtemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template |
| *SignatureRequestApi* | [**signatureRequestEditWithTemplate**](./docs/api/SignatureRequestApi.md#signaturerequesteditwithtemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template |
| *SignatureRequestApi* | [**signatureRequestFiles**](./docs/api/SignatureRequestApi.md#signaturerequestfiles) | **GET** /signature_request/files/{signature_request_id} | Download Files |
| *SignatureRequestApi* | [**signatureRequestFilesAsDataUri**](./docs/api/SignatureRequestApi.md#signaturerequestfilesasdatauri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri |
| *SignatureRequestApi* | [**signatureRequestFilesAsFileUrl**](./docs/api/SignatureRequestApi.md#signaturerequestfilesasfileurl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url |
Expand Down Expand Up @@ -242,6 +218,10 @@ All URIs are relative to *https://api.hellosign.com/v3*
- [SignatureRequestBulkSendWithTemplateRequest](./docs/model/SignatureRequestBulkSendWithTemplateRequest.md)
- [SignatureRequestCreateEmbeddedRequest](./docs/model/SignatureRequestCreateEmbeddedRequest.md)
- [SignatureRequestCreateEmbeddedWithTemplateRequest](./docs/model/SignatureRequestCreateEmbeddedWithTemplateRequest.md)
- [SignatureRequestEditEmbeddedRequest](./docs/model/SignatureRequestEditEmbeddedRequest.md)
- [SignatureRequestEditEmbeddedWithTemplateRequest](./docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md)
- [SignatureRequestEditRequest](./docs/model/SignatureRequestEditRequest.md)
- [SignatureRequestEditWithTemplateRequest](./docs/model/SignatureRequestEditWithTemplateRequest.md)
- [SignatureRequestGetResponse](./docs/model/SignatureRequestGetResponse.md)
- [SignatureRequestListResponse](./docs/model/SignatureRequestListResponse.md)
- [SignatureRequestRemindRequest](./docs/model/SignatureRequestRemindRequest.md)
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.8.0
1.9.0
2 changes: 1 addition & 1 deletion api/apis.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export const queryParamsSerializer = (params) => {
return Qs.stringify(params, { arrayFormat: "brackets" });
};

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

/**
* Generates an object containing form data.
Expand Down
16 changes: 8 additions & 8 deletions api/faxApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ export class FaxApi {
}

/**
* Deletes the specified Fax from the system.
* Deletes the specified Fax from the system
* @summary Delete Fax
* @param faxId Fax ID
* @param options
Expand Down Expand Up @@ -220,8 +220,8 @@ export class FaxApi {
});
}
/**
* Returns list of fax files
* @summary List Fax Files
* Downloads files associated with a Fax
* @summary Download Fax Files
* @param faxId Fax ID
* @param options
*/
Expand Down Expand Up @@ -337,7 +337,7 @@ export class FaxApi {
});
}
/**
* Returns information about fax
* Returns information about a Fax
* @summary Get Fax
* @param faxId Fax ID
* @param options
Expand Down Expand Up @@ -454,10 +454,10 @@ export class FaxApi {
});
}
/**
* Returns properties of multiple faxes
* Returns properties of multiple Faxes
* @summary Lists Faxes
* @param page Page
* @param pageSize Page size
* @param page Which page number of the Fax List to return. Defaults to `1`.
* @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
* @param options
*/
public async faxList(
Expand Down Expand Up @@ -575,7 +575,7 @@ export class FaxApi {
});
}
/**
* Action to prepare and send a fax
* Creates and sends a new Fax with the submitted file(s)
* @summary Send Fax
* @param faxSendRequest
* @param options
Expand Down
22 changes: 11 additions & 11 deletions api/faxLineApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -261,12 +261,12 @@ export class FaxLineApi {
});
}
/**
* Returns a response with the area codes available for a given state/provice and city.
* Returns a list of available area codes for a given state/province and city
* @summary Get Available Fax Line Area Codes
* @param country Filter area codes by country.
* @param state Filter area codes by state.
* @param province Filter area codes by province.
* @param city Filter area codes by city.
* @param country Filter area codes by country
* @param state Filter area codes by state
* @param province Filter area codes by province
* @param city Filter area codes by city
* @param options
*/
public async faxLineAreaCodeGet(
Expand Down Expand Up @@ -473,7 +473,7 @@ export class FaxLineApi {
});
}
/**
* Purchases a new Fax Line.
* Purchases a new Fax Line
* @summary Purchase Fax Line
* @param faxLineCreateRequest
* @param options
Expand Down Expand Up @@ -735,7 +735,7 @@ export class FaxLineApi {
/**
* Returns the properties and settings of a Fax Line.
* @summary Get Fax Line
* @param number The Fax Line number.
* @param number The Fax Line number
* @param options
*/
public async faxLineGet(
Expand Down Expand Up @@ -855,9 +855,9 @@ export class FaxLineApi {
* Returns the properties and settings of multiple Fax Lines.
* @summary List Fax Lines
* @param accountId Account ID
* @param page Page
* @param pageSize Page size
* @param showTeamLines Show team lines
* @param page Which page number of the Fax Line List to return. Defaults to `1`.
* @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
* @param showTeamLines Include Fax Lines belonging to team members in the list
* @param options
*/
public async faxLineList(
Expand Down Expand Up @@ -993,7 +993,7 @@ export class FaxLineApi {
});
}
/**
* Removes a user\'s access to the specified Fax Line.
* Removes a user\'s access to the specified Fax Line
* @summary Remove Fax Line Access
* @param faxLineRemoveUserRequest
* @param options
Expand Down
Loading
Loading