/* 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*:
- 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 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 { ErrorModel } from '../models';
import { OrganizationsOrganizationUserModel } from '../models';
import { OrganizationsOrganizationUserPostRequest } from '../models';
import { PaginatedSearchResponseOrganizationsOrganizationUserModel } from '../models';
import { PaginationOrders } from '../models';
/**
* OrganizationsApi - axios parameter creator
* @export
*/
export const OrganizationsApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* @summary List organization users
* @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}
*/
apiOrganizationsUsersGet: async (Q?: string, limit?: number, offset?: number, order?: PaginationOrders, options: AxiosRequestConfig = {}): Promise => {
const localVarPath = `/api/organizations/users`;
// 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 Adds a user to the organization
* @param {OrganizationsOrganizationUserPostRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiOrganizationsUsersPost: async (body?: OrganizationsOrganizationUserPostRequest, options: AxiosRequestConfig = {}): Promise => {
const localVarPath = `/api/organizations/users`;
// 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,
};
},
/**
*
* @summary Deletes a user from organization
* @param {string} userId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
apiOrganizationsUsersUserIdDelete: async (userId: string, options: AxiosRequestConfig = {}): Promise => {
// verify required parameter 'userId' is not null or undefined
if (userId === null || userId === undefined) {
throw new RequiredError('userId','Required parameter userId was null or undefined when calling apiOrganizationsUsersUserIdDelete.');
}
const localVarPath = `/api/organizations/users/{userId}`
.replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
// 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,
};
},
}
};
/**
* OrganizationsApi - functional programming interface
* @export
*/
export const OrganizationsApiFp = function(configuration?: Configuration) {
return {
/**
*
* @summary List organization users
* @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 apiOrganizationsUsersGet(Q?: string, limit?: number, offset?: number, order?: PaginationOrders, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>> {
const localVarAxiosArgs = await OrganizationsApiAxiosParamCreator(configuration).apiOrganizationsUsersGet(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 Adds a user to the organization
* @param {OrganizationsOrganizationUserPostRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async apiOrganizationsUsersPost(body?: OrganizationsOrganizationUserPostRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>> {
const localVarAxiosArgs = await OrganizationsApiAxiosParamCreator(configuration).apiOrganizationsUsersPost(body, 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 user from organization
* @param {string} userId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async apiOrganizationsUsersUserIdDelete(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>> {
const localVarAxiosArgs = await OrganizationsApiAxiosParamCreator(configuration).apiOrganizationsUsersUserIdDelete(userId, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
}
};
/**
* OrganizationsApi - factory interface
* @export
*/
export const OrganizationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
return {
/**
*
* @summary List organization users
* @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 apiOrganizationsUsersGet(Q?: string, limit?: number, offset?: number, order?: PaginationOrders, options?: AxiosRequestConfig): Promise> {
return OrganizationsApiFp(configuration).apiOrganizationsUsersGet(Q, limit, offset, order, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Adds a user to the organization
* @param {OrganizationsOrganizationUserPostRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async apiOrganizationsUsersPost(body?: OrganizationsOrganizationUserPostRequest, options?: AxiosRequestConfig): Promise> {
return OrganizationsApiFp(configuration).apiOrganizationsUsersPost(body, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Deletes a user from organization
* @param {string} userId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async apiOrganizationsUsersUserIdDelete(userId: string, options?: AxiosRequestConfig): Promise> {
return OrganizationsApiFp(configuration).apiOrganizationsUsersUserIdDelete(userId, options).then((request) => request(axios, basePath));
},
};
};
/**
* OrganizationsApi - object-oriented interface
* @export
* @class OrganizationsApi
* @extends {BaseAPI}
*/
export class OrganizationsApi extends BaseAPI {
/**
*
* @summary List organization users
* @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 OrganizationsApi
*/
public async apiOrganizationsUsersGet(Q?: string, limit?: number, offset?: number, order?: PaginationOrders, options?: AxiosRequestConfig) : Promise> {
return OrganizationsApiFp(this.configuration).apiOrganizationsUsersGet(Q, limit, offset, order, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Adds a user to the organization
* @param {OrganizationsOrganizationUserPostRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof OrganizationsApi
*/
public async apiOrganizationsUsersPost(body?: OrganizationsOrganizationUserPostRequest, options?: AxiosRequestConfig) : Promise> {
return OrganizationsApiFp(this.configuration).apiOrganizationsUsersPost(body, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Deletes a user from organization
* @param {string} userId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof OrganizationsApi
*/
public async apiOrganizationsUsersUserIdDelete(userId: string, options?: AxiosRequestConfig) : Promise> {
return OrganizationsApiFp(this.configuration).apiOrganizationsUsersUserIdDelete(userId, options).then((request) => request(this.axios, this.basePath));
}
}