AccountApi.md

AccountApi

All URIs are relative to https://api.hellosign.com/v3.

Method	HTTP request	Description
accountCreate()	POST /account/create	Create Account
accountGet()	GET /account	Get Account
accountUpdate()	PUT /account	Update Account
accountVerify()	POST /account/verify	Verify Account

accountCreate()

accountCreate(accountCreateRequest: AccountCreateRequest): AccountCreateResponse

Create Account

Creates a new Dropbox Sign Account that is associated with the specified email_address.

TypeScript Example

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

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

const accountCreateRequest: models.AccountCreateRequest = {
  emailAddress: "newuser@dropboxsign.com",
};

apiCaller.accountCreate(
  accountCreateRequest,
).then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling AccountApi#accountCreate:");
  console.log(error.body);
});

Parameters

Name	Type	Description	Notes
accountCreateRequest	AccountCreateRequest

Return type

AccountCreateResponse

Authorization

api_key, oauth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountGet()

accountGet(accountId: string, emailAddress: string): AccountGetResponse

Get Account

Returns the properties and settings of your Account.

TypeScript Example

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

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

apiCaller.accountGet().then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling AccountApi#accountGet:");
  console.log(error.body);
});

Parameters

Name	Type	Description	Notes
accountId	string	account_id or email_address is required. If both are provided, the account id prevails. The ID of the Account.	[optional]
emailAddress	string	account_id or email_address is required, If both are provided, the account id prevails. The email address of the Account.	[optional]

Return type

AccountGetResponse

Authorization

api_key, oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountUpdate()

accountUpdate(accountUpdateRequest: AccountUpdateRequest): AccountGetResponse

Update Account

Updates the properties and settings of your Account. Currently only allows for updates to the Callback URL and locale.

TypeScript Example

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

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

const accountUpdateRequest: models.AccountUpdateRequest = {
  callbackUrl: "https://www.example.com/callback",
  locale: "en-US",
};

apiCaller.accountUpdate(
  accountUpdateRequest,
).then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling AccountApi#accountUpdate:");
  console.log(error.body);
});

Parameters

Name	Type	Description	Notes
accountUpdateRequest	AccountUpdateRequest

Return type

AccountGetResponse

Authorization

api_key, oauth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountVerify()

accountVerify(accountVerifyRequest: AccountVerifyRequest): AccountVerifyResponse

Verify Account

Verifies whether an Dropbox Sign Account exists for the given email address.

TypeScript Example

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

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

const accountVerifyRequest: models.AccountVerifyRequest = {
  emailAddress: "some_user@dropboxsign.com",
};

apiCaller.accountVerify(
  accountVerifyRequest,
).then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling AccountApi#accountVerify:");
  console.log(error.body);
});

Parameters

Name	Type	Description	Notes
accountVerifyRequest	AccountVerifyRequest

Return type

AccountVerifyResponse

Authorization

api_key, oauth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]