v2.0.29

build.gradle

@@ -4,7 +4,7 @@ apply plugin: 'java'
 apply plugin: 'com.diffplug.spotless'
 
 group = 'com.namsor'
-version = '2.0.27'
+version = '2.0.29'
 
 buildscript {
     repositories {

build.sbt

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

docs/APIKeyOut.md

@@ -19,6 +19,7 @@
 |**disabled** | **Boolean** | The API Key is temporarily or permanently disabled. |  [optional] |
 |**explainable** | **Boolean** | The API Key supports the AI explainability option (may require a specific license). |  [optional] |
 |**ipAddress** | **String** |  |  [optional] |
+|**communityEngageOption** | [**CommunityEngageOptionOut**](CommunityEngageOptionOut.md) |  |  [optional] |
 
 
 

docs/AdminApi.md

@@ -4,8 +4,8 @@ All URIs are relative to *https://v2.namsor.com/NamSorAPIv2*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**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. |
+| [**anonymize**](AdminApi.md#anonymize) | **GET** /api2/json/anonymize/{source}/{anonymized} | Activate/deactivate anonymization for a source. |
+| [**anonymize1**](AdminApi.md#anonymize1) | **GET** /api2/json/anonymize/{source}/{anonymized}/{token} | Activate/deactivate anonymization for a source. |
 | [**apiKeyInfo**](AdminApi.md#apiKeyInfo) | **GET** /api2/json/apiKeyInfo | Read API Key info. |
 | [**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. |
@@ -22,7 +22,7 @@ All URIs are relative to *https://v2.namsor.com/NamSorAPIv2*
 
 <a id="anonymize"></a>
 # **anonymize**
-> APIKeyOut anonymize(source, anonymized, token)
+> anonymize(source, anonymized)
 
 Activate/deactivate anonymization for a source.
 
@@ -50,10 +50,8 @@ public class Example {
     AdminApi apiInstance = new AdminApi(defaultClient);
     String source = "source_example"; // String | 
     Boolean anonymized = true; // Boolean | 
-    String token = "token_example"; // String | 
     try {
-      APIKeyOut result = apiInstance.anonymize(source, anonymized, token);
-      System.out.println(result);
+      apiInstance.anonymize(source, anonymized);
     } catch (ApiException e) {
       System.err.println("Exception when calling AdminApi#anonymize");
       System.err.println("Status code: " + e.getCode());
@@ -71,11 +69,10 @@ public class Example {
 |------------- | ------------- | ------------- | -------------|
 | **source** | **String**|  | |
 | **anonymized** | **Boolean**|  | |
-| **token** | **String**|  | |
 
 ### Return type
 
-[**APIKeyOut**](APIKeyOut.md)
+null (empty response body)
 
 ### Authorization
 
@@ -84,7 +81,7 @@ public class Example {
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/json
+ - **Accept**: Not defined
 
 ### HTTP response details
 | Status code | Description | Response headers |
@@ -94,7 +91,7 @@ public class Example {
 
 <a id="anonymize1"></a>
 # **anonymize1**
-> anonymize1(source, anonymized)
+> APIKeyOut anonymize1(source, anonymized, token)
 
 Activate/deactivate anonymization for a source.
 
@@ -122,8 +119,10 @@ public class Example {
     AdminApi apiInstance = new AdminApi(defaultClient);
     String source = "source_example"; // String | 
     Boolean anonymized = true; // Boolean | 
+    String token = "token_example"; // String | 
     try {
-      apiInstance.anonymize1(source, anonymized);
+      APIKeyOut result = apiInstance.anonymize1(source, anonymized, token);
+      System.out.println(result);
     } catch (ApiException e) {
       System.err.println("Exception when calling AdminApi#anonymize1");
       System.err.println("Status code: " + e.getCode());
@@ -141,10 +140,11 @@ public class Example {
 |------------- | ------------- | ------------- | -------------|
 | **source** | **String**|  | |
 | **anonymized** | **Boolean**|  | |
+| **token** | **String**|  | |
 
 ### Return type
 
-null (empty response body)
+[**APIKeyOut**](APIKeyOut.md)
 
 ### Authorization
 
@@ -153,7 +153,7 @@ null (empty response body)
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Accept**: application/json
 
 ### HTTP response details
 | Status code | Description | Response headers |

docs/BatchCommunityEngageFullOut.md

@@ -0,0 +1,13 @@
+
+
+# BatchCommunityEngageFullOut
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**engagementCandidates** | [**List<CommunityEngageOut>**](CommunityEngageOut.md) | Classified community engagement candidates |  [optional] |
+
+
+

docs/BatchCommunityEngageOut.md

@@ -0,0 +1,13 @@
+
+
+# BatchCommunityEngageOut
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**engagementCandidates** | [**List<CommunityEngageOut>**](CommunityEngageOut.md) | Classified community engagement candidates |  [optional] |
+
+
+

docs/BatchFirstLastNameGeoOut.md

@@ -0,0 +1,13 @@
+
+
+# BatchFirstLastNameGeoOut
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**personalNames** | [**List<FirstLastNameGeoOut>**](FirstLastNameGeoOut.md) | Classified names |  [optional] |
+
+
+

docs/BatchPersonalNameDiasporaedOut.md

@@ -0,0 +1,14 @@
+
+
+# BatchPersonalNameDiasporaedOut
+
+Represents the output of inferring the LIKELY ethnicity from a personal name, given an country of residence.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**personalNames** | [**List<PersonalNameDiasporaedOut>**](PersonalNameDiasporaedOut.md) | Classified diaspora names |  [optional] |
+
+
+

docs/BatchPersonalNameOriginedOut.md

@@ -0,0 +1,14 @@
+
+
+# BatchPersonalNameOriginedOut
+
+Represents the output of inferring the LIKELY origin from a list of personal names.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**personalNames** | [**List<PersonalNameOriginedOut>**](PersonalNameOriginedOut.md) | Classified origined names |  [optional] |
+
+
+

docs/BatchPersonalNameUSRaceEthnicityOut.md

@@ -0,0 +1,14 @@
+
+
+# BatchPersonalNameUSRaceEthnicityOut
+
+Represents the output of inferring the LIKELY US race/ethnicity from a list of personal names.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**personalNames** | [**List<PersonalNameUSRaceEthnicityOut>**](PersonalNameUSRaceEthnicityOut.md) | Classified origined names |  [optional] |
+
+
+

docs/CommunityEngageOptionOut.md

@@ -0,0 +1,16 @@
+
+
+# CommunityEngageOptionOut
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**genderFilter** | **List<String>** | The gender filter (null to allow all) |  [optional] |
+|**ethnicityFilter** | **List<String>** | The ethnicity filter (null to allow all) |  [optional] |
+|**countryOutFilter** | **List<String>** | The output country filter (null to allow all) |  [optional] |
+|**usRaceEthnicityFilter** | **List<String>** | The output US race/ethnicity filter (null to allow all) |  [optional] |
+
+
+

docs/CommunityEngageOut.md

@@ -0,0 +1,22 @@
+
+
+# CommunityEngageOut
+
+Represent multiple classifications for community engagement (gender, country, origin, diaspora)
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**id** | **String** |  |  [optional] |
+|**personalNameDiasporaedOut** | [**PersonalNameDiasporaedOut**](PersonalNameDiasporaedOut.md) |  |  [optional] |
+|**personalNameOriginedOut** | [**PersonalNameOriginedOut**](PersonalNameOriginedOut.md) |  |  [optional] |
+|**country** | [**PersonalNameGeoOut**](PersonalNameGeoOut.md) |  |  [optional] |
+|**gender** | [**PersonalNameGenderedOut**](PersonalNameGenderedOut.md) |  |  [optional] |
+|**personalNameUSRaceEthnicityOut** | [**PersonalNameUSRaceEthnicityOut**](PersonalNameUSRaceEthnicityOut.md) |  |  [optional] |
+|**prime** | **Boolean** |  |  [optional] |
+|**scoped** | **Boolean** |  |  [optional] |
+|**script** | **String** |  |  [optional] |
+
+
+

docs/FirstLastNameDiasporaedOut.md

@@ -22,7 +22,7 @@ Represents the output of inferring the LIKELY ethnicity from a personal name, gi
 |**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] |
 |**religionStats** | [**List<ReligionStatOut>**](ReligionStatOut.md) | Geographic religious statistics, assuming ethnicity is correctly predicted. |  [optional] |
-|**religionStatsAlt** | [**List<ReligionStatOut>**](ReligionStatOut.md) | Geographic religious statistics, assuming ethnicity OR best alternative is correctly predicted. |  [optional] |
+|**religionStatsAlt** | [**List<ReligionStatOut>**](ReligionStatOut.md) | Geographic religious statistics, for country best alternative. |  [optional] |
 
 
 

docs/FirstLastNameGeoOut.md

@@ -0,0 +1,29 @@
+
+
+# FirstLastNameGeoOut
+
+Represents the output of inferring the LIKELY country of Origin from a personal name.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**script** | **String** |  |  [optional] |
+|**id** | **String** |  |  [optional] |
+|**explanation** | **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] |
+|**score** | **Double** | Higher score is better, but score is not normalized. Use calibratedProbability if available.  |  [optional] |
+|**country** | **String** | Most likely country  |  [optional] |
+|**countryAlt** | **String** | Second best alternative : country  |  [optional] |
+|**region** | **String** | Most likely region (based on country ISO2 code) |  [optional] |
+|**topRegion** | **String** | Most likely top region (based on country ISO2 code) |  [optional] |
+|**subRegion** | **String** | Most likely sub region (based on country ISO2 code) |  [optional] |
+|**countriesTop** | **List<String>** | List countries (top 10) |  [optional] |
+|**probabilityCalibrated** | **Double** | The calibrated probability for country to have been guessed correctly. -1 = still calibrating.  |  [optional] |
+|**probabilityAltCalibrated** | **Double** | The calibrated probability for country OR countryAlt to have been guessed correctly. -1 = still calibrating.  |  [optional] |
+|**religionStats** | [**List<ReligionStatOut>**](ReligionStatOut.md) | Geographic religious statistics, assuming country is correctly predicted. |  [optional] |
+|**religionStatsAlt** | [**List<ReligionStatOut>**](ReligionStatOut.md) | Geographic religious statistics, for country best alternative. |  [optional] |
+
+
+

docs/FirstLastNameOriginedOut.md

@@ -23,7 +23,7 @@ Represents the output of inferring the LIKELY country of Origin from a personal
 |**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] |
 |**religionStats** | [**List<ReligionStatOut>**](ReligionStatOut.md) | Geographic religious statistics, assuming country of origin is correctly predicted. |  [optional] |
-|**religionStatsAlt** | [**List<ReligionStatOut>**](ReligionStatOut.md) | Geographic religious statistics, assuming country of origin OR best alternative is correctly predicted. |  [optional] |
+|**religionStatsAlt** | [**List<ReligionStatOut>**](ReligionStatOut.md) | Geographic religious statistics, for origin best alternative. |  [optional] |
 
 
 

docs/JapaneseApi.md

@@ -9,8 +9,8 @@ All URIs are relative to *https://v2.namsor.com/NamSorAPIv2*
 | [**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} | 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. |
+| [**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 |
 | [**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 |
@@ -373,9 +373,9 @@ public class Example {
 
 <a id="japaneseNameKanjiCandidates"></a>
 # **japaneseNameKanjiCandidates**
-> NameMatchCandidatesOut japaneseNameKanjiCandidates(japaneseSurnameLatin, japaneseGivenNameLatin)
+> NameMatchCandidatesOut japaneseNameKanjiCandidates(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
@@ -401,8 +401,9 @@ public class Example {
     JapaneseApi apiInstance = new JapaneseApi(defaultClient);
     String japaneseSurnameLatin = "japaneseSurnameLatin_example"; // String | 
     String japaneseGivenNameLatin = "japaneseGivenNameLatin_example"; // String | 
+    String knownGender = "knownGender_example"; // String | 
     try {
-      NameMatchCandidatesOut result = apiInstance.japaneseNameKanjiCandidates(japaneseSurnameLatin, japaneseGivenNameLatin);
+      NameMatchCandidatesOut result = apiInstance.japaneseNameKanjiCandidates(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender);
       System.out.println(result);
     } catch (ApiException e) {
       System.err.println("Exception when calling JapaneseApi#japaneseNameKanjiCandidates");
@@ -421,6 +422,7 @@ public class Example {
 |------------- | ------------- | ------------- | -------------|
 | **japaneseSurnameLatin** | **String**|  | |
 | **japaneseGivenNameLatin** | **String**|  | |
+| **knownGender** | **String**|  | |
 
 ### Return type
 
@@ -444,9 +446,9 @@ public class Example {
 
 <a id="japaneseNameKanjiCandidates1"></a>
 # **japaneseNameKanjiCandidates1**
-> NameMatchCandidatesOut japaneseNameKanjiCandidates1(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender)
+> NameMatchCandidatesOut japaneseNameKanjiCandidates1(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
@@ -472,9 +474,8 @@ public class Example {
     JapaneseApi apiInstance = new JapaneseApi(defaultClient);
     String japaneseSurnameLatin = "japaneseSurnameLatin_example"; // String | 
     String japaneseGivenNameLatin = "japaneseGivenNameLatin_example"; // String | 
-    String knownGender = "knownGender_example"; // String | 
     try {
-      NameMatchCandidatesOut result = apiInstance.japaneseNameKanjiCandidates1(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender);
+      NameMatchCandidatesOut result = apiInstance.japaneseNameKanjiCandidates1(japaneseSurnameLatin, japaneseGivenNameLatin);
       System.out.println(result);
     } catch (ApiException e) {
       System.err.println("Exception when calling JapaneseApi#japaneseNameKanjiCandidates1");
@@ -493,7 +494,6 @@ public class Example {
 |------------- | ------------- | ------------- | -------------|
 | **japaneseSurnameLatin** | **String**|  | |
 | **japaneseGivenNameLatin** | **String**|  | |
-| **knownGender** | **String**|  | |
 
 ### Return type