ru.redcom.lib.integration.api.client.dadata

Interface DaDataClient

public interface DaDataClient

DaData API Client interface.

Method Summary

Modifier and Type	Method and Description
boolean	checkAvailability(boolean silent) Contact the API status endpoint to check availability.
Address	cleanAddress(java.lang.String source) Clean a single address.
Address[]	cleanAddresses(java.lang.String... sources) Clean multiple addresses at once.
BirthDate	cleanBirthDate(java.lang.String source) Clean a single birth date.
BirthDate[]	cleanBirthDates(java.lang.String... sources) Clean multiple birth dates at once.
CompositeResponse	cleanComposite(CompositeRequest source) Clean a collection of records consisting by various information types.
Email	cleanEmail(java.lang.String source) Clean a single E-mail address.
Email[]	cleanEmails(java.lang.String... sources) Clean multiple E-mail addresses at once.
Name	cleanName(java.lang.String source) Clean a single name.
Name[]	cleanNames(java.lang.String... sources) Clean multiple names at once.
Passport	cleanPassport(java.lang.String source) Clean a single passport number.
Passport[]	cleanPassports(java.lang.String... sources) Clean multiple passport numbers at once.
Phone	cleanPhone(java.lang.String source) Clean a single phone number.
Phone[]	cleanPhones(java.lang.String... sources) Clean multiple phone numbers at once.
Vehicle	cleanVehicle(java.lang.String source) Clean a single vehicle model.
Vehicle[]	cleanVehicles(java.lang.String... sources) Clean multiple vehicle models at once.
java.math.BigDecimal	getProfileBalance() Retrieve current account profile balance.

Method Detail

checkAvailability

boolean checkAvailability(boolean silent)
                   throws DaDataException

Contact the API status endpoint to check availability. Uses only API key to identify the account. Does not validate Secret key.

Parameters:

silent - Silent mode. Do not throws exceptions if set to true.

Returns:

true if API is available, false otherwise.

Throws:

DaDataException - On errors, if not suppressed by the silent mode

getProfileBalance

@NonNull
java.math.BigDecimal getProfileBalance()
                                          throws DaDataException

Retrieve current account profile balance.

Returns:

Balance amount (currently in RUR only)

Throws:

DaDataException - On API access errors

cleanAddress

@NonNull
Address cleanAddress(@NonNull
                               java.lang.String source)
                        throws DaDataException

Clean a single address.

Parameters:

source - Source address

Returns:

Cleaned address object

Throws:

DaDataException - On various API errors

cleanAddresses

@NonNull
Address[] cleanAddresses(@NonNull
                                   java.lang.String... sources)
                            throws DaDataException

Clean multiple addresses at once.

Parameters:

sources - Source address strings array

Returns:

Cleaned address objects

Throws:

DaDataException - On various API errors

cleanPhone

@NonNull
Phone cleanPhone(@NonNull
                           java.lang.String source)
                    throws DaDataException

Clean a single phone number.

Parameters:

source - Source phone number

Returns:

Cleaned phone object

Throws:

DaDataException - On various API errors

cleanPhones

@NonNull
Phone[] cleanPhones(@NonNull
                              java.lang.String... sources)
                       throws DaDataException

Clean multiple phone numbers at once.

Parameters:

sources - Source phone number strings array

Returns:

Cleaned phone objects

Throws:

DaDataException - On various API errors

cleanPassport

@NonNull
Passport cleanPassport(@NonNull
                                 java.lang.String source)
                          throws DaDataException

Clean a single passport number.

Parameters:

source - Source passport number

Returns:

Cleaned passport object

Throws:

DaDataException - On various API errors

cleanPassports

@NonNull
Passport[] cleanPassports(@NonNull
                                    java.lang.String... sources)
                             throws DaDataException

Clean multiple passport numbers at once.

Parameters:

sources - Source passport number strings array

Returns:

Cleaned passport objects

Throws:

DaDataException - On various API errors

cleanName

@NonNull
Name cleanName(@NonNull
                         java.lang.String source)
                  throws DaDataException

Clean a single name.

Parameters:

source - Source name

Returns:

Cleaned name object

Throws:

DaDataException - On various API errors

cleanNames

@NonNull
Name[] cleanNames(@NonNull
                            java.lang.String... sources)
                     throws DaDataException

Clean multiple names at once.

Parameters:

sources - Source name strings array

Returns:

Cleaned name objects

Throws:

DaDataException - On various API errors

cleanEmail

@NonNull
Email cleanEmail(@NonNull
                           java.lang.String source)
                    throws DaDataException

Clean a single E-mail address.

Parameters:

source - Source E-mail address

Returns:

Cleaned E-mail address object

Throws:

DaDataException - On various API errors

cleanEmails

@NonNull
Email[] cleanEmails(@NonNull
                              java.lang.String... sources)
                       throws DaDataException

Clean multiple E-mail addresses at once.

Parameters:

sources - Source E-mail address strings array

Returns:

Cleaned E-mail address objects

Throws:

DaDataException - On various API errors

cleanBirthDate

@NonNull
BirthDate cleanBirthDate(@NonNull
                                   java.lang.String source)
                            throws DaDataException

Clean a single birth date.

Parameters:

source - Source birth date string

Returns:

Cleaned birth date object

Throws:

DaDataException - On various API errors

cleanBirthDates

@NonNull
BirthDate[] cleanBirthDates(@NonNull
                                      java.lang.String... sources)
                               throws DaDataException

Clean multiple birth dates at once.

Parameters:

sources - Source birth date strings array

Returns:

Cleaned birth date objects

Throws:

DaDataException - On various API errors

cleanVehicle

@NonNull
Vehicle cleanVehicle(@NonNull
                               java.lang.String source)
                        throws DaDataException

Clean a single vehicle model.

Parameters:

source - Source vehicle model name string

Returns:

Cleaned vehicle object

Throws:

DaDataException - On various API errors

cleanVehicles

@NonNull
Vehicle[] cleanVehicles(@NonNull
                                  java.lang.String... sources)
                           throws DaDataException

Clean multiple vehicle models at once.

Parameters:

sources - Source vehicle model strings array

Returns:

Cleaned vehicle objects

Throws:

DaDataException - On various API errors

cleanComposite

@NonNull
CompositeResponse cleanComposite(@NonNull
                                           CompositeRequest source)
                                    throws DaDataException

Clean a collection of records consisting by various information types.

Parameters:

source - Source composite request object

Returns:

Composite response object with cleaned records

Throws:

DaDataException - On various API errors