/* tslint:disable */ /* eslint-disable */ /** * Dropsigner *

Authentication

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

HTTP Codes

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

Error Codes

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.


Webhooks

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
DocumentExpired (v1.33.0) Triggered when the document is expired. Webhooks.DocumentExpiredModel
DocumentsCreated (v1.50.0) Triggered when one or more documents are created. Webhooks.DocumentsCreatedModel
DocumentsDeleted (v1.78.0) Triggered when one or more documents are deleted. Webhooks.DocumentsDeletedModel

To register your application URL and enable Webhooks, access the integrations section in your organization's details page.

* * OpenAPI spec version: 2.6.0 * * * 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 globalAxios, { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios'; import { Configuration } from '../configuration'; // Some imports not used depending on template conditions // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; import { DocumentFlowsDocumentFlowCreateRequest } from '../models'; import { DocumentFlowsDocumentFlowData } from '../models'; import { DocumentFlowsDocumentFlowDetailsModel } from '../models'; import { DocumentFlowsDocumentFlowModel } from '../models'; import { ErrorModel } from '../models'; import { PaginatedSearchResponseDocumentFlowsDocumentFlowModel } from '../models'; import { PaginationOrders } from '../models'; /** * FlowsApi - axios parameter creator * @export */ export const FlowsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * * @summary List created flows. * @param {string} [Q] Query to filter items. * @param {number} [limit] Number of items to return. * @param {number} [offset] The offset of the searched page (starting with 0). * @param {PaginationOrders} [order] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiDocumentFlowsGet: async (Q?: string, limit?: number, offset?: number, order?: PaginationOrders, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/api/document-flows`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, 'https://example.com'); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication ApiKey required if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' ? await configuration.apiKey("X-Api-Key") : await configuration.apiKey; localVarHeaderParameter["X-Api-Key"] = localVarApiKeyValue; } if (Q !== undefined) { localVarQueryParameter['Q'] = Q; } if (limit !== undefined) { localVarQueryParameter['Limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['Offset'] = offset; } if (order !== undefined) { localVarQueryParameter['Order'] = order; } const query = new URLSearchParams(localVarUrlObj.search); for (const key in localVarQueryParameter) { query.set(key, localVarQueryParameter[key]); } for (const key in options.params) { query.set(key, options.params[key]); } localVarUrlObj.search = (new URLSearchParams(query)).toString(); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, options: localVarRequestOptions, }; }, /** * * @summary Deletes a flow. * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiDocumentFlowsIdDelete: async (id: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined if (id === null || id === undefined) { throw new RequiredError('id','Required parameter id was null or undefined when calling apiDocumentFlowsIdDelete.'); } const localVarPath = `/api/document-flows/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, 'https://example.com'); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions :AxiosRequestConfig = { method: 'DELETE', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication ApiKey required if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' ? await configuration.apiKey("X-Api-Key") : await configuration.apiKey; localVarHeaderParameter["X-Api-Key"] = localVarApiKeyValue; } const query = new URLSearchParams(localVarUrlObj.search); for (const key in localVarQueryParameter) { query.set(key, localVarQueryParameter[key]); } for (const key in options.params) { query.set(key, options.params[key]); } localVarUrlObj.search = (new URLSearchParams(query)).toString(); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, options: localVarRequestOptions, }; }, /** * * @summary Retrieves flow details * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiDocumentFlowsIdGet: async (id: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined if (id === null || id === undefined) { throw new RequiredError('id','Required parameter id was null or undefined when calling apiDocumentFlowsIdGet.'); } const localVarPath = `/api/document-flows/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, 'https://example.com'); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication ApiKey required if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' ? await configuration.apiKey("X-Api-Key") : await configuration.apiKey; localVarHeaderParameter["X-Api-Key"] = localVarApiKeyValue; } const query = new URLSearchParams(localVarUrlObj.search); for (const key in localVarQueryParameter) { query.set(key, localVarQueryParameter[key]); } for (const key in options.params) { query.set(key, options.params[key]); } localVarUrlObj.search = (new URLSearchParams(query)).toString(); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, options: localVarRequestOptions, }; }, /** * * @summary Updates a flow. * @param {string} id * @param {DocumentFlowsDocumentFlowData} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiDocumentFlowsIdPut: async (id: string, body?: DocumentFlowsDocumentFlowData, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined if (id === null || id === undefined) { throw new RequiredError('id','Required parameter id was null or undefined when calling apiDocumentFlowsIdPut.'); } const localVarPath = `/api/document-flows/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, 'https://example.com'); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions :AxiosRequestConfig = { method: 'PUT', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication ApiKey required if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' ? await configuration.apiKey("X-Api-Key") : await configuration.apiKey; localVarHeaderParameter["X-Api-Key"] = localVarApiKeyValue; } localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; const query = new URLSearchParams(localVarUrlObj.search); for (const key in localVarQueryParameter) { query.set(key, localVarQueryParameter[key]); } for (const key in options.params) { query.set(key, options.params[key]); } localVarUrlObj.search = (new URLSearchParams(query)).toString(); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; const needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || ""); return { url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, options: localVarRequestOptions, }; }, /** * * @summary Creates a flow that can be used to create documents * @param {DocumentFlowsDocumentFlowCreateRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ apiDocumentFlowsPost: async (body?: DocumentFlowsDocumentFlowCreateRequest, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/api/document-flows`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, 'https://example.com'); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions :AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication ApiKey required if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' ? await configuration.apiKey("X-Api-Key") : await configuration.apiKey; localVarHeaderParameter["X-Api-Key"] = localVarApiKeyValue; } localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; const query = new URLSearchParams(localVarUrlObj.search); for (const key in localVarQueryParameter) { query.set(key, localVarQueryParameter[key]); } for (const key in options.params) { query.set(key, options.params[key]); } localVarUrlObj.search = (new URLSearchParams(query)).toString(); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; const needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || ""); return { url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, options: localVarRequestOptions, }; }, } }; /** * FlowsApi - functional programming interface * @export */ export const FlowsApiFp = function(configuration?: Configuration) { return { /** * * @summary List created flows. * @param {string} [Q] Query to filter items. * @param {number} [limit] Number of items to return. * @param {number} [offset] The offset of the searched page (starting with 0). * @param {PaginationOrders} [order] * @param {*} [options] Override http request option. * @throws {RequiredError} */ async apiDocumentFlowsGet(Q?: string, limit?: number, offset?: number, order?: PaginationOrders, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>> { const localVarAxiosArgs = await FlowsApiAxiosParamCreator(configuration).apiDocumentFlowsGet(Q, limit, offset, order, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); }; }, /** * * @summary Deletes a flow. * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ async apiDocumentFlowsIdDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>> { const localVarAxiosArgs = await FlowsApiAxiosParamCreator(configuration).apiDocumentFlowsIdDelete(id, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); }; }, /** * * @summary Retrieves flow details * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ async apiDocumentFlowsIdGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>> { const localVarAxiosArgs = await FlowsApiAxiosParamCreator(configuration).apiDocumentFlowsIdGet(id, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); }; }, /** * * @summary Updates a flow. * @param {string} id * @param {DocumentFlowsDocumentFlowData} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ async apiDocumentFlowsIdPut(id: string, body?: DocumentFlowsDocumentFlowData, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>> { const localVarAxiosArgs = await FlowsApiAxiosParamCreator(configuration).apiDocumentFlowsIdPut(id, body, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); }; }, /** * * @summary Creates a flow that can be used to create documents * @param {DocumentFlowsDocumentFlowCreateRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ async apiDocumentFlowsPost(body?: DocumentFlowsDocumentFlowCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>> { const localVarAxiosArgs = await FlowsApiAxiosParamCreator(configuration).apiDocumentFlowsPost(body, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); }; }, } }; /** * FlowsApi - factory interface * @export */ export const FlowsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { return { /** * * @summary List created flows. * @param {string} [Q] Query to filter items. * @param {number} [limit] Number of items to return. * @param {number} [offset] The offset of the searched page (starting with 0). * @param {PaginationOrders} [order] * @param {*} [options] Override http request option. * @throws {RequiredError} */ async apiDocumentFlowsGet(Q?: string, limit?: number, offset?: number, order?: PaginationOrders, options?: AxiosRequestConfig): Promise> { return FlowsApiFp(configuration).apiDocumentFlowsGet(Q, limit, offset, order, options).then((request) => request(axios, basePath)); }, /** * * @summary Deletes a flow. * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ async apiDocumentFlowsIdDelete(id: string, options?: AxiosRequestConfig): Promise> { return FlowsApiFp(configuration).apiDocumentFlowsIdDelete(id, options).then((request) => request(axios, basePath)); }, /** * * @summary Retrieves flow details * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ async apiDocumentFlowsIdGet(id: string, options?: AxiosRequestConfig): Promise> { return FlowsApiFp(configuration).apiDocumentFlowsIdGet(id, options).then((request) => request(axios, basePath)); }, /** * * @summary Updates a flow. * @param {string} id * @param {DocumentFlowsDocumentFlowData} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ async apiDocumentFlowsIdPut(id: string, body?: DocumentFlowsDocumentFlowData, options?: AxiosRequestConfig): Promise> { return FlowsApiFp(configuration).apiDocumentFlowsIdPut(id, body, options).then((request) => request(axios, basePath)); }, /** * * @summary Creates a flow that can be used to create documents * @param {DocumentFlowsDocumentFlowCreateRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ async apiDocumentFlowsPost(body?: DocumentFlowsDocumentFlowCreateRequest, options?: AxiosRequestConfig): Promise> { return FlowsApiFp(configuration).apiDocumentFlowsPost(body, options).then((request) => request(axios, basePath)); }, }; }; /** * FlowsApi - object-oriented interface * @export * @class FlowsApi * @extends {BaseAPI} */ export class FlowsApi extends BaseAPI { /** * * @summary List created flows. * @param {string} [Q] Query to filter items. * @param {number} [limit] Number of items to return. * @param {number} [offset] The offset of the searched page (starting with 0). * @param {PaginationOrders} [order] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlowsApi */ public async apiDocumentFlowsGet(Q?: string, limit?: number, offset?: number, order?: PaginationOrders, options?: AxiosRequestConfig) : Promise> { return FlowsApiFp(this.configuration).apiDocumentFlowsGet(Q, limit, offset, order, options).then((request) => request(this.axios, this.basePath)); } /** * * @summary Deletes a flow. * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlowsApi */ public async apiDocumentFlowsIdDelete(id: string, options?: AxiosRequestConfig) : Promise> { return FlowsApiFp(this.configuration).apiDocumentFlowsIdDelete(id, options).then((request) => request(this.axios, this.basePath)); } /** * * @summary Retrieves flow details * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlowsApi */ public async apiDocumentFlowsIdGet(id: string, options?: AxiosRequestConfig) : Promise> { return FlowsApiFp(this.configuration).apiDocumentFlowsIdGet(id, options).then((request) => request(this.axios, this.basePath)); } /** * * @summary Updates a flow. * @param {string} id * @param {DocumentFlowsDocumentFlowData} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlowsApi */ public async apiDocumentFlowsIdPut(id: string, body?: DocumentFlowsDocumentFlowData, options?: AxiosRequestConfig) : Promise> { return FlowsApiFp(this.configuration).apiDocumentFlowsIdPut(id, body, options).then((request) => request(this.axios, this.basePath)); } /** * * @summary Creates a flow that can be used to create documents * @param {DocumentFlowsDocumentFlowCreateRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FlowsApi */ public async apiDocumentFlowsPost(body?: DocumentFlowsDocumentFlowCreateRequest, options?: AxiosRequestConfig) : Promise> { return FlowsApiFp(this.configuration).apiDocumentFlowsPost(body, options).then((request) => request(this.axios, this.basePath)); } }