/**
* 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*:
- CertificateNotFound
- DocumentNotFound
- FolderNotFound
- CpfMismatch
- CpfNotExpected
- InvalidFlowAction
- DocumentInvalidKey
*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:
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 { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { FoldersFolderCreateRequest } from '../models';
import { FoldersFolderDeleteRequest } from '../models';
import { FoldersFolderInfoModel } from '../models';
import { FoldersFolderOrganizationModel } from '../models';
import { PaginatedSearchResponseFoldersFolderInfoModel } from '../models';
import { PaginationOrders } from '../models';
/**
* FoldersApi - axios parameter creator
* @export
*/
export declare const FoldersApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* The Q parameter allows you to filter by folder name.
* @summary Retrieves all folders paginating the response
* @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 {boolean} [filterByParent] if true filters by the parentId parameter
* @param {string} [parentId] Id of the parent folder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersGet: (Q?: string, limit?: number, offset?: number, order?: PaginationOrders, filterByParent?: boolean, parentId?: string, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Deletes a folder.
* @param {string} id Id of the folder to be deleted
* @param {FoldersFolderDeleteRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersIdDeletePost: (id: string, body?: FoldersFolderDeleteRequest, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Retrieves the folder's info.
* @param {string} id Folder id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersIdGet: (id: string, options?: AxiosRequestConfig) => Promise;
/**
*
* @summary Creates a folder.
* @param {FoldersFolderCreateRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersPost: (body?: FoldersFolderCreateRequest, options?: AxiosRequestConfig) => Promise;
};
/**
* FoldersApi - functional programming interface
* @export
*/
export declare const FoldersApiFp: (configuration?: Configuration) => {
/**
* The Q parameter allows you to filter by folder name.
* @summary Retrieves all folders paginating the response
* @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 {boolean} [filterByParent] if true filters by the parentId parameter
* @param {string} [parentId] Id of the parent folder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersGet(Q?: string, limit?: number, offset?: number, order?: PaginationOrders, filterByParent?: boolean, parentId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>>;
/**
*
* @summary Deletes a folder.
* @param {string} id Id of the folder to be deleted
* @param {FoldersFolderDeleteRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersIdDeletePost(id: string, body?: FoldersFolderDeleteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>>;
/**
*
* @summary Retrieves the folder's info.
* @param {string} id Folder id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersIdGet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>>;
/**
*
* @summary Creates a folder.
* @param {FoldersFolderCreateRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersPost(body?: FoldersFolderCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>>;
};
/**
* FoldersApi - factory interface
* @export
*/
export declare const FoldersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* The Q parameter allows you to filter by folder name.
* @summary Retrieves all folders paginating the response
* @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 {boolean} [filterByParent] if true filters by the parentId parameter
* @param {string} [parentId] Id of the parent folder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersGet(Q?: string, limit?: number, offset?: number, order?: PaginationOrders, filterByParent?: boolean, parentId?: string, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Deletes a folder.
* @param {string} id Id of the folder to be deleted
* @param {FoldersFolderDeleteRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersIdDeletePost(id: string, body?: FoldersFolderDeleteRequest, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Retrieves the folder's info.
* @param {string} id Folder id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersIdGet(id: string, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Creates a folder.
* @param {FoldersFolderCreateRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiFoldersPost(body?: FoldersFolderCreateRequest, options?: AxiosRequestConfig): Promise>;
};
/**
* FoldersApi - object-oriented interface
* @export
* @class FoldersApi
* @extends {BaseAPI}
*/
export declare class FoldersApi extends BaseAPI {
/**
* The Q parameter allows you to filter by folder name.
* @summary Retrieves all folders paginating the response
* @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 {boolean} [filterByParent] if true filters by the parentId parameter
* @param {string} [parentId] Id of the parent folder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FoldersApi
*/
apiFoldersGet(Q?: string, limit?: number, offset?: number, order?: PaginationOrders, filterByParent?: boolean, parentId?: string, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Deletes a folder.
* @param {string} id Id of the folder to be deleted
* @param {FoldersFolderDeleteRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FoldersApi
*/
apiFoldersIdDeletePost(id: string, body?: FoldersFolderDeleteRequest, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Retrieves the folder's info.
* @param {string} id Folder id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FoldersApi
*/
apiFoldersIdGet(id: string, options?: AxiosRequestConfig): Promise>;
/**
*
* @summary Creates a folder.
* @param {FoldersFolderCreateRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FoldersApi
*/
apiFoldersPost(body?: FoldersFolderCreateRequest, options?: AxiosRequestConfig): Promise>;
}