All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.confidentify.client.api.ProcessApi Maven / Gradle / Ivy

There is a newer version: 1.5.0
Show newest version
/*
 * Confidentify API
 * Services that let you build confidence and identify matches in customer data. ## Features overview * Contact data processing services (tagged with `process`) which offer   validation and enrichment backed by inference and knowledge on complex   data types such as names, email addresses, phone numbers.  * Data matching and searching services (tagged with `matching`) that    allow you to identify duplicated data or matches against third party   contact data list.  * Dataset management services (tagged with `dataset`) that allow record storage and retrieval. ## Integrator notes: * Use the `/auth` endpoint to get an access token. Access tokens are temporary, so design the client the be capable of renewing it. * The APIs are rate-limited, so design the client to be capable of retrying with some delay upon HTTP 429 responses. 
 *
 * The version of the OpenAPI document: 1.1.0
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


package com.confidentify.client.api;

import com.confidentify.client.ApiCallback;
import com.confidentify.client.ApiClient;
import com.confidentify.client.ApiException;
import com.confidentify.client.ApiResponse;
import com.confidentify.client.Configuration;
import com.confidentify.client.Pair;
import com.confidentify.client.ProgressRequestBody;
import com.confidentify.client.ProgressResponseBody;

import com.google.gson.reflect.TypeToken;

import java.io.IOException;


import com.confidentify.client.model.EmailRequest;
import com.confidentify.client.model.EmailResponse;
import com.confidentify.client.model.IdentifyRequest;
import com.confidentify.client.model.IdentifyResponse;
import com.confidentify.client.model.OrganizationNameRequest;
import com.confidentify.client.model.OrganizationNameResponse;
import com.confidentify.client.model.PersonNameRequest;
import com.confidentify.client.model.PersonNameResponse;
import com.confidentify.client.model.PhoneRequest;
import com.confidentify.client.model.PhoneResponse;

import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class ProcessApi {
    private ApiClient localVarApiClient;

    public ProcessApi() {
        this(Configuration.getDefaultApiClient());
    }

    public ProcessApi(ApiClient apiClient) {
        this.localVarApiClient = apiClient;
    }

    public ApiClient getApiClient() {
        return localVarApiClient;
    }

    public void setApiClient(ApiClient apiClient) {
        this.localVarApiClient = apiClient;
    }

    /**
     * Build call for emailPost
     * @param emailRequest  (required)
     * @param _callback Callback for upload/download progress
     * @return Call to execute
     * @throws ApiException If fail to serialize the request body object
     * @http.response.details
     
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public okhttp3.Call emailPostCall(EmailRequest emailRequest, final ApiCallback _callback) throws ApiException { Object localVarPostBody = emailRequest; // create path and map variables String localVarPath = "/email"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "application/json" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "bearerAuth", "oAuth2ClientCredentials" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call emailPostValidateBeforeCall(EmailRequest emailRequest, final ApiCallback _callback) throws ApiException { // verify the required parameter 'emailRequest' is set if (emailRequest == null) { throw new ApiException("Missing the required parameter 'emailRequest' when calling emailPost(Async)"); } okhttp3.Call localVarCall = emailPostCall(emailRequest, _callback); return localVarCall; } /** * Process email addresses * Processes email addresses. Use the service to increase deliverability. Features of the service include: * Validates syntax and parses emails into discrete parts. * Corrects common misspellings and obfuscations made to make email addresses non-discoverable online. * Identifies disposable email addresses. * Identifies generic/non-personal email addresses. * @param emailRequest (required) * @return EmailResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public EmailResponse emailPost(EmailRequest emailRequest) throws ApiException { ApiResponse localVarResp = emailPostWithHttpInfo(emailRequest); return localVarResp.getData(); } /** * Process email addresses * Processes email addresses. Use the service to increase deliverability. Features of the service include: * Validates syntax and parses emails into discrete parts. * Corrects common misspellings and obfuscations made to make email addresses non-discoverable online. * Identifies disposable email addresses. * Identifies generic/non-personal email addresses. * @param emailRequest (required) * @return ApiResponse<EmailResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public ApiResponse emailPostWithHttpInfo(EmailRequest emailRequest) throws ApiException { okhttp3.Call localVarCall = emailPostValidateBeforeCall(emailRequest, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Process email addresses (asynchronously) * Processes email addresses. Use the service to increase deliverability. Features of the service include: * Validates syntax and parses emails into discrete parts. * Corrects common misspellings and obfuscations made to make email addresses non-discoverable online. * Identifies disposable email addresses. * Identifies generic/non-personal email addresses. * @param emailRequest (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public okhttp3.Call emailPostAsync(EmailRequest emailRequest, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = emailPostValidateBeforeCall(emailRequest, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for identifyPost * @param identifyRequest (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public okhttp3.Call identifyPostCall(IdentifyRequest identifyRequest, final ApiCallback _callback) throws ApiException { Object localVarPostBody = identifyRequest; // create path and map variables String localVarPath = "/identify"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "application/json" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "bearerAuth", "oAuth2ClientCredentials" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call identifyPostValidateBeforeCall(IdentifyRequest identifyRequest, final ApiCallback _callback) throws ApiException { // verify the required parameter 'identifyRequest' is set if (identifyRequest == null) { throw new ApiException("Missing the required parameter 'identifyRequest' when calling identifyPost(Async)"); } okhttp3.Call localVarCall = identifyPostCall(identifyRequest, _callback); return localVarCall; } /** * Process text to identify contact data. * Analyzes unstructured text in order to identify contact data embedded within signatures, sentences, greetings. Features of the service include: * Resolve person names. * Resolve organization names. * @param identifyRequest (required) * @return IdentifyResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public IdentifyResponse identifyPost(IdentifyRequest identifyRequest) throws ApiException { ApiResponse localVarResp = identifyPostWithHttpInfo(identifyRequest); return localVarResp.getData(); } /** * Process text to identify contact data. * Analyzes unstructured text in order to identify contact data embedded within signatures, sentences, greetings. Features of the service include: * Resolve person names. * Resolve organization names. * @param identifyRequest (required) * @return ApiResponse<IdentifyResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public ApiResponse identifyPostWithHttpInfo(IdentifyRequest identifyRequest) throws ApiException { okhttp3.Call localVarCall = identifyPostValidateBeforeCall(identifyRequest, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Process text to identify contact data. (asynchronously) * Analyzes unstructured text in order to identify contact data embedded within signatures, sentences, greetings. Features of the service include: * Resolve person names. * Resolve organization names. * @param identifyRequest (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public okhttp3.Call identifyPostAsync(IdentifyRequest identifyRequest, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = identifyPostValidateBeforeCall(identifyRequest, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for organizationNamePost * @param organizationNameRequest (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public okhttp3.Call organizationNamePostCall(OrganizationNameRequest organizationNameRequest, final ApiCallback _callback) throws ApiException { Object localVarPostBody = organizationNameRequest; // create path and map variables String localVarPath = "/organization_name"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "application/json" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "bearerAuth", "oAuth2ClientCredentials" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call organizationNamePostValidateBeforeCall(OrganizationNameRequest organizationNameRequest, final ApiCallback _callback) throws ApiException { // verify the required parameter 'organizationNameRequest' is set if (organizationNameRequest == null) { throw new ApiException("Missing the required parameter 'organizationNameRequest' when calling organizationNamePost(Async)"); } okhttp3.Call localVarCall = organizationNamePostCall(organizationNameRequest, _callback); return localVarCall; } /** * Process organization names * Processes organization names and provides understanding and correction to how the entity is addressed. Features of the service include: * Identification of company legal types such as 'Corp', 'Ltd' and 'GmbH' * @param organizationNameRequest (required) * @return OrganizationNameResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public OrganizationNameResponse organizationNamePost(OrganizationNameRequest organizationNameRequest) throws ApiException { ApiResponse localVarResp = organizationNamePostWithHttpInfo(organizationNameRequest); return localVarResp.getData(); } /** * Process organization names * Processes organization names and provides understanding and correction to how the entity is addressed. Features of the service include: * Identification of company legal types such as 'Corp', 'Ltd' and 'GmbH' * @param organizationNameRequest (required) * @return ApiResponse<OrganizationNameResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public ApiResponse organizationNamePostWithHttpInfo(OrganizationNameRequest organizationNameRequest) throws ApiException { okhttp3.Call localVarCall = organizationNamePostValidateBeforeCall(organizationNameRequest, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Process organization names (asynchronously) * Processes organization names and provides understanding and correction to how the entity is addressed. Features of the service include: * Identification of company legal types such as 'Corp', 'Ltd' and 'GmbH' * @param organizationNameRequest (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public okhttp3.Call organizationNamePostAsync(OrganizationNameRequest organizationNameRequest, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = organizationNamePostValidateBeforeCall(organizationNameRequest, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for personNamePost * @param personNameRequest (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public okhttp3.Call personNamePostCall(PersonNameRequest personNameRequest, final ApiCallback _callback) throws ApiException { Object localVarPostBody = personNameRequest; // create path and map variables String localVarPath = "/person_name"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "application/json" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "bearerAuth", "oAuth2ClientCredentials" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call personNamePostValidateBeforeCall(PersonNameRequest personNameRequest, final ApiCallback _callback) throws ApiException { // verify the required parameter 'personNameRequest' is set if (personNameRequest == null) { throw new ApiException("Missing the required parameter 'personNameRequest' when calling personNamePost(Async)"); } okhttp3.Call localVarCall = personNamePostCall(personNameRequest, _callback); return localVarCall; } /** * Process person names * Processes person names and provides understanding and correction to how people are addressed. Features of the service include: * Parsing into discrete name parts like given name, middle name, family name etc. * Removal of non-name elements like salutations or titles. * Capitalization of name parts. * Identification and suggestion of possible nicknames. * @param personNameRequest (required) * @return PersonNameResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public PersonNameResponse personNamePost(PersonNameRequest personNameRequest) throws ApiException { ApiResponse localVarResp = personNamePostWithHttpInfo(personNameRequest); return localVarResp.getData(); } /** * Process person names * Processes person names and provides understanding and correction to how people are addressed. Features of the service include: * Parsing into discrete name parts like given name, middle name, family name etc. * Removal of non-name elements like salutations or titles. * Capitalization of name parts. * Identification and suggestion of possible nicknames. * @param personNameRequest (required) * @return ApiResponse<PersonNameResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public ApiResponse personNamePostWithHttpInfo(PersonNameRequest personNameRequest) throws ApiException { okhttp3.Call localVarCall = personNamePostValidateBeforeCall(personNameRequest, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Process person names (asynchronously) * Processes person names and provides understanding and correction to how people are addressed. Features of the service include: * Parsing into discrete name parts like given name, middle name, family name etc. * Removal of non-name elements like salutations or titles. * Capitalization of name parts. * Identification and suggestion of possible nicknames. * @param personNameRequest (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public okhttp3.Call personNamePostAsync(PersonNameRequest personNameRequest, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = personNamePostValidateBeforeCall(personNameRequest, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for phonePost * @param phoneRequest (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public okhttp3.Call phonePostCall(PhoneRequest phoneRequest, final ApiCallback _callback) throws ApiException { Object localVarPostBody = phoneRequest; // create path and map variables String localVarPath = "/phone"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { "application/json" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { localVarHeaderParams.put("Accept", localVarAccept); } final String[] localVarContentTypes = { "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "bearerAuth", "oAuth2ClientCredentials" }; return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") private okhttp3.Call phonePostValidateBeforeCall(PhoneRequest phoneRequest, final ApiCallback _callback) throws ApiException { // verify the required parameter 'phoneRequest' is set if (phoneRequest == null) { throw new ApiException("Missing the required parameter 'phoneRequest' when calling phonePost(Async)"); } okhttp3.Call localVarCall = phonePostCall(phoneRequest, _callback); return localVarCall; } /** * Process phone numbers * Processes phone number. Use the service to increase callability. Features of the service include: * Validates syntax and provides uniform formatting of phone numbers to increase understandability. * Parses phone numbers internationally, with support for vanity numbers, extension numbers and more. * Uses phone number ranges from International Telecommunications Union (ITU) to validate whether a phone number is possible or not. * @param phoneRequest (required) * @return PhoneResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public PhoneResponse phonePost(PhoneRequest phoneRequest) throws ApiException { ApiResponse localVarResp = phonePostWithHttpInfo(phoneRequest); return localVarResp.getData(); } /** * Process phone numbers * Processes phone number. Use the service to increase callability. Features of the service include: * Validates syntax and provides uniform formatting of phone numbers to increase understandability. * Parses phone numbers internationally, with support for vanity numbers, extension numbers and more. * Uses phone number ranges from International Telecommunications Union (ITU) to validate whether a phone number is possible or not. * @param phoneRequest (required) * @return ApiResponse<PhoneResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public ApiResponse phonePostWithHttpInfo(PhoneRequest phoneRequest) throws ApiException { okhttp3.Call localVarCall = phonePostValidateBeforeCall(phoneRequest, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Process phone numbers (asynchronously) * Processes phone number. Use the service to increase callability. Features of the service include: * Validates syntax and provides uniform formatting of phone numbers to increase understandability. * Parses phone numbers internationally, with support for vanity numbers, extension numbers and more. * Uses phone number ranges from International Telecommunications Union (ITU) to validate whether a phone number is possible or not. * @param phoneRequest (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details
Status Code Description Response Headers
200 Success -
400 Bad request -
*/ public okhttp3.Call phonePostAsync(PhoneRequest phoneRequest, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = phonePostValidateBeforeCall(phoneRequest, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy