/* tslint:disable */ /* eslint-disable */ /** * Dropsigner *
In order to call this APIs, you will need an API key. Set the API key in the header X-Api-Key:
X-Api-Key: your-app|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 200 (OK) | Request processed successfully. The response is different for each API, please refer to the operation's documentation |
| 400 (Bad Request) | Syntax error. For instance, when a required field was not provided |
| 401 (Unauthorized) | API key not provided or invalid |
| 403 (Forbidden) | API key is valid, but the application has insufficient permissions to complete the requested operation |
| 422 (Unprocessable Entity) | API error. The response is as defined in ErrorModel |
Some of the error codes returned in a 422 response are provided bellow*:
*The codes shown above are the main error codes. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
It is recomended to subscribe to Webhook events instead of polling APIs. To do so, enable webhooks and register an URL that will receive a POST request whenever one of the events bellow occur.
All requests have the format described in Webhooks.WebhookModel. The data field varies according to the webhook event type:
| Event type | Description | Payload |
|---|---|---|
| DocumentSigned | Triggered when a document is signed. | Webhooks.DocumentSignedModel |
| DocumentApproved | Triggered when a document is approved. | Webhooks.DocumentApprovedModel |
| DocumentRefused | Triggered when a document is refused. | Webhooks.DocumentRefusedModel |
| DocumentConcluded | Triggered when the flow of a document is concluded. | Webhooks.DocumentConcludedModel |
| DocumentCanceled | Triggered when the document is canceled. | Webhooks.DocumentCanceledModel |
| DocumentsCreated (v1.50.0) | Triggered when one or more documents are created. | Webhooks.DocumentsCreatedModel |
To register your application URL and enable Webhooks, access the integrations section in your organization's details page.
* * OpenAPI spec version: 1.55.1 * * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ import { Configuration } from "./configuration"; // Some imports not used depending on template conditions // @ts-ignore import globalAxios, { AxiosRequestConfig, AxiosInstance } from 'axios'; export const BASE_PATH = "/".replace(/\/+$/, ""); /** * * @export */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", tsv: "\t", pipes: "|", }; /** * * @export * @interface RequestArgs */ export interface RequestArgs { url: string; options: AxiosRequestConfig; } /** * * @export * @class BaseAPI */ export class BaseAPI { protected configuration: Configuration | undefined; constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { if (configuration) { this.configuration = configuration; this.basePath = configuration.basePath || this.basePath; } } }; /** * * @export * @class RequiredError * @extends {Error} */ export class RequiredError extends Error { name: "RequiredError" = "RequiredError"; constructor(public field: string, msg?: string) { super(msg); } }