regen16

build.gradle

@@ -2,7 +2,7 @@ apply plugin: 'idea'
 apply plugin: 'eclipse'
 
 group = 'com.namsor'
-version = '2.0.15'
+version = '2.0.16'
 
 buildscript {
     repositories {

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "com.namsor",
     name := "namsor-sdk2",
-    version := "2.0.15",
+    version := "2.0.16",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/AdminApi.md

@@ -4,21 +4,23 @@ All URIs are relative to *https://v2.namsor.com/NamSorAPIv2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**anonymize**](AdminApi.md#anonymize) | **GET** /api2/json/anonymize/{source}/{anonymized} | Activate/deactivate anonymization for a source.
+[**anonymize**](AdminApi.md#anonymize) | **GET** /api2/json/anonymize/{source}/{anonymized}/{token} | Activate/deactivate anonymization for a source.
+[**anonymize1**](AdminApi.md#anonymize1) | **GET** /api2/json/anonymize/{source}/{anonymized} | Activate/deactivate anonymization for a source.
 [**apiStatus**](AdminApi.md#apiStatus) | **GET** /api2/json/apiStatus | Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices.
 [**apiUsage**](AdminApi.md#apiUsage) | **GET** /api2/json/apiUsage | Print current API usage.
 [**apiUsageHistory**](AdminApi.md#apiUsageHistory) | **GET** /api2/json/apiUsageHistory | Print historical API usage.
 [**apiUsageHistoryAggregate**](AdminApi.md#apiUsageHistoryAggregate) | **GET** /api2/json/apiUsageHistoryAggregate | Print historical API usage (in an aggregated view, by service, by day/hour/min).
 [**availableServices**](AdminApi.md#availableServices) | **GET** /api2/json/apiServices | List of classification services and usage cost in Units per classification (default is 1=ONE Unit). Some API endpoints (ex. Corridor) combine multiple classifiers.
 [**disable**](AdminApi.md#disable) | **GET** /api2/json/disable/{source}/{disabled} | Activate/deactivate an API Key.
 [**learnable**](AdminApi.md#learnable) | **GET** /api2/json/learnable/{source}/{learnable} | Activate/deactivate learning from a source.
+[**learnable1**](AdminApi.md#learnable1) | **GET** /api2/json/learnable/{source}/{learnable}/{token} | Activate/deactivate learning from a source.
 [**softwareVersion**](AdminApi.md#softwareVersion) | **GET** /api2/json/softwareVersion | Get the current software version
 [**taxonomyClasses**](AdminApi.md#taxonomyClasses) | **GET** /api2/json/taxonomyClasses/{classifierName} | Print the taxonomy classes valid for the given classifier.
 
 
 <a name="anonymize"></a>
 # **anonymize**
-> anonymize(source, anonymized)
+> anonymize(source, anonymized, token)
 
 Activate/deactivate anonymization for a source.
 
@@ -42,8 +44,9 @@ api_key.setApiKey("YOUR API KEY");
 AdminApi apiInstance = new AdminApi();
 String source = "source_example"; // String | 
 Boolean anonymized = true; // Boolean | 
+String token = "token_example"; // String | 
 try {
-    apiInstance.anonymize(source, anonymized);
+    apiInstance.anonymize(source, anonymized, token);
 } catch (ApiException e) {
     System.err.println("Exception when calling AdminApi#anonymize");
     e.printStackTrace();
@@ -52,6 +55,61 @@ try {
 
 ### Parameters
 
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source** | **String**|  |
+ **anonymized** | **Boolean**|  |
+ **token** | **String**|  |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+<a name="anonymize1"></a>
+# **anonymize1**
+> anonymize1(source, anonymized)
+
+Activate/deactivate anonymization for a source.
+
+### Example
+```java
+// Import classes:
+//import com.namsor.sdk2.invoke.ApiClient;
+//import com.namsor.sdk2.invoke.ApiException;
+//import com.namsor.sdk2.invoke.Configuration;
+//import com.namsor.sdk2.invoke.auth.*;
+//import com.namsor.sdk2.api.AdminApi;
+
+ApiClient defaultClient = Configuration.getDefaultApiClient();
+
+// Configure API key authorization: api_key
+ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
+api_key.setApiKey("YOUR API KEY");
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//api_key.setApiKeyPrefix("Token");
+
+AdminApi apiInstance = new AdminApi();
+String source = "source_example"; // String | 
+Boolean anonymized = true; // Boolean | 
+try {
+    apiInstance.anonymize1(source, anonymized);
+} catch (ApiException e) {
+    System.err.println("Exception when calling AdminApi#anonymize1");
+    e.printStackTrace();
+}
+```
+
+### Parameters
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **source** | **String**|  |
@@ -418,6 +476,62 @@ null (empty response body)
 
 [api_key](../README.md#api_key)
 
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+<a name="learnable1"></a>
+# **learnable1**
+> learnable1(source, learnable, token)
+
+Activate/deactivate learning from a source.
+
+### Example
+```java
+// Import classes:
+//import com.namsor.sdk2.invoke.ApiClient;
+//import com.namsor.sdk2.invoke.ApiException;
+//import com.namsor.sdk2.invoke.Configuration;
+//import com.namsor.sdk2.invoke.auth.*;
+//import com.namsor.sdk2.api.AdminApi;
+
+ApiClient defaultClient = Configuration.getDefaultApiClient();
+
+// Configure API key authorization: api_key
+ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
+api_key.setApiKey("YOUR API KEY");
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//api_key.setApiKeyPrefix("Token");
+
+AdminApi apiInstance = new AdminApi();
+String source = "source_example"; // String | The API Key to set as learnable/non learnable.
+Boolean learnable = true; // Boolean | 
+String token = "token_example"; // String | 
+try {
+    apiInstance.learnable1(source, learnable, token);
+} catch (ApiException e) {
+    System.err.println("Exception when calling AdminApi#learnable1");
+    e.printStackTrace();
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source** | **String**| The API Key to set as learnable/non learnable. |
+ **learnable** | **Boolean**|  |
+ **token** | **String**|  |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
 ### HTTP request headers
 
  - **Content-Type**: Not defined

docs/BatchFirstLastNameGeoSubclassificationOut.md

@@ -0,0 +1,10 @@
+
+# BatchFirstLastNameGeoSubclassificationOut
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**personalNames** | [**List<FirstLastNameGeoSubclassificationOut>**](FirstLastNameGeoSubclassificationOut.md) | Classified names at sub country level (region or state) |  [optional]
+
+
+

docs/FirstLastNameDiasporaedOut.md

@@ -14,6 +14,8 @@ Name | Type | Description | Notes
 **lifted** | **Boolean** | Indicates if the output ethnicity is based on machine learning only, or further lifted as a known fact by a country-specific rule. Let us know if you believe ethnicity is incorrect on a specific case where lifted is true. |  [optional]
 **countryIso2** | **String** | From input data, the countryIso2 of geographic context (US,CA etc.) |  [optional]
 **ethnicitiesTop** | **List<String>** | List most likely ethnicities (top 10) |  [optional]
+**probabilityCalibrated** | **Double** | The calibrated probability for ethnicity to have been guessed correctly. -1 = still calibrating.  |  [optional]
+**probabilityAltCalibrated** | **Double** | The calibrated probability for ethnicity OR ethnicityAlt to have been guessed correctly. -1 = still calibrating.  |  [optional]
 
 
 

docs/FirstLastNameGenderedOut.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 **firstName** | **String** | The first name (also known as given name) |  [optional]
 **lastName** | **String** | The last name (also known as family name, or surname) |  [optional]
 **likelyGender** | [**LikelyGenderEnum**](#LikelyGenderEnum) | Most likely gender |  [optional]
-**genderScale** | **Double** | Compatibility to NamSor_v1 Gender Scale M[-1..U..+1]F value |  [optional]
+**genderScale** | **Double** | Compatibility to NamSor_v1 Gender Scale M[-1..U..+1]F value. |  [optional]
 **score** | **Double** | Compatibility to NamSor_v1 Gender score value. Higher score is better, but score is not normalized. Use calibratedProbability if available.  |  [optional]
-**probabilityCalibrated** | **Double** | The calibrated probability for inferred gender to have been guessed correctly. |  [optional]
+**probabilityCalibrated** | **Double** | The calibrated probability for inferred gender to have been guessed correctly. -1 = still calibrating.  |  [optional]
 
 
 <a name="LikelyGenderEnum"></a>

docs/FirstLastNameGeoSubclassificationOut.md

@@ -0,0 +1,20 @@
+
+# FirstLastNameGeoSubclassificationOut
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**script** | **String** |  |  [optional]
+**id** | **String** |  |  [optional]
+**firstName** | **String** | The first name (also known as given name) |  [optional]
+**lastName** | **String** | The last name (also known as family name, or surname) |  [optional]
+**countryIso2** | **String** | The input country ISO2 code |  [optional]
+**subClassification** | **String** | Most likely subclassification ISO_3166-2 code |  [optional]
+**subClassificationAlt** | **String** | Second best alternative : subclassification ISO_3166-2 code |  [optional]
+**subclassificationTop** | **List<String>** | List subclassification ISO_3166-2 codes (top 10) |  [optional]
+**score** | **Double** | Compatibility to NamSor_v1 Origin score value. Higher score is better, but score is not normalized. Use calibratedProbability if available.  |  [optional]
+**probabilityCalibrated** | **Double** | The calibrated probability for subclassification to have been guessed correctly. -1 = still calibrating.  |  [optional]
+**probabilityAltCalibrated** | **Double** | The calibrated probability for subclassification OR subclassificationAlt to have been guessed correctly. -1 = still calibrating.  |  [optional]
+
+
+

docs/FirstLastNameOriginedOut.md

@@ -15,8 +15,8 @@ Name | Type | Description | Notes
 **regionOrigin** | **String** | Most likely region of Origin (based on countryOrigin ISO2 code) |  [optional]
 **topRegionOrigin** | **String** | Most likely top region of Origin (based on countryOrigin ISO2 code) |  [optional]
 **subRegionOrigin** | **String** | Most likely sub region of Origin (based on countryOrigin ISO2 code) |  [optional]
-**probabilityCalibrated** | **Double** | The calibrated probability for countryOrigin to have been guessed correctly. |  [optional]
-**probabilityAltCalibrated** | **Double** | The calibrated probability for countryOrigin OR countryOriginAlt to have been guessed correctly. |  [optional]
+**probabilityCalibrated** | **Double** | The calibrated probability for countryOrigin to have been guessed correctly. -1 = still calibrating.  |  [optional]
+**probabilityAltCalibrated** | **Double** | The calibrated probability for countryOrigin OR countryOriginAlt to have been guessed correctly. -1 = still calibrating.  |  [optional]
 
 
 

docs/FirstLastNamePhoneNumberGeoIn.md

@@ -8,7 +8,6 @@ Name | Type | Description | Notes
 **firstName** | **String** |  |  [optional]
 **lastName** | **String** |  |  [optional]
 **phoneNumber** | **String** |  |  [optional]
-**firstLastNameOriginedOut** | [**FirstLastNameOriginedOut**](FirstLastNameOriginedOut.md) |  |  [optional]
 **countryIso2** | **String** |  |  [optional]
 **countryIso2Alt** | **String** |  |  [optional]
 

docs/FirstLastNamePhoneNumberIn.md

@@ -8,7 +8,6 @@ Name | Type | Description | Notes
 **firstName** | **String** |  |  [optional]
 **lastName** | **String** |  |  [optional]
 **phoneNumber** | **String** |  |  [optional]
-**firstLastNameOriginedOut** | [**FirstLastNameOriginedOut**](FirstLastNameOriginedOut.md) |  |  [optional]
 
 
 

docs/FirstLastNameUSRaceEthnicityOut.md

@@ -12,8 +12,8 @@ Name | Type | Description | Notes
 **raceEthnicity** | [**RaceEthnicityEnum**](#RaceEthnicityEnum) | Most likely US 'race'/ethnicity |  [optional]
 **score** | **Double** | Higher score is better, but score is not normalized. Use calibratedProbability if available.  |  [optional]
 **raceEthnicitiesTop** | **List<String>** | List 'race'/ethnicities |  [optional]
-**probabilityCalibrated** | **Double** | The calibrated probability for raceEthnicity to have been guessed correctly. |  [optional]
-**probabilityAltCalibrated** | **Double** | The calibrated probability for raceEthnicity OR raceEthnicityAlt to have been guessed correctly. |  [optional]
+**probabilityCalibrated** | **Double** | The calibrated probability for raceEthnicity to have been guessed correctly. -1 = still calibrating.  |  [optional]
+**probabilityAltCalibrated** | **Double** | The calibrated probability for raceEthnicity OR raceEthnicityAlt to have been guessed correctly. -1 = still calibrating.  |  [optional]
 
 
 <a name="RaceEthnicityAltEnum"></a>

docs/JapaneseApi.md

@@ -9,8 +9,8 @@ Method | HTTP request | Description
 [**genderJapaneseNamePinyin**](JapaneseApi.md#genderJapaneseNamePinyin) | **GET** /api2/json/genderJapaneseName/{japaneseSurname}/{japaneseGivenName} | Infer the likely gender of a Japanese name in LATIN (Pinyin).
 [**genderJapaneseNamePinyinBatch**](JapaneseApi.md#genderJapaneseNamePinyinBatch) | **POST** /api2/json/genderJapaneseNameBatch | Infer the likely gender of up to 100 Japanese names in LATIN (Pinyin).
 [**japaneseNameGenderKanjiCandidatesBatch**](JapaneseApi.md#japaneseNameGenderKanjiCandidatesBatch) | **POST** /api2/json/japaneseNameGenderKanjiCandidatesBatch | Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname) with KNOWN gender, ex. Yamamoto Sanae
-[**japaneseNameKanjiCandidates**](JapaneseApi.md#japaneseNameKanjiCandidates) | **GET** /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{knownGender} | Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae - and a known gender.
-[**japaneseNameKanjiCandidates1**](JapaneseApi.md#japaneseNameKanjiCandidates1) | **GET** /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin} | Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae
+[**japaneseNameKanjiCandidates**](JapaneseApi.md#japaneseNameKanjiCandidates) | **GET** /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin} | Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae
+[**japaneseNameKanjiCandidates1**](JapaneseApi.md#japaneseNameKanjiCandidates1) | **GET** /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{knownGender} | Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae - and a known gender.
 [**japaneseNameKanjiCandidatesBatch**](JapaneseApi.md#japaneseNameKanjiCandidatesBatch) | **POST** /api2/json/japaneseNameKanjiCandidatesBatch | Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname), ex. Yamamoto Sanae
 [**japaneseNameLatinCandidates**](JapaneseApi.md#japaneseNameLatinCandidates) | **GET** /api2/json/japaneseNameLatinCandidates/{japaneseSurnameKanji}/{japaneseGivenNameKanji} | Romanize japanese name, based on the name in Kanji.
 [**japaneseNameLatinCandidatesBatch**](JapaneseApi.md#japaneseNameLatinCandidatesBatch) | **POST** /api2/json/japaneseNameLatinCandidatesBatch | Romanize japanese names, based on the name in KANJI
@@ -290,9 +290,9 @@ Name | Type | Description  | Notes
 
 <a name="japaneseNameKanjiCandidates"></a>
 # **japaneseNameKanjiCandidates**
-> NameMatchCandidatesOut japaneseNameKanjiCandidates(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender)
+> NameMatchCandidatesOut japaneseNameKanjiCandidates(japaneseSurnameLatin, japaneseGivenNameLatin)
 
-Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae - and a known gender.
+Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae
 
 ### Example
 ```java
@@ -314,9 +314,8 @@ api_key.setApiKey("YOUR API KEY");
 JapaneseApi apiInstance = new JapaneseApi();
 String japaneseSurnameLatin = "japaneseSurnameLatin_example"; // String | 
 String japaneseGivenNameLatin = "japaneseGivenNameLatin_example"; // String | 
-String knownGender = "knownGender_example"; // String | 
 try {
-    NameMatchCandidatesOut result = apiInstance.japaneseNameKanjiCandidates(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender);
+    NameMatchCandidatesOut result = apiInstance.japaneseNameKanjiCandidates(japaneseSurnameLatin, japaneseGivenNameLatin);
     System.out.println(result);
 } catch (ApiException e) {
     System.err.println("Exception when calling JapaneseApi#japaneseNameKanjiCandidates");
@@ -330,7 +329,6 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **japaneseSurnameLatin** | **String**|  |
  **japaneseGivenNameLatin** | **String**|  |
- **knownGender** | **String**|  |
 
 ### Return type
 
@@ -347,9 +345,9 @@ Name | Type | Description  | Notes
 
 <a name="japaneseNameKanjiCandidates1"></a>
 # **japaneseNameKanjiCandidates1**
-> NameMatchCandidatesOut japaneseNameKanjiCandidates1(japaneseSurnameLatin, japaneseGivenNameLatin)
+> NameMatchCandidatesOut japaneseNameKanjiCandidates1(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender)
 
-Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae
+Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae - and a known gender.
 
 ### Example
 ```java
@@ -371,8 +369,9 @@ api_key.setApiKey("YOUR API KEY");
 JapaneseApi apiInstance = new JapaneseApi();
 String japaneseSurnameLatin = "japaneseSurnameLatin_example"; // String | 
 String japaneseGivenNameLatin = "japaneseGivenNameLatin_example"; // String | 
+String knownGender = "knownGender_example"; // String | 
 try {
-    NameMatchCandidatesOut result = apiInstance.japaneseNameKanjiCandidates1(japaneseSurnameLatin, japaneseGivenNameLatin);
+    NameMatchCandidatesOut result = apiInstance.japaneseNameKanjiCandidates1(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender);
     System.out.println(result);
 } catch (ApiException e) {
     System.err.println("Exception when calling JapaneseApi#japaneseNameKanjiCandidates1");
@@ -386,6 +385,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **japaneseSurnameLatin** | **String**|  |
  **japaneseGivenNameLatin** | **String**|  |
+ **knownGender** | **String**|  |
 
 ### Return type
 

docs/NameMatchedOut.md

@@ -6,8 +6,16 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **script** | **String** |  |  [optional]
 **id** | **String** |  |  [optional]
-**matchStatus** | **String** | The name matching status. |  [optional]
+**matchStatus** | [**MatchStatusEnum**](#MatchStatusEnum) | The name matching status. |  [optional]
 **score** | **Double** |  |  [optional]
 
 
+<a name="MatchStatusEnum"></a>
+## Enum: MatchStatusEnum
+Name | Value
+---- | -----
+MATCH | &quot;Match&quot;
+MISMATCH | &quot;Mismatch&quot;
+
+