diff --git a/README.md b/README.md index d71c50e3..f29bfd90 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # namsor-sdk2 NamSor API v2 -- API version: 2.0.27 - - Build date: 2023-07-16T08:45:49.006+02:00[Europe/Berlin] +- API version: 2.0.29 + - Build date: 2024-01-28T10:15:07.323+01:00[Europe/Berlin] NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! @@ -41,7 +41,7 @@ Add this dependency to your project's POM: com.namsor namsor-sdk2 - 2.0.27 + 2.0.29 compile ``` @@ -57,7 +57,7 @@ Add this dependency to your project's build file: } dependencies { - implementation "com.namsor:namsor-sdk2:2.0.27" + implementation "com.namsor:namsor-sdk2:2.0.29" } ``` @@ -71,7 +71,7 @@ mvn clean package Then manually install the following JARs: -* `target/namsor-sdk2-2.0.27.jar` +* `target/namsor-sdk2-2.0.29.jar` * `target/lib/*.jar` ## Getting Started @@ -79,13 +79,14 @@ Then manually install the following JARs: Please follow the [installation](#installation) instruction and execute the following Java code: ```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.invoke.models.*; -import com.namsor.sdk2.api.PersonalApi; +import com.namsor.sdk2.api.AdminApi; public class Example { public static void main(String[] args) { @@ -98,15 +99,13 @@ public class Example { // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.setApiKeyPrefix("Token"); - PersonalApi apiInstance = new PersonalApi(defaultClient); - String firstName = "John"; // String | - String lastName = "Smith"; // String | - String countryIso2 = "US"; // String | + AdminApi apiInstance = new AdminApi(defaultClient); + String source = "source_example"; // String | + Boolean anonymized = true; // Boolean | try { - FirstLastNameGenderedOut result = apiInstance.genderGeo(firstName, lastName, countryIso2); - System.out.println(result); + apiInstance.anonymize(source, anonymized); } catch (ApiException e) { - System.err.println("Exception when calling PersonalApi#genderGeo"); + System.err.println("Exception when calling AdminApi#anonymize"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -114,6 +113,7 @@ public class Example { } } } + ``` ## Documentation for API Endpoints @@ -122,8 +122,8 @@ All URIs are relative to *https://v2.namsor.com/NamSorAPIv2* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*AdminApi* | [**anonymize**](docs/AdminApi.md#anonymize) | **GET** /api2/json/anonymize/{source}/{anonymized}/{token} | Activate/deactivate anonymization for a source. -*AdminApi* | [**anonymize1**](docs/AdminApi.md#anonymize1) | **GET** /api2/json/anonymize/{source}/{anonymized} | Activate/deactivate anonymization for a source. +*AdminApi* | [**anonymize**](docs/AdminApi.md#anonymize) | **GET** /api2/json/anonymize/{source}/{anonymized} | Activate/deactivate anonymization for a source. +*AdminApi* | [**anonymize1**](docs/AdminApi.md#anonymize1) | **GET** /api2/json/anonymize/{source}/{anonymized}/{token} | Activate/deactivate anonymization for a source. *AdminApi* | [**apiKeyInfo**](docs/AdminApi.md#apiKeyInfo) | **GET** /api2/json/apiKeyInfo | Read API Key info. *AdminApi* | [**apiStatus**](docs/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. *AdminApi* | [**apiUsage**](docs/AdminApi.md#apiUsage) | **GET** /api2/json/apiUsage | Print current API usage. @@ -173,8 +173,8 @@ Class | Method | HTTP request | Description *JapaneseApi* | [**genderJapaneseNamePinyin**](docs/JapaneseApi.md#genderJapaneseNamePinyin) | **GET** /api2/json/genderJapaneseName/{japaneseSurname}/{japaneseGivenName} | Infer the likely gender of a Japanese name in LATIN (Pinyin). *JapaneseApi* | [**genderJapaneseNamePinyinBatch**](docs/JapaneseApi.md#genderJapaneseNamePinyinBatch) | **POST** /api2/json/genderJapaneseNameBatch | Infer the likely gender of up to 100 Japanese names in LATIN (Pinyin). *JapaneseApi* | [**japaneseNameGenderKanjiCandidatesBatch**](docs/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 -*JapaneseApi* | [**japaneseNameKanjiCandidates**](docs/JapaneseApi.md#japaneseNameKanjiCandidates) | **GET** /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin} | Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae -*JapaneseApi* | [**japaneseNameKanjiCandidates1**](docs/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. +*JapaneseApi* | [**japaneseNameKanjiCandidates**](docs/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. +*JapaneseApi* | [**japaneseNameKanjiCandidates1**](docs/JapaneseApi.md#japaneseNameKanjiCandidates1) | **GET** /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin} | Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae *JapaneseApi* | [**japaneseNameKanjiCandidatesBatch**](docs/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 *JapaneseApi* | [**japaneseNameLatinCandidates**](docs/JapaneseApi.md#japaneseNameLatinCandidates) | **GET** /api2/json/japaneseNameLatinCandidates/{japaneseSurnameKanji}/{japaneseGivenNameKanji} | Romanize japanese name, based on the name in Kanji. *JapaneseApi* | [**japaneseNameLatinCandidatesBatch**](docs/JapaneseApi.md#japaneseNameLatinCandidatesBatch) | **POST** /api2/json/japaneseNameLatinCandidatesBatch | Romanize japanese names, based on the name in KANJI @@ -183,12 +183,20 @@ Class | Method | HTTP request | Description *JapaneseApi* | [**japaneseNameMatchFeedbackLoop**](docs/JapaneseApi.md#japaneseNameMatchFeedbackLoop) | **GET** /api2/json/japaneseNameMatchFeedbackLoop/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName} | [CREDITS 1 UNIT] Feedback loop to better perform matching Japanese name in KANJI ex. 山本 早苗 with a romanized name ex. Yamamoto Sanae *JapaneseApi* | [**parseJapaneseName**](docs/JapaneseApi.md#parseJapaneseName) | **GET** /api2/json/parseJapaneseName/{japaneseName} | Infer the likely first/last name structure of a name, ex. 山本 早苗 or Yamamoto Sanae *JapaneseApi* | [**parseJapaneseNameBatch**](docs/JapaneseApi.md#parseJapaneseNameBatch) | **POST** /api2/json/parseJapaneseNameBatch | Infer the likely first/last name structure of a name, ex. 山本 早苗 or Yamamoto Sanae +*PersonalApi* | [**communityEngage**](docs/PersonalApi.md#communityEngage) | **GET** /api2/json/communityEngage/{countryIso2}/{firstName}/{lastName} | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) +*PersonalApi* | [**communityEngageBatch**](docs/PersonalApi.md#communityEngageBatch) | **POST** /api2/json/communityEngageBatch | Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) +*PersonalApi* | [**communityEngageFull**](docs/PersonalApi.md#communityEngageFull) | **GET** /api2/json/communityEngageFull/{countryIso2}/{personalNameFull} | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) +*PersonalApi* | [**communityEngageFullBatch**](docs/PersonalApi.md#communityEngageFullBatch) | **POST** /api2/json/communityEngageFullBatch | Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) *PersonalApi* | [**corridor**](docs/PersonalApi.md#corridor) | **GET** /api2/json/corridor/{countryIso2From}/{firstNameFrom}/{lastNameFrom}/{countryIso2To}/{firstNameTo}/{lastNameTo} | [USES 20 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com) *PersonalApi* | [**corridorBatch**](docs/PersonalApi.md#corridorBatch) | **POST** /api2/json/corridorBatch | [USES 20 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com) *PersonalApi* | [**country**](docs/PersonalApi.md#country) | **GET** /api2/json/country/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin. *PersonalApi* | [**countryBatch**](docs/PersonalApi.md#countryBatch) | **POST** /api2/json/countryBatch | [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin. +*PersonalApi* | [**countryFnLn**](docs/PersonalApi.md#countryFnLn) | **GET** /api2/json/countryFnLn/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal first / last name, or one surname. Assumes names as they are in the country of residence OR the country of origin. +*PersonalApi* | [**countryFnLnBatch**](docs/PersonalApi.md#countryFnLnBatch) | **POST** /api2/json/countryFnLnBatch | [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal first / last names, or surnames. Assumes names as they are in the country of residence OR the country of origin. *PersonalApi* | [**diaspora**](docs/PersonalApi.md#diaspora) | **GET** /api2/json/diaspora/{countryIso2}/{firstName}/{lastName} | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) *PersonalApi* | [**diasporaBatch**](docs/PersonalApi.md#diasporaBatch) | **POST** /api2/json/diasporaBatch | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) +*PersonalApi* | [**diasporaFull**](docs/PersonalApi.md#diasporaFull) | **GET** /api2/json/diasporaFull/{countryIso2}/{personalNameFull} | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) +*PersonalApi* | [**diasporaFullBatch**](docs/PersonalApi.md#diasporaFullBatch) | **POST** /api2/json/diasporaFullBatch | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) *PersonalApi* | [**gender**](docs/PersonalApi.md#gender) | **GET** /api2/json/gender/{firstName} | Infer the likely gender of a just a fiven name, assuming default 'US' local context. Please use preferably full names and local geographic context for better accuracy. *PersonalApi* | [**gender1**](docs/PersonalApi.md#gender1) | **GET** /api2/json/gender/{firstName}/{lastName} | Infer the likely gender of a name. *PersonalApi* | [**genderBatch**](docs/PersonalApi.md#genderBatch) | **POST** /api2/json/genderBatch | Infer the likely gender of up to 100 names, detecting automatically the cultural context. @@ -200,6 +208,8 @@ Class | Method | HTTP request | Description *PersonalApi* | [**genderGeoBatch**](docs/PersonalApi.md#genderGeoBatch) | **POST** /api2/json/genderGeoBatch | Infer the likely gender of up to 100 names, each given a local context (ISO2 country code). *PersonalApi* | [**origin**](docs/PersonalApi.md#origin) | **GET** /api2/json/origin/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead. *PersonalApi* | [**originBatch**](docs/PersonalApi.md#originBatch) | **POST** /api2/json/originBatch | [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context. +*PersonalApi* | [**originFull**](docs/PersonalApi.md#originFull) | **GET** /api2/json/originFull/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead. +*PersonalApi* | [**originFullBatch**](docs/PersonalApi.md#originFullBatch) | **POST** /api2/json/originFullBatch | [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context. *PersonalApi* | [**parseName**](docs/PersonalApi.md#parseName) | **GET** /api2/json/parseName/{nameFull} | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. *PersonalApi* | [**parseNameBatch**](docs/PersonalApi.md#parseNameBatch) | **POST** /api2/json/parseNameBatch | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. *PersonalApi* | [**parseNameGeo**](docs/PersonalApi.md#parseNameGeo) | **GET** /api2/json/parseName/{nameFull}/{countryIso2} | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. For better accuracy, provide a geographic context. @@ -214,6 +224,8 @@ Class | Method | HTTP request | Description *PersonalApi* | [**subclassificationFullBatch**](docs/PersonalApi.md#subclassificationFullBatch) | **POST** /api2/json/subclassificationFullBatch | [USES 10 UNITS PER NAME] Infer the likely origin of a list of up to 100 names at a country subclassification level (state or regeion). Initially, this is only supported for India (ISO2 code 'IN'). *PersonalApi* | [**usRaceEthnicity**](docs/PersonalApi.md#usRaceEthnicity) | **GET** /api2/json/usRaceEthnicity/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). *PersonalApi* | [**usRaceEthnicityBatch**](docs/PersonalApi.md#usRaceEthnicityBatch) | **POST** /api2/json/usRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). +*PersonalApi* | [**usRaceEthnicityFull**](docs/PersonalApi.md#usRaceEthnicityFull) | **GET** /api2/json/usRaceEthnicityFull/{personalNameFull} | [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). +*PersonalApi* | [**usRaceEthnicityFullBatch**](docs/PersonalApi.md#usRaceEthnicityFullBatch) | **POST** /api2/json/usRaceEthnicityFullBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). *PersonalApi* | [**usRaceEthnicityZIP5**](docs/PersonalApi.md#usRaceEthnicityZIP5) | **GET** /api2/json/usRaceEthnicityZIP5/{firstName}/{lastName}/{zip5Code} | [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). *PersonalApi* | [**usZipRaceEthnicityBatch**](docs/PersonalApi.md#usZipRaceEthnicityBatch) | **POST** /api2/json/usZipRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). *SocialApi* | [**phoneCode**](docs/SocialApi.md#phoneCode) | **GET** /api2/json/phoneCode/{firstName}/{lastName}/{phoneNumber} | [USES 11 UNITS PER NAME] Infer the likely country and phone prefix, given a personal name and formatted / unformatted phone number. @@ -237,6 +249,8 @@ Class | Method | HTTP request | Description - [APIServicesOut](docs/APIServicesOut.md) - [APIUsageAggregatedOut](docs/APIUsageAggregatedOut.md) - [APIUsageHistoryOut](docs/APIUsageHistoryOut.md) + - [BatchCommunityEngageFullOut](docs/BatchCommunityEngageFullOut.md) + - [BatchCommunityEngageOut](docs/BatchCommunityEngageOut.md) - [BatchCorridorIn](docs/BatchCorridorIn.md) - [BatchCorridorOut](docs/BatchCorridorOut.md) - [BatchFirstLastNameCasteOut](docs/BatchFirstLastNameCasteOut.md) @@ -245,6 +259,7 @@ Class | Method | HTTP request | Description - [BatchFirstLastNameGenderIn](docs/BatchFirstLastNameGenderIn.md) - [BatchFirstLastNameGenderedOut](docs/BatchFirstLastNameGenderedOut.md) - [BatchFirstLastNameGeoIn](docs/BatchFirstLastNameGeoIn.md) + - [BatchFirstLastNameGeoOut](docs/BatchFirstLastNameGeoOut.md) - [BatchFirstLastNameGeoSubclassificationOut](docs/BatchFirstLastNameGeoSubclassificationOut.md) - [BatchFirstLastNameGeoSubdivisionIn](docs/BatchFirstLastNameGeoSubdivisionIn.md) - [BatchFirstLastNameGeoZippedIn](docs/BatchFirstLastNameGeoZippedIn.md) @@ -262,16 +277,21 @@ Class | Method | HTTP request | Description - [BatchNameMatchCandidatesOut](docs/BatchNameMatchCandidatesOut.md) - [BatchNameMatchedOut](docs/BatchNameMatchedOut.md) - [BatchPersonalNameCastegroupOut](docs/BatchPersonalNameCastegroupOut.md) + - [BatchPersonalNameDiasporaedOut](docs/BatchPersonalNameDiasporaedOut.md) - [BatchPersonalNameGenderedOut](docs/BatchPersonalNameGenderedOut.md) - [BatchPersonalNameGeoIn](docs/BatchPersonalNameGeoIn.md) - [BatchPersonalNameGeoOut](docs/BatchPersonalNameGeoOut.md) - [BatchPersonalNameGeoSubclassificationOut](docs/BatchPersonalNameGeoSubclassificationOut.md) - [BatchPersonalNameGeoSubdivisionIn](docs/BatchPersonalNameGeoSubdivisionIn.md) - [BatchPersonalNameIn](docs/BatchPersonalNameIn.md) + - [BatchPersonalNameOriginedOut](docs/BatchPersonalNameOriginedOut.md) - [BatchPersonalNameParsedOut](docs/BatchPersonalNameParsedOut.md) - [BatchPersonalNameReligionedOut](docs/BatchPersonalNameReligionedOut.md) - [BatchPersonalNameSubdivisionIn](docs/BatchPersonalNameSubdivisionIn.md) + - [BatchPersonalNameUSRaceEthnicityOut](docs/BatchPersonalNameUSRaceEthnicityOut.md) - [BatchProperNounCategorizedOut](docs/BatchProperNounCategorizedOut.md) + - [CommunityEngageOptionOut](docs/CommunityEngageOptionOut.md) + - [CommunityEngageOut](docs/CommunityEngageOut.md) - [CorridorIn](docs/CorridorIn.md) - [CorridorOut](docs/CorridorOut.md) - [FeedbackLoopOut](docs/FeedbackLoopOut.md) @@ -281,6 +301,7 @@ Class | Method | HTTP request | Description - [FirstLastNameGenderIn](docs/FirstLastNameGenderIn.md) - [FirstLastNameGenderedOut](docs/FirstLastNameGenderedOut.md) - [FirstLastNameGeoIn](docs/FirstLastNameGeoIn.md) + - [FirstLastNameGeoOut](docs/FirstLastNameGeoOut.md) - [FirstLastNameGeoSubclassificationOut](docs/FirstLastNameGeoSubclassificationOut.md) - [FirstLastNameGeoSubdivisionIn](docs/FirstLastNameGeoSubdivisionIn.md) - [FirstLastNameGeoZippedIn](docs/FirstLastNameGeoZippedIn.md) @@ -300,15 +321,18 @@ Class | Method | HTTP request | Description - [NameMatchCandidatesOut](docs/NameMatchCandidatesOut.md) - [NameMatchedOut](docs/NameMatchedOut.md) - [PersonalNameCastegroupOut](docs/PersonalNameCastegroupOut.md) + - [PersonalNameDiasporaedOut](docs/PersonalNameDiasporaedOut.md) - [PersonalNameGenderedOut](docs/PersonalNameGenderedOut.md) - [PersonalNameGeoIn](docs/PersonalNameGeoIn.md) - [PersonalNameGeoOut](docs/PersonalNameGeoOut.md) - [PersonalNameGeoSubclassificationOut](docs/PersonalNameGeoSubclassificationOut.md) - [PersonalNameGeoSubdivisionIn](docs/PersonalNameGeoSubdivisionIn.md) - [PersonalNameIn](docs/PersonalNameIn.md) + - [PersonalNameOriginedOut](docs/PersonalNameOriginedOut.md) - [PersonalNameParsedOut](docs/PersonalNameParsedOut.md) - [PersonalNameReligionedOut](docs/PersonalNameReligionedOut.md) - [PersonalNameSubdivisionIn](docs/PersonalNameSubdivisionIn.md) + - [PersonalNameUSRaceEthnicityOut](docs/PersonalNameUSRaceEthnicityOut.md) - [ProperNounCategorizedOut](docs/ProperNounCategorizedOut.md) - [RegionISO](docs/RegionISO.md) - [RegionOut](docs/RegionOut.md) diff --git a/api/openapi.yaml b/api/openapi.yaml index 3140dcf4..6e44f6e3 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -15,7 +15,7 @@ info: name: NamSorAPI_Lic_v0.0.7 url: https://v2.namsor.com/NamSorAPIv2/assets/pdf/201803_NamSor_API_Terms_v007.pdf title: NamSor API v2 - version: 2.0.27 + version: 2.0.29 externalDocs: description: "NamSor API client SDKs v2 for Java, Python" url: https://github.com/namsor @@ -39,34 +39,21 @@ tags: - description: "Administrative, system management." name: admin paths: - /api2/json/nameType/{properNoun}: + /api2/json/regions: get: - operationId: nameType - parameters: - - explode: false - in: path - name: properNoun - required: true - schema: - type: string - style: simple + operationId: regions responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ProperNounCategorizedOut' - description: A typed name. + $ref: '#/components/schemas/RegionOut' + description: List of countries and regions. "401": description: Missing or incorrect API Key - "403": - description: "Email not Verified, or API Limit Reached, or API Key Disabled" - security: - - api_key: [] - summary: "Infer the likely type of a proper noun (personal name, brand name,\ - \ place name etc.)" + summary: Print basic source statistics. tags: - - general + - admin x-accepts: application/json /api2/json/disable/{source}/{disabled}: get: @@ -96,20 +83,13 @@ paths: tags: - admin x-accepts: application/json - /api2/json/origin/{firstName}/{lastName}: + /api2/json/nameType/{properNoun}: get: - operationId: origin + operationId: nameType parameters: - explode: false in: path - name: firstName - required: true - schema: - type: string - style: simple - - explode: false - in: path - name: lastName + name: properNoun required: true schema: type: string @@ -119,43 +99,63 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FirstLastNameOriginedOut' - description: A origined name. + $ref: '#/components/schemas/ProperNounCategorizedOut' + description: A typed name. "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: "[USES 10 UNITS PER NAME] Infer the likely country of origin of a personal\ - \ name. Assumes names as they are in the country of origin. For US, CA, AU,\ - \ NZ and other melting-pots : use 'diaspora' instead." + summary: "Infer the likely type of a proper noun (personal name, brand name,\ + \ place name etc.)" tags: - - personal + - general x-accepts: application/json - /api2/json/regions: + /api2/json/country/{personalNameFull}: get: - operationId: regions + operationId: country + parameters: + - explode: false + in: path + name: personalNameFull + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/RegionOut' - description: List of countries and regions. + $ref: '#/components/schemas/PersonalNameGeoOut' + description: A origined name. "401": description: Missing or incorrect API Key - summary: Print basic source statistics. + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + security: + - api_key: [] + summary: "[USES 10 UNITS PER NAME] Infer the likely country of residence of\ + \ a personal full name, or one surname. Assumes names as they are in the country\ + \ of residence OR the country of origin." tags: - - admin + - personal x-accepts: application/json - /api2/json/country/{personalNameFull}: + /api2/json/origin/{firstName}/{lastName}: get: - operationId: country + operationId: origin parameters: - explode: false in: path - name: personalNameFull + name: firstName + required: true + schema: + type: string + style: simple + - explode: false + in: path + name: lastName required: true schema: type: string @@ -165,7 +165,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PersonalNameGeoOut' + $ref: '#/components/schemas/FirstLastNameOriginedOut' description: A origined name. "401": description: Missing or incorrect API Key @@ -173,9 +173,9 @@ paths: description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: "[USES 10 UNITS PER NAME] Infer the likely country of residence of\ - \ a personal full name, or one surname. Assumes names as they are in the country\ - \ of residence OR the country of origin." + summary: "[USES 10 UNITS PER NAME] Infer the likely country of origin of a personal\ + \ name. Assumes names as they are in the country of origin. For US, CA, AU,\ + \ NZ and other melting-pots : use 'diaspora' instead." tags: - personal x-accepts: application/json @@ -392,7 +392,7 @@ paths: tags: - admin x-accepts: application/json - /api2/json/anonymize/{source}/{anonymized}/{token}: + /api2/json/anonymize/{source}/{anonymized}: get: operationId: anonymize parameters: @@ -410,19 +410,8 @@ paths: schema: type: boolean style: simple - - explode: false - in: path - name: token - required: true - schema: - type: string - style: simple responses: "200": - content: - application/json: - schema: - $ref: '#/components/schemas/APIKeyOut' description: Anonymization of a source. "401": description: Missing or incorrect API Key @@ -430,7 +419,7 @@ paths: tags: - admin x-accepts: application/json - /api2/json/anonymize/{source}/{anonymized}: + /api2/json/anonymize/{source}/{anonymized}/{token}: get: operationId: anonymize_1 parameters: @@ -448,8 +437,19 @@ paths: schema: type: boolean style: simple + - explode: false + in: path + name: token + required: true + schema: + type: string + style: simple responses: "200": + content: + application/json: + schema: + $ref: '#/components/schemas/APIKeyOut' description: Anonymization of a source. "401": description: Missing or incorrect API Key @@ -969,6 +969,66 @@ paths: - personal x-content-type: application/json x-accepts: application/json + /api2/json/originFull/{personalNameFull}: + get: + operationId: originFull + parameters: + - explode: false + in: path + name: personalNameFull + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PersonalNameOriginedOut' + description: A origined name. + "401": + description: Missing or incorrect API Key + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + security: + - api_key: [] + summary: "[USES 10 UNITS PER NAME] Infer the likely country of origin of a personal\ + \ name. Assumes names as they are in the country of origin. For US, CA, AU,\ + \ NZ and other melting-pots : use 'diaspora' instead." + tags: + - personal + x-accepts: application/json + /api2/json/originFullBatch: + post: + operationId: originFullBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchPersonalNameIn' + description: A list of personal names + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/BatchPersonalNameOriginedOut' + description: A list of genderized names. + "401": + description: Missing or incorrect API Key + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + "400": + description: Bad request (ex. too many names) + security: + - api_key: [] + summary: "[USES 10 UNITS PER NAME] Infer the likely country of origin of up\ + \ to 100 names, detecting automatically the cultural context." + tags: + - personal + x-content-type: application/json + x-accepts: application/json /api2/json/subclassificationIndian/{firstName}/{lastName}: get: operationId: subclassificationIndian @@ -1760,7 +1820,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BatchPersonalNameGeoOut' - description: A list of genderized names. + description: A list of origined names. "401": description: Missing or incorrect API Key "403": @@ -1776,6 +1836,74 @@ paths: - personal x-content-type: application/json x-accepts: application/json + /api2/json/countryFnLn/{firstName}/{lastName}: + get: + operationId: countryFnLn + parameters: + - explode: false + in: path + name: firstName + required: true + schema: + type: string + style: simple + - explode: false + in: path + name: lastName + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/FirstLastNameOriginedOut' + description: A origined name. + "401": + description: Missing or incorrect API Key + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + security: + - api_key: [] + summary: "[USES 10 UNITS PER NAME] Infer the likely country of residence of\ + \ a personal first / last name, or one surname. Assumes names as they are\ + \ in the country of residence OR the country of origin." + tags: + - personal + x-accepts: application/json + /api2/json/countryFnLnBatch: + post: + operationId: countryFnLnBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchFirstLastNameIn' + description: A list of personal names + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/BatchFirstLastNameGeoOut' + description: A list of origined names. + "401": + description: Missing or incorrect API Key + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + "400": + description: Bad request (ex. too many names) + security: + - api_key: [] + summary: "[USES 10 UNITS PER NAME] Infer the likely country of residence of\ + \ up to 100 personal first / last names, or surnames. Assumes names as they\ + \ are in the country of residence OR the country of origin." + tags: + - personal + x-content-type: application/json + x-accepts: application/json /api2/json/usRaceEthnicity/{firstName}/{lastName}: get: operationId: usRaceEthnicity @@ -1942,27 +2070,13 @@ paths: - personal x-content-type: application/json x-accepts: application/json - /api2/json/diaspora/{countryIso2}/{firstName}/{lastName}: + /api2/json/usRaceEthnicityFull/{personalNameFull}: get: - operationId: diaspora + operationId: usRaceEthnicityFull parameters: - explode: false in: path - name: countryIso2 - required: true - schema: - type: string - style: simple - - explode: false - in: path - name: firstName - required: true - schema: - type: string - style: simple - - explode: false - in: path - name: lastName + name: personalNameFull required: true schema: type: string @@ -1972,36 +2086,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FirstLastNameDiasporaedOut' - description: A diaspora / ethnicity for given name and geography. - "401": + $ref: '#/components/schemas/PersonalNameUSRaceEthnicityOut' + description: "a US resident's likely race/ethnicity : W_NL (white, non latino),\ + \ HL (hispano latino), A (asian, non latino), B_NL (black, non latino),\ + \ AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*).\ + \ *optionally" + "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: "[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a\ - \ personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ\ - \ etc.)" + summary: "[USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity\ + \ according to US Census taxonomy W_NL (white, non latino), HL (hispano latino),\ + \ A (asian, non latino), B_NL (black, non latino). Optionally add header\ + \ X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional\ + \ classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander)." tags: - personal x-accepts: application/json - /api2/json/diasporaBatch: + /api2/json/usRaceEthnicityFullBatch: post: - operationId: diasporaBatch + operationId: usRaceEthnicityFullBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchFirstLastNameGeoIn' + $ref: '#/components/schemas/BatchPersonalNameGeoIn' description: A list of personal names responses: "200": content: application/json: schema: - $ref: '#/components/schemas/BatchFirstLastNameDiasporaedOut' - description: A list of diaspora / ethnicity given a name and residency. + $ref: '#/components/schemas/BatchPersonalNameUSRaceEthnicityOut' + description: "A list of US resident's likely race/ethnicity. W_NL (white,\ + \ non latino), HL (hispano latino), A (asian, non latino), B_NL (black,\ + \ non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific\ + \ Islander*). *optionally" "401": description: Missing or incorrect API Key "403": @@ -2010,27 +2132,37 @@ paths: description: Bad request (ex. too many names) security: - api_key: [] - summary: "[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up\ - \ to 100 personal names, given a country of residence ISO2 code (ex. US, CA,\ - \ AU, NZ etc.)" + summary: "[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity\ + \ according to US Census taxonomy. Output is W_NL (white, non latino), HL\ + \ (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally\ + \ add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for\ + \ two additional classes, AI_AN (American Indian or Alaskan Native) and PI\ + \ (Pacific Islander)." tags: - personal x-content-type: application/json x-accepts: application/json - /api2/json/parseName/{nameFull}/{countryIso2}: + /api2/json/diaspora/{countryIso2}/{firstName}/{lastName}: get: - operationId: parseNameGeo + operationId: diaspora parameters: - explode: false in: path - name: nameFull + name: countryIso2 required: true schema: type: string style: simple - explode: false in: path - name: countryIso2 + name: firstName + required: true + schema: + type: string + style: simple + - explode: false + in: path + name: lastName required: true schema: type: string @@ -2040,66 +2172,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PersonalNameParsedOut' - description: A origined name. - "401": - description: Missing or incorrect API Key - "403": - description: "Email not Verified, or API Limit Reached, or API Key Disabled" - security: - - api_key: [] - summary: "Infer the likely first/last name structure of a name, ex. John Smith\ - \ or SMITH, John or SMITH; John. For better accuracy, provide a geographic\ - \ context." - tags: - - personal - x-accepts: application/json - /api2/json/parseNameBatch: - post: - operationId: parseNameBatch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BatchPersonalNameIn' - description: A list of personal names - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/BatchPersonalNameParsedOut' - description: A list of parsed names. + $ref: '#/components/schemas/FirstLastNameDiasporaedOut' + description: A diaspora / ethnicity for given name and geography. "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" - "400": - description: Bad request (ex. too many names) security: - api_key: [] - summary: "Infer the likely first/last name structure of a name, ex. John Smith\ - \ or SMITH, John or SMITH; John." + summary: "[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a\ + \ personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ\ + \ etc.)" tags: - personal - x-content-type: application/json x-accepts: application/json - /api2/json/parseNameGeoBatch: + /api2/json/diasporaBatch: post: - operationId: parseNameGeoBatch + operationId: diasporaBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchPersonalNameGeoIn' + $ref: '#/components/schemas/BatchFirstLastNameGeoIn' description: A list of personal names responses: "200": content: application/json: schema: - $ref: '#/components/schemas/BatchPersonalNameParsedOut' - description: A list of parsed names. + $ref: '#/components/schemas/BatchFirstLastNameDiasporaedOut' + description: A list of diaspora / ethnicity given a name and residency. "401": description: Missing or incorrect API Key "403": @@ -2108,19 +2210,27 @@ paths: description: Bad request (ex. too many names) security: - api_key: [] - summary: "Infer the likely first/last name structure of a name, ex. John Smith\ - \ or SMITH, John or SMITH; John. Giving a local context improves precision. " + summary: "[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up\ + \ to 100 personal names, given a country of residence ISO2 code (ex. US, CA,\ + \ AU, NZ etc.)" tags: - personal x-content-type: application/json x-accepts: application/json - /api2/json/parseChineseName/{chineseName}: + /api2/json/diasporaFull/{countryIso2}/{personalNameFull}: get: - operationId: parseChineseName + operationId: diasporaFull parameters: - explode: false in: path - name: chineseName + name: countryIso2 + required: true + schema: + type: string + style: simple + - explode: false + in: path + name: personalNameFull required: true schema: type: string @@ -2130,35 +2240,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PersonalNameParsedOut' - description: A origined name. + $ref: '#/components/schemas/PersonalNameDiasporaedOut' + description: A diaspora / ethnicity for given name and geography. "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: "Infer the likely first/last name structure of a name, ex. 王晓明 -> 王\ - (surname) 晓明(given name)" + summary: "[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a\ + \ personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ\ + \ etc.)" tags: - - chinese + - personal x-accepts: application/json - /api2/json/parseChineseNameBatch: + /api2/json/diasporaFullBatch: post: - operationId: parseChineseNameBatch + operationId: diasporaFullBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchPersonalNameIn' + $ref: '#/components/schemas/BatchPersonalNameGeoIn' description: A list of personal names responses: "200": content: application/json: schema: - $ref: '#/components/schemas/BatchPersonalNameParsedOut' - description: A list of parsed names. + $ref: '#/components/schemas/BatchPersonalNameDiasporaedOut' + description: A list of diaspora / ethnicity given a name and residency. "401": description: Missing or incorrect API Key "403": @@ -2167,19 +2278,34 @@ paths: description: Bad request (ex. too many names) security: - api_key: [] - summary: "Infer the likely first/last name structure of a name, ex. 王晓明 -> 王\ - (surname) 晓明(given name)." + summary: "[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up\ + \ to 100 personal names, given a country of residence ISO2 code (ex. US, CA,\ + \ AU, NZ etc.)" tags: - - chinese + - personal x-content-type: application/json x-accepts: application/json - /api2/json/pinyinChineseName/{chineseName}: + /api2/json/communityEngage/{countryIso2}/{firstName}/{lastName}: get: - operationId: pinyinChineseName + operationId: communityEngage parameters: - explode: false in: path - name: chineseName + name: countryIso2 + required: true + schema: + type: string + style: simple + - explode: false + in: path + name: firstName + required: true + schema: + type: string + style: simple + - explode: false + in: path + name: lastName required: true schema: type: string @@ -2189,35 +2315,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PersonalNameParsedOut' - description: A pinyin name. + $ref: '#/components/schemas/CommunityEngageOut' + description: A community engagement candidate. "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: "Romanize the Chinese name to Pinyin, ex. 王晓明 -> Wang (surname) Xiaoming\ - \ (given name)" + summary: "[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country,\ + \ gender of a personal name, given a country of residence ISO2 code (ex. US,\ + \ CA, AU, NZ etc.) for community engagement (require special module/pricing)" tags: - - chinese + - personal x-accepts: application/json - /api2/json/pinyinChineseNameBatch: + /api2/json/communityEngageBatch: post: - operationId: pinyinChineseNameBatch + operationId: communityEngageBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchPersonalNameIn' - description: A list of Chinese names + $ref: '#/components/schemas/BatchFirstLastNameGeoIn' + description: A list of personal names responses: "200": content: application/json: schema: - $ref: '#/components/schemas/BatchPersonalNameParsedOut' - description: A list of Pinyin names. + $ref: '#/components/schemas/BatchCommunityEngageOut' + description: A list of diaspora / ethnicity given a name and residency. "401": description: Missing or incorrect API Key "403": @@ -2226,33 +2353,27 @@ paths: description: Bad request (ex. too many names) security: - api_key: [] - summary: "Romanize a list of Chinese name to Pinyin, ex. 王晓明 -> Wang (surname)\ - \ Xiaoming (given name)." + summary: "Infer the likely ethnicity/diaspora, country, gender of up to 100\ + \ personal names, given a country of residence ISO2 code (ex. US, CA, AU,\ + \ NZ etc.) for community engagement (require special module/pricing)" tags: - - chinese + - personal x-content-type: application/json x-accepts: application/json - /api2/json/chineseNameMatch/{chineseSurnameLatin}/{chineseGivenNameLatin}/{chineseName}: + /api2/json/communityEngageFull/{countryIso2}/{personalNameFull}: get: - operationId: chineseNameMatch + operationId: communityEngageFull parameters: - explode: false in: path - name: chineseSurnameLatin - required: true - schema: - type: string - style: simple - - explode: false - in: path - name: chineseGivenNameLatin + name: countryIso2 required: true schema: type: string style: simple - explode: false in: path - name: chineseName + name: personalNameFull required: true schema: type: string @@ -2262,36 +2383,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NameMatchedOut' - description: A romanized name. + $ref: '#/components/schemas/CommunityEngageOut' + description: A community engagement candidate. "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: Return a score for matching Chinese name ex. 王晓明 with a romanized name - ex. Wang Xiaoming + summary: "[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country,\ + \ gender of a personal name, given a country of residence ISO2 code (ex. US,\ + \ CA, AU, NZ etc.) for community engagement (require special module/pricing)" tags: - - chinese + - personal x-accepts: application/json - /api2/json/chineseNameMatchBatch: + /api2/json/communityEngageFullBatch: post: - operationId: chineseNameMatchBatch + operationId: communityEngageFullBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchMatchPersonalFirstLastNameIn' - description: "A list of personal Chinese names in LATIN, firstName = chineseGivenName;\ - \ lastName=chineseSurname" + $ref: '#/components/schemas/BatchPersonalNameGeoIn' + description: A list of personal names responses: "200": content: application/json: schema: - $ref: '#/components/schemas/BatchNameMatchedOut' - description: A list of genderized names. + $ref: '#/components/schemas/BatchCommunityEngageFullOut' + description: A list cummunity engagement candidates. "401": description: Missing or incorrect API Key "403": @@ -2300,26 +2421,27 @@ paths: description: Bad request (ex. too many names) security: - api_key: [] - summary: "Identify Chinese name candidates, based on the romanized name (firstName\ - \ = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming" + summary: "Infer the likely ethnicity/diaspora, country, gender of up to 100\ + \ personal names, given a country of residence ISO2 code (ex. US, CA, AU,\ + \ NZ etc.) for community engagement (require special module/pricing)" tags: - - chinese + - personal x-content-type: application/json x-accepts: application/json - /api2/json/genderChineseNamePinyin/{chineseSurnameLatin}/{chineseGivenNameLatin}: + /api2/json/parseName/{nameFull}/{countryIso2}: get: - operationId: genderChineseNamePinyin + operationId: parseNameGeo parameters: - explode: false in: path - name: chineseSurnameLatin + name: nameFull required: true schema: type: string style: simple - explode: false in: path - name: chineseGivenNameLatin + name: countryIso2 required: true schema: type: string @@ -2329,34 +2451,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FirstLastNameGenderedOut' - description: A genderized name. + $ref: '#/components/schemas/PersonalNameParsedOut' + description: A origined name. "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: Infer the likely gender of a Chinese name in LATIN (Pinyin). + summary: "Infer the likely first/last name structure of a name, ex. John Smith\ + \ or SMITH, John or SMITH; John. For better accuracy, provide a geographic\ + \ context." tags: - - chinese + - personal x-accepts: application/json - /api2/json/genderChineseNamePinyinBatch: + /api2/json/parseNameBatch: post: - operationId: genderChineseNamePinyinBatch + operationId: parseNameBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchFirstLastNameIn' - description: "A list of names, with country code." + $ref: '#/components/schemas/BatchPersonalNameIn' + description: A list of personal names responses: "200": content: application/json: schema: - $ref: '#/components/schemas/BatchFirstLastNameGenderedOut' - description: A list of genderized names. + $ref: '#/components/schemas/BatchPersonalNameParsedOut' + description: A list of parsed names. "401": description: Missing or incorrect API Key "403": @@ -2365,55 +2489,87 @@ paths: description: Bad request (ex. too many names) security: - api_key: [] - summary: Infer the likely gender of up to 100 Chinese names in LATIN (Pinyin). + summary: "Infer the likely first/last name structure of a name, ex. John Smith\ + \ or SMITH, John or SMITH; John." tags: - - chinese + - personal x-content-type: application/json x-accepts: application/json - /api2/json/genderChineseName/{chineseName}: - get: - operationId: genderChineseName - parameters: - - explode: false - in: path - name: chineseName - required: true - schema: - type: string - style: simple - responses: - "200": - content: - application/json: + /api2/json/parseNameGeoBatch: + post: + operationId: parseNameGeoBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchPersonalNameGeoIn' + description: A list of personal names + responses: + "200": + content: + application/json: schema: - $ref: '#/components/schemas/PersonalNameGenderedOut' - description: A genderized name. + $ref: '#/components/schemas/BatchPersonalNameParsedOut' + description: A list of parsed names. "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" + "400": + description: Bad request (ex. too many names) security: - api_key: [] - summary: Infer the likely gender of a Chinese full name ex. 王晓明 + summary: "Infer the likely first/last name structure of a name, ex. John Smith\ + \ or SMITH, John or SMITH; John. Giving a local context improves precision. " + tags: + - personal + x-content-type: application/json + x-accepts: application/json + /api2/json/parseChineseName/{chineseName}: + get: + operationId: parseChineseName + parameters: + - explode: false + in: path + name: chineseName + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PersonalNameParsedOut' + description: A origined name. + "401": + description: Missing or incorrect API Key + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + security: + - api_key: [] + summary: "Infer the likely first/last name structure of a name, ex. 王晓明 -> 王\ + (surname) 晓明(given name)" tags: - chinese x-accepts: application/json - /api2/json/genderChineseNameBatch: + /api2/json/parseChineseNameBatch: post: - operationId: genderChineseNameBatch + operationId: parseChineseNameBatch requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchPersonalNameIn' - description: "A list of personal names, with a country ISO2 code" + description: A list of personal names responses: "200": content: application/json: schema: - $ref: '#/components/schemas/BatchPersonalNameGenderedOut' - description: A list of genderized names. + $ref: '#/components/schemas/BatchPersonalNameParsedOut' + description: A list of parsed names. "401": description: Missing or incorrect API Key "403": @@ -2422,25 +2578,19 @@ paths: description: Bad request (ex. too many names) security: - api_key: [] - summary: Infer the likely gender of up to 100 full names ex. 王晓明 + summary: "Infer the likely first/last name structure of a name, ex. 王晓明 -> 王\ + (surname) 晓明(given name)." tags: - chinese x-content-type: application/json x-accepts: application/json - /api2/json/chineseNameCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}: + /api2/json/pinyinChineseName/{chineseName}: get: - operationId: chineseNameCandidates + operationId: pinyinChineseName parameters: - explode: false in: path - name: chineseSurnameLatin - required: true - schema: - type: string - style: simple - - explode: false - in: path - name: chineseGivenNameLatin + name: chineseName required: true schema: type: string @@ -2450,36 +2600,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NameMatchCandidatesOut' - description: A romanized name. + $ref: '#/components/schemas/PersonalNameParsedOut' + description: A pinyin name. "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: "Identify Chinese name candidates, based on the romanized name ex.\ - \ Wang Xiaoming" + summary: "Romanize the Chinese name to Pinyin, ex. 王晓明 -> Wang (surname) Xiaoming\ + \ (given name)" tags: - chinese x-accepts: application/json - /api2/json/chineseNameCandidatesBatch: + /api2/json/pinyinChineseNameBatch: post: - operationId: chineseNameCandidatesBatch + operationId: pinyinChineseNameBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchFirstLastNameIn' - description: "A list of personal Chinese names in LATIN, firstName = chineseGivenName;\ - \ lastName=chineseSurname" + $ref: '#/components/schemas/BatchPersonalNameIn' + description: A list of Chinese names responses: "200": content: application/json: schema: - $ref: '#/components/schemas/BatchNameMatchCandidatesOut' - description: A list of genderized names. + $ref: '#/components/schemas/BatchPersonalNameParsedOut' + description: A list of Pinyin names. "401": description: Missing or incorrect API Key "403": @@ -2488,15 +2637,15 @@ paths: description: Bad request (ex. too many names) security: - api_key: [] - summary: "Identify Chinese name candidates, based on the romanized name (firstName\ - \ = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming" + summary: "Romanize a list of Chinese name to Pinyin, ex. 王晓明 -> Wang (surname)\ + \ Xiaoming (given name)." tags: - chinese x-content-type: application/json x-accepts: application/json - /api2/json/chineseNameGenderCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}/{knownGender}: + /api2/json/chineseNameMatch/{chineseSurnameLatin}/{chineseGivenNameLatin}/{chineseName}: get: - operationId: chineseNameGenderCandidates + operationId: chineseNameMatch parameters: - explode: false in: path @@ -2514,7 +2663,7 @@ paths: style: simple - explode: false in: path - name: knownGender + name: chineseName required: true schema: type: string @@ -2524,7 +2673,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NameMatchCandidatesOut' + $ref: '#/components/schemas/NameMatchedOut' description: A romanized name. "401": description: Missing or incorrect API Key @@ -2532,19 +2681,19 @@ paths: description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: "Identify Chinese name candidates, based on the romanized name ex.\ - \ Wang Xiaoming - having a known gender ('male' or 'female')" + summary: Return a score for matching Chinese name ex. 王晓明 with a romanized name + ex. Wang Xiaoming tags: - chinese x-accepts: application/json - /api2/json/chineseNameCandidatesGenderBatch: + /api2/json/chineseNameMatchBatch: post: - operationId: chineseNameCandidatesGenderBatch + operationId: chineseNameMatchBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchFirstLastNameGenderIn' + $ref: '#/components/schemas/BatchMatchPersonalFirstLastNameIn' description: "A list of personal Chinese names in LATIN, firstName = chineseGivenName;\ \ lastName=chineseSurname" responses: @@ -2552,7 +2701,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchNameMatchCandidatesOut' + $ref: '#/components/schemas/BatchNameMatchedOut' description: A list of genderized names. "401": description: Missing or incorrect API Key @@ -2563,18 +2712,25 @@ paths: security: - api_key: [] summary: "Identify Chinese name candidates, based on the romanized name (firstName\ - \ = chineseGivenName; lastName=chineseSurname) ex. Wang Xiaoming." + \ = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming" tags: - chinese x-content-type: application/json x-accepts: application/json - /api2/json/parseJapaneseName/{japaneseName}: + /api2/json/genderChineseNamePinyin/{chineseSurnameLatin}/{chineseGivenNameLatin}: get: - operationId: parseJapaneseName + operationId: genderChineseNamePinyin parameters: - explode: false in: path - name: japaneseName + name: chineseSurnameLatin + required: true + schema: + type: string + style: simple + - explode: false + in: path + name: chineseGivenNameLatin required: true schema: type: string @@ -2584,35 +2740,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PersonalNameParsedOut' - description: A origined name. + $ref: '#/components/schemas/FirstLastNameGenderedOut' + description: A genderized name. "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: "Infer the likely first/last name structure of a name, ex. 山本 早苗 or\ - \ Yamamoto Sanae" + summary: Infer the likely gender of a Chinese name in LATIN (Pinyin). tags: - - japanese + - chinese x-accepts: application/json - /api2/json/parseJapaneseNameBatch: + /api2/json/genderChineseNamePinyinBatch: post: - operationId: parseJapaneseNameBatch + operationId: genderChineseNamePinyinBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchPersonalNameIn' - description: A list of personal names + $ref: '#/components/schemas/BatchFirstLastNameIn' + description: "A list of names, with country code." responses: "200": content: application/json: schema: - $ref: '#/components/schemas/BatchPersonalNameParsedOut' - description: A list of parsed names. + $ref: '#/components/schemas/BatchFirstLastNameGenderedOut' + description: A list of genderized names. "401": description: Missing or incorrect API Key "403": @@ -2621,26 +2776,18 @@ paths: description: Bad request (ex. too many names) security: - api_key: [] - summary: "Infer the likely first/last name structure of a name, ex. 山本 早苗 or\ - \ Yamamoto Sanae " + summary: Infer the likely gender of up to 100 Chinese names in LATIN (Pinyin). tags: - - japanese + - chinese x-content-type: application/json x-accepts: application/json - /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}: + /api2/json/genderChineseName/{chineseName}: get: - operationId: japaneseNameKanjiCandidates + operationId: genderChineseName parameters: - explode: false in: path - name: japaneseSurnameLatin - required: true - schema: - type: string - style: simple - - explode: false - in: path - name: japaneseGivenNameLatin + name: chineseName required: true schema: type: string @@ -2650,76 +2797,61 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NameMatchCandidatesOut' - description: A romanized name. + $ref: '#/components/schemas/PersonalNameGenderedOut' + description: A genderized name. "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: "Identify japanese name candidates in KANJI, based on the romanized\ - \ name ex. Yamamoto Sanae" + summary: Infer the likely gender of a Chinese full name ex. 王晓明 tags: - - japanese + - chinese x-accepts: application/json - /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{knownGender}: - get: - operationId: japaneseNameKanjiCandidates_1 - parameters: - - explode: false - in: path - name: japaneseSurnameLatin - required: true - schema: - type: string - style: simple - - explode: false - in: path - name: japaneseGivenNameLatin - required: true - schema: - type: string - style: simple - - explode: false - in: path - name: knownGender - required: true - schema: - type: string - style: simple + /api2/json/genderChineseNameBatch: + post: + operationId: genderChineseNameBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchPersonalNameIn' + description: "A list of personal names, with a country ISO2 code" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/NameMatchCandidatesOut' - description: A romanized name. + $ref: '#/components/schemas/BatchPersonalNameGenderedOut' + description: A list of genderized names. "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" + "400": + description: Bad request (ex. too many names) security: - api_key: [] - summary: "Identify japanese name candidates in KANJI, based on the romanized\ - \ name ex. Yamamoto Sanae - and a known gender." + summary: Infer the likely gender of up to 100 full names ex. 王晓明 tags: - - japanese + - chinese + x-content-type: application/json x-accepts: application/json - /api2/json/japaneseNameLatinCandidates/{japaneseSurnameKanji}/{japaneseGivenNameKanji}: + /api2/json/chineseNameCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}: get: - operationId: japaneseNameLatinCandidates + operationId: chineseNameCandidates parameters: - explode: false in: path - name: japaneseSurnameKanji + name: chineseSurnameLatin required: true schema: type: string style: simple - explode: false in: path - name: japaneseGivenNameKanji + name: chineseGivenNameLatin required: true schema: type: string @@ -2737,20 +2869,21 @@ paths: description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: "Romanize japanese name, based on the name in Kanji." + summary: "Identify Chinese name candidates, based on the romanized name ex.\ + \ Wang Xiaoming" tags: - - japanese + - chinese x-accepts: application/json - /api2/json/japaneseNameKanjiCandidatesBatch: + /api2/json/chineseNameCandidatesBatch: post: - operationId: japaneseNameKanjiCandidatesBatch + operationId: chineseNameCandidatesBatch requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchFirstLastNameIn' - description: "A list of personal japanese names in LATIN, firstName = japaneseGivenName;\ - \ lastName=japaneseSurname" + description: "A list of personal Chinese names in LATIN, firstName = chineseGivenName;\ + \ lastName=chineseSurname" responses: "200": content: @@ -2766,23 +2899,65 @@ paths: description: Bad request (ex. too many names) security: - api_key: [] - summary: "Identify japanese name candidates in KANJI, based on the romanized\ - \ name (firstName = japaneseGivenName; lastName=japaneseSurname), ex. Yamamoto\ - \ Sanae" + summary: "Identify Chinese name candidates, based on the romanized name (firstName\ + \ = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming" tags: - - japanese + - chinese x-content-type: application/json x-accepts: application/json - /api2/json/japaneseNameGenderKanjiCandidatesBatch: + /api2/json/chineseNameGenderCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}/{knownGender}: + get: + operationId: chineseNameGenderCandidates + parameters: + - explode: false + in: path + name: chineseSurnameLatin + required: true + schema: + type: string + style: simple + - explode: false + in: path + name: chineseGivenNameLatin + required: true + schema: + type: string + style: simple + - explode: false + in: path + name: knownGender + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/NameMatchCandidatesOut' + description: A romanized name. + "401": + description: Missing or incorrect API Key + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + security: + - api_key: [] + summary: "Identify Chinese name candidates, based on the romanized name ex.\ + \ Wang Xiaoming - having a known gender ('male' or 'female')" + tags: + - chinese + x-accepts: application/json + /api2/json/chineseNameCandidatesGenderBatch: post: - operationId: japaneseNameGenderKanjiCandidatesBatch + operationId: chineseNameCandidatesGenderBatch requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchFirstLastNameGenderIn' - description: "A list of personal japanese names in LATIN, firstName = japaneseGivenName;\ - \ lastName=japaneseSurname and known gender" + description: "A list of personal Chinese names in LATIN, firstName = chineseGivenName;\ + \ lastName=chineseSurname" responses: "200": content: @@ -2798,30 +2973,57 @@ paths: description: Bad request (ex. too many names) security: - api_key: [] - summary: "Identify japanese name candidates in KANJI, based on the romanized\ - \ name (firstName = japaneseGivenName; lastName=japaneseSurname) with KNOWN\ - \ gender, ex. Yamamoto Sanae" + summary: "Identify Chinese name candidates, based on the romanized name (firstName\ + \ = chineseGivenName; lastName=chineseSurname) ex. Wang Xiaoming." tags: - - japanese + - chinese x-content-type: application/json x-accepts: application/json - /api2/json/japaneseNameLatinCandidatesBatch: + /api2/json/parseJapaneseName/{japaneseName}: + get: + operationId: parseJapaneseName + parameters: + - explode: false + in: path + name: japaneseName + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PersonalNameParsedOut' + description: A origined name. + "401": + description: Missing or incorrect API Key + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + security: + - api_key: [] + summary: "Infer the likely first/last name structure of a name, ex. 山本 早苗 or\ + \ Yamamoto Sanae" + tags: + - japanese + x-accepts: application/json + /api2/json/parseJapaneseNameBatch: post: - operationId: japaneseNameLatinCandidatesBatch + operationId: parseJapaneseNameBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchFirstLastNameIn' - description: "A list of personal japanese names in KANJI, firstName = japaneseGivenName;\ - \ lastName=japaneseSurname" + $ref: '#/components/schemas/BatchPersonalNameIn' + description: A list of personal names responses: "200": content: application/json: schema: - $ref: '#/components/schemas/BatchNameMatchCandidatesOut' - description: A list of genderized names. + $ref: '#/components/schemas/BatchPersonalNameParsedOut' + description: A list of parsed names. "401": description: Missing or incorrect API Key "403": @@ -2830,14 +3032,15 @@ paths: description: Bad request (ex. too many names) security: - api_key: [] - summary: "Romanize japanese names, based on the name in KANJI" + summary: "Infer the likely first/last name structure of a name, ex. 山本 早苗 or\ + \ Yamamoto Sanae " tags: - japanese x-content-type: application/json x-accepts: application/json - /api2/json/japaneseNameMatch/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName}: + /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{knownGender}: get: - operationId: japaneseNameMatch + operationId: japaneseNameKanjiCandidates parameters: - explode: false in: path @@ -2855,7 +3058,7 @@ paths: style: simple - explode: false in: path - name: japaneseName + name: knownGender required: true schema: type: string @@ -2865,7 +3068,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NameMatchedOut' + $ref: '#/components/schemas/NameMatchCandidatesOut' description: A romanized name. "401": description: Missing or incorrect API Key @@ -2873,14 +3076,14 @@ paths: description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: Return a score for matching Japanese name in KANJI ex. 山本 早苗 with a - romanized name ex. Yamamoto Sanae + summary: "Identify japanese name candidates in KANJI, based on the romanized\ + \ name ex. Yamamoto Sanae - and a known gender." tags: - japanese x-accepts: application/json - /api2/json/japaneseNameMatchFeedbackLoop/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName}: + /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}: get: - operationId: japaneseNameMatchFeedbackLoop + operationId: japaneseNameKanjiCandidates_1 parameters: - explode: false in: path @@ -2896,19 +3099,12 @@ paths: schema: type: string style: simple - - explode: false - in: path - name: japaneseName - required: true - schema: - type: string - style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/FeedbackLoopOut' + $ref: '#/components/schemas/NameMatchCandidatesOut' description: A romanized name. "401": description: Missing or incorrect API Key @@ -2916,56 +3112,25 @@ paths: description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: "[CREDITS 1 UNIT] Feedback loop to better perform matching Japanese\ - \ name in KANJI ex. 山本 早苗 with a romanized name ex. Yamamoto Sanae" - tags: - - japanese - x-accepts: application/json - /api2/json/japaneseNameMatchBatch: - post: - operationId: japaneseNameMatchBatch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BatchMatchPersonalFirstLastNameIn' - description: "A list of personal Japanese names in LATIN, firstName = japaneseGivenName;\ - \ lastName=japaneseSurname" - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/BatchNameMatchedOut' - description: A list of matched names. - "401": - description: Missing or incorrect API Key - "403": - description: "Email not Verified, or API Limit Reached, or API Key Disabled" - "400": - description: Bad request (ex. too many names) - security: - - api_key: [] - summary: Return a score for matching a list of Japanese names in KANJI ex. 山本 - 早苗 with romanized names ex. Yamamoto Sanae + summary: "Identify japanese name candidates in KANJI, based on the romanized\ + \ name ex. Yamamoto Sanae" tags: - japanese - x-content-type: application/json x-accepts: application/json - /api2/json/genderJapaneseName/{japaneseSurname}/{japaneseGivenName}: + /api2/json/japaneseNameLatinCandidates/{japaneseSurnameKanji}/{japaneseGivenNameKanji}: get: - operationId: genderJapaneseNamePinyin + operationId: japaneseNameLatinCandidates parameters: - explode: false in: path - name: japaneseSurname + name: japaneseSurnameKanji required: true schema: type: string style: simple - explode: false in: path - name: japaneseGivenName + name: japaneseGivenNameKanji required: true schema: type: string @@ -2975,33 +3140,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FirstLastNameGenderedOut' - description: A genderized name. + $ref: '#/components/schemas/NameMatchCandidatesOut' + description: A romanized name. "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: Infer the likely gender of a Japanese name in LATIN (Pinyin). + summary: "Romanize japanese name, based on the name in Kanji." tags: - japanese x-accepts: application/json - /api2/json/genderJapaneseNameBatch: + /api2/json/japaneseNameKanjiCandidatesBatch: post: - operationId: genderJapaneseNamePinyinBatch + operationId: japaneseNameKanjiCandidatesBatch requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchFirstLastNameIn' - description: "A list of names, with country code." + description: "A list of personal japanese names in LATIN, firstName = japaneseGivenName;\ + \ lastName=japaneseSurname" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/BatchFirstLastNameGenderedOut' + $ref: '#/components/schemas/BatchNameMatchCandidatesOut' description: A list of genderized names. "401": description: Missing or incorrect API Key @@ -3011,54 +3177,61 @@ paths: description: Bad request (ex. too many names) security: - api_key: [] - summary: Infer the likely gender of up to 100 Japanese names in LATIN (Pinyin). + summary: "Identify japanese name candidates in KANJI, based on the romanized\ + \ name (firstName = japaneseGivenName; lastName=japaneseSurname), ex. Yamamoto\ + \ Sanae" tags: - japanese x-content-type: application/json x-accepts: application/json - /api2/json/genderJapaneseNameFull/{japaneseName}: - get: - operationId: genderJapaneseNameFull - parameters: - - explode: false - in: path - name: japaneseName - required: true - schema: - type: string - style: simple + /api2/json/japaneseNameGenderKanjiCandidatesBatch: + post: + operationId: japaneseNameGenderKanjiCandidatesBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchFirstLastNameGenderIn' + description: "A list of personal japanese names in LATIN, firstName = japaneseGivenName;\ + \ lastName=japaneseSurname and known gender" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/PersonalNameGenderedOut' - description: A genderized name. + $ref: '#/components/schemas/BatchNameMatchCandidatesOut' + description: A list of genderized names. "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" + "400": + description: Bad request (ex. too many names) security: - api_key: [] - summary: Infer the likely gender of a Japanese full name ex. 王晓明 + summary: "Identify japanese name candidates in KANJI, based on the romanized\ + \ name (firstName = japaneseGivenName; lastName=japaneseSurname) with KNOWN\ + \ gender, ex. Yamamoto Sanae" tags: - japanese + x-content-type: application/json x-accepts: application/json - /api2/json/genderJapaneseNameFullBatch: + /api2/json/japaneseNameLatinCandidatesBatch: post: - operationId: genderJapaneseNameFullBatch + operationId: japaneseNameLatinCandidatesBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchPersonalNameIn' - description: A list of personal names + $ref: '#/components/schemas/BatchFirstLastNameIn' + description: "A list of personal japanese names in KANJI, firstName = japaneseGivenName;\ + \ lastName=japaneseSurname" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/BatchPersonalNameGenderedOut' + $ref: '#/components/schemas/BatchNameMatchCandidatesOut' description: A list of genderized names. "401": description: Missing or incorrect API Key @@ -3068,32 +3241,32 @@ paths: description: Bad request (ex. too many names) security: - api_key: [] - summary: Infer the likely gender of up to 100 full names + summary: "Romanize japanese names, based on the name in KANJI" tags: - japanese x-content-type: application/json x-accepts: application/json - /api2/json/phoneCode/{firstName}/{lastName}/{phoneNumber}: + /api2/json/japaneseNameMatch/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName}: get: - operationId: phoneCode + operationId: japaneseNameMatch parameters: - explode: false in: path - name: firstName + name: japaneseSurnameLatin required: true schema: type: string style: simple - explode: false in: path - name: lastName + name: japaneseGivenNameLatin required: true schema: type: string style: simple - explode: false in: path - name: phoneNumber + name: japaneseName required: true schema: type: string @@ -3103,17 +3276,255 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FirstLastNamePhoneCodedOut' - description: A name with country and phone code. + $ref: '#/components/schemas/NameMatchedOut' + description: A romanized name. "401": description: Missing or incorrect API Key "403": description: "Email not Verified, or API Limit Reached, or API Key Disabled" security: - api_key: [] - summary: "[USES 11 UNITS PER NAME] Infer the likely country and phone prefix,\ - \ given a personal name and formatted / unformatted phone number." - tags: + summary: Return a score for matching Japanese name in KANJI ex. 山本 早苗 with a + romanized name ex. Yamamoto Sanae + tags: + - japanese + x-accepts: application/json + /api2/json/japaneseNameMatchFeedbackLoop/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName}: + get: + operationId: japaneseNameMatchFeedbackLoop + parameters: + - explode: false + in: path + name: japaneseSurnameLatin + required: true + schema: + type: string + style: simple + - explode: false + in: path + name: japaneseGivenNameLatin + required: true + schema: + type: string + style: simple + - explode: false + in: path + name: japaneseName + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/FeedbackLoopOut' + description: A romanized name. + "401": + description: Missing or incorrect API Key + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + security: + - api_key: [] + summary: "[CREDITS 1 UNIT] Feedback loop to better perform matching Japanese\ + \ name in KANJI ex. 山本 早苗 with a romanized name ex. Yamamoto Sanae" + tags: + - japanese + x-accepts: application/json + /api2/json/japaneseNameMatchBatch: + post: + operationId: japaneseNameMatchBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchMatchPersonalFirstLastNameIn' + description: "A list of personal Japanese names in LATIN, firstName = japaneseGivenName;\ + \ lastName=japaneseSurname" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/BatchNameMatchedOut' + description: A list of matched names. + "401": + description: Missing or incorrect API Key + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + "400": + description: Bad request (ex. too many names) + security: + - api_key: [] + summary: Return a score for matching a list of Japanese names in KANJI ex. 山本 + 早苗 with romanized names ex. Yamamoto Sanae + tags: + - japanese + x-content-type: application/json + x-accepts: application/json + /api2/json/genderJapaneseName/{japaneseSurname}/{japaneseGivenName}: + get: + operationId: genderJapaneseNamePinyin + parameters: + - explode: false + in: path + name: japaneseSurname + required: true + schema: + type: string + style: simple + - explode: false + in: path + name: japaneseGivenName + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/FirstLastNameGenderedOut' + description: A genderized name. + "401": + description: Missing or incorrect API Key + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + security: + - api_key: [] + summary: Infer the likely gender of a Japanese name in LATIN (Pinyin). + tags: + - japanese + x-accepts: application/json + /api2/json/genderJapaneseNameBatch: + post: + operationId: genderJapaneseNamePinyinBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchFirstLastNameIn' + description: "A list of names, with country code." + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/BatchFirstLastNameGenderedOut' + description: A list of genderized names. + "401": + description: Missing or incorrect API Key + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + "400": + description: Bad request (ex. too many names) + security: + - api_key: [] + summary: Infer the likely gender of up to 100 Japanese names in LATIN (Pinyin). + tags: + - japanese + x-content-type: application/json + x-accepts: application/json + /api2/json/genderJapaneseNameFull/{japaneseName}: + get: + operationId: genderJapaneseNameFull + parameters: + - explode: false + in: path + name: japaneseName + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PersonalNameGenderedOut' + description: A genderized name. + "401": + description: Missing or incorrect API Key + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + security: + - api_key: [] + summary: Infer the likely gender of a Japanese full name ex. 王晓明 + tags: + - japanese + x-accepts: application/json + /api2/json/genderJapaneseNameFullBatch: + post: + operationId: genderJapaneseNameFullBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchPersonalNameIn' + description: A list of personal names + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/BatchPersonalNameGenderedOut' + description: A list of genderized names. + "401": + description: Missing or incorrect API Key + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + "400": + description: Bad request (ex. too many names) + security: + - api_key: [] + summary: Infer the likely gender of up to 100 full names + tags: + - japanese + x-content-type: application/json + x-accepts: application/json + /api2/json/phoneCode/{firstName}/{lastName}/{phoneNumber}: + get: + operationId: phoneCode + parameters: + - explode: false + in: path + name: firstName + required: true + schema: + type: string + style: simple + - explode: false + in: path + name: lastName + required: true + schema: + type: string + style: simple + - explode: false + in: path + name: phoneNumber + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/FirstLastNamePhoneCodedOut' + description: A name with country and phone code. + "401": + description: Missing or incorrect API Key + "403": + description: "Email not Verified, or API Limit Reached, or API Key Disabled" + security: + - api_key: [] + summary: "[USES 11 UNITS PER NAME] Infer the likely country and phone prefix,\ + \ given a personal name and formatted / unformatted phone number." + tags: - social x-accepts: application/json /api2/json/phoneCodeGeo/{firstName}/{lastName}/{phoneNumber}/{countryIso2}: @@ -3462,45 +3873,9 @@ components: type: object xml: name: BatchFirstLastNameCasteOut - BatchPersonalNameCastegroupOut: - example: - personalNames: - - castegroup: castegroup - castegroupTop: - - castegroupTop - - castegroupTop - score: 8.008281904610115 - probabilityCalibrated: 0.20549123661408064 - name: name - probabilityAltCalibrated: -0.706837403899411 - id: id - explanation: explanation - castegroupAlt: castegroupAlt - script: script - - castegroup: castegroup - castegroupTop: - - castegroupTop - - castegroupTop - score: 8.008281904610115 - probabilityCalibrated: 0.20549123661408064 - name: name - probabilityAltCalibrated: -0.706837403899411 - id: id - explanation: explanation - castegroupAlt: castegroupAlt - script: script - properties: - personalNames: - description: Caste group-coded names - items: - $ref: '#/components/schemas/PersonalNameCastegroupOut' - type: array - type: object - xml: - name: BatchPersonalNameCastegroupOut - FirstLastNameCastegroupOut: - description: Represents the output of inferring the LIKELY caste group from - a personal Hindu/Indian name. + FirstLastNameCastegroupOut: + description: Represents the output of inferring the LIKELY caste group from + a personal Hindu/Indian name. example: castegroup: castegroup castegroupTop: @@ -3589,65 +3964,6 @@ components: type: object xml: name: FirstLastNamePhoneNumberIn - APICounterV2Out: - description: Detailed usage as reported by the deduplicating API counter. - example: - apiKey: - striped: true - apiKey: apiKey - partner: true - corporate: true - anonymized: true - learnable: true - ipAddress: ipAddress - admin: true - disabled: true - userId: userId - explainable: true - vetted: true - serviceFeaturesUsage: - key: 5 - apiService: apiService - createdDateTime: 0 - lastFlushedDateTime: 1 - totalUsage: 6 - hostAddress: hostAddress - lastUsedDateTime: 5 - properties: - apiKey: - $ref: '#/components/schemas/APIKeyOut' - apiService: - description: The apiService corresponds to the classifier name. - type: string - hostAddress: - description: The processing hostAddress. - type: string - createdDateTime: - description: The create datetime of the counter. - format: int64 - type: integer - totalUsage: - description: The usage of the counter. - format: int64 - type: integer - lastFlushedDateTime: - description: The flush datetime of the counter. - format: int64 - type: integer - lastUsedDateTime: - description: The last usage datetime of the counter. - format: int64 - type: integer - serviceFeaturesUsage: - additionalProperties: - description: "Usage of special features, such as Chinese, Japanese." - format: int64 - type: integer - description: "Usage of special features, such as Chinese, Japanese." - type: object - type: object - xml: - name: APICallStatOut FirstLastNameSubdivisionIn: example: firstName: firstName @@ -3674,48 +3990,6 @@ components: type: object xml: name: FirstLastNameGeoSubdivisionIn - NameMatchCandidatesOut: - description: Classified matched names - example: - firstName: firstName - lastName: lastName - orderOption: orderOption - matchCandidates: - - predScoreGivenName: 6.027456183070403 - candidateName: candidateName - probability: 0.8008281904610115 - predScoreFamilyName: 1.4658129805029452 - - predScoreGivenName: 6.027456183070403 - candidateName: candidateName - probability: 0.8008281904610115 - predScoreFamilyName: 1.4658129805029452 - id: id - explanation: explanation - script: script - properties: - script: - type: string - id: - type: string - explanation: - type: string - firstName: - description: The first name (also known as given name) - type: string - lastName: - description: "The last name (also known as family name, or surname)" - type: string - orderOption: - description: The option for ordering - type: string - matchCandidates: - description: The ordered list of name matching candidates - items: - $ref: '#/components/schemas/NameMatchCandidateOut' - type: array - type: object - xml: - name: NameMatchCandidatesOut SoftwareVersionOut: description: The software version. example: @@ -3767,211 +4041,169 @@ components: type: object xml: name: APIClassifierOut - NameIn: + CommunityEngageOut: + description: "Represent multiple classifications for community engagement (gender,\ + \ country, origin, diaspora)" example: - name: name + prime: true + country: + country: country + topRegion: topRegion + subRegion: subRegion + probabilityCalibrated: 0.20549123661408064 + countryAlt: countryAlt + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + countriesTop: + - countriesTop + - countriesTop + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + region: region + gender: + genderScale: -0.8398343619077977 + score: 60.27456183070403 + probabilityCalibrated: -0.706837403899411 + name: name + likelyGender: male + id: id + explanation: explanation + script: script + scoped: true + PersonalNameUSRaceEthnicityOut: + raceEthnicityAlt: W_NL + score: 8.008281904610115 + raceEthnicitiesTop: + - raceEthnicitiesTop + - raceEthnicitiesTop + probabilityCalibrated: 0.20549123661408064 + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + explanation: explanation + script: script + raceEthnicity: W_NL + PersonalNameDiasporaedOut: + probabilityCalibrated: 0.20549123661408064 + ethnicity: Chinese + lifted: true + ethnicityAlt: Japanese + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + countryIso2: countryIso2 + ethnicitiesTop: + - ethnicitiesTop + - ethnicitiesTop id: id + PersonalNameOriginedOut: + probabilityCalibrated: 0.20549123661408064 + religionStatsSynthetic: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + explanation: explanation + script: script + regionOrigin: regionOrigin + topRegionOrigin: topRegionOrigin + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + subRegionOrigin: subRegionOrigin + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + countriesOriginTop: + - countriesOriginTop + - countriesOriginTop + id: id + countryOrigin: countryOrigin + countryOriginAlt: countryOriginAlt + script: script properties: id: type: string xml: attribute: true - name: + PersonalNameDiasporaedOut: + $ref: '#/components/schemas/PersonalNameDiasporaedOut' + PersonalNameOriginedOut: + $ref: '#/components/schemas/PersonalNameOriginedOut' + country: + $ref: '#/components/schemas/PersonalNameGeoOut' + gender: + $ref: '#/components/schemas/PersonalNameGenderedOut' + PersonalNameUSRaceEthnicityOut: + $ref: '#/components/schemas/PersonalNameUSRaceEthnicityOut' + prime: + type: boolean + scoped: + type: boolean + script: type: string - xml: - attribute: true type: object xml: - name: NameIn - PersonalNameSubdivisionIn: + name: CommunityEngageOut + FirstLastNameGenderIn: example: - subdivisionIso: subdivisionIso - name: name + firstName: firstName + lastName: lastName + gender: gender id: id properties: id: type: string xml: attribute: true - name: + firstName: type: string xml: attribute: true - subdivisionIso: - type: string - xml: - attribute: true - type: object - xml: - name: PersonalNameSubdivisionIn - BatchPersonalNameSubdivisionIn: - example: - personalNames: - - subdivisionIso: subdivisionIso - name: name - id: id - - subdivisionIso: subdivisionIso - name: name - id: id - properties: - personalNames: - items: - $ref: '#/components/schemas/PersonalNameSubdivisionIn' - type: array - type: object - xml: - name: BatchPersonalNameSubdivisionIn - APIPlanSubscriptionOut: - description: The API Plan governing the subscription. - example: - stripeStatus: stripeStatus - planBaseFeesKey: planBaseFeesKey - planQuota: 5 - apiKey: apiKey - priceUSD: 2.3021358869347655 - priceOverageUSD: 7.061401241503109 - planStarted: 0 - planName: planName - planStatus: planStatus - priceOverage: 3.616076749251911 - userId: userId - planEnded: 1 - taxRate: 5.962133916683182 - price: 9.301444243932576 - currency: currency - currencyFactor: 2.027123023002322 - stripeSubscription: stripeSubscription - stripeCustomerId: stripeCustomerId - priorPlanStarted: 6 - properties: - apiKey: - description: User API Key. - type: string - planStarted: - description: Datetime when the user subscribed to the current plan. - format: int64 - type: integer - priorPlanStarted: - description: Datetime when the user subscribed to the prior plan. - format: int64 - type: integer - planEnded: - description: Datetime when the user ended the plan. - format: int64 - type: integer - taxRate: - description: Applicable tax rate for the plan. - format: double - type: number - planName: - description: Current plan name. - type: string - planBaseFeesKey: - description: Current plan key (as in Stripe product). - type: string - planStatus: - description: Plan status. - type: string - planQuota: - description: "Current plan quota in quantity of units (NB: some API use\ - \ several units per name)." - format: int64 - type: integer - priceUSD: - description: Current plan monthly price expressed in USD (includes a free - quota). - format: double - type: number - priceOverageUSD: - description: Current plan price for overages expressed in USD (extra price - per unit above the free quota). - format: double - type: number - price: - description: Current plan price for overages expressed in Currency (extra - price per unit above the free quota). - format: double - type: number - priceOverage: - description: Current plan price for overages expressed in Currency (extra - price per unit above the free quota). - format: double - type: number - currency: - description: Current plan Currency for prices. - type: string - currencyFactor: - description: "For USD, GBP, EUR - the factor is 1." - format: double - type: number - stripeCustomerId: - description: Stripe customer identifier. - type: string - stripeStatus: - description: Stripe status ex active. - type: string - stripeSubscription: - description: Stripe subscription identifier. - type: string - userId: - description: Internal user identifier. - type: string - type: object - xml: - name: APIPlanSubscriptionOut - FirstLastNameGenderIn: - example: - firstName: firstName - lastName: lastName - gender: gender - id: id - properties: - id: - type: string - xml: - attribute: true - firstName: - type: string - xml: - attribute: true - lastName: - type: string - xml: - attribute: true - gender: - description: The known gender of the name + lastName: + type: string + xml: + attribute: true + gender: + description: The known gender of the name type: string xml: attribute: true type: object xml: name: FirstLastName - FirstLastNameGeoIn: - example: - firstName: firstName - lastName: lastName - id: id - countryIso2: countryIso2 - properties: - id: - type: string - xml: - attribute: true - firstName: - type: string - xml: - attribute: true - lastName: - type: string - xml: - attribute: true - countryIso2: - type: string - xml: - attribute: true - type: object - xml: - name: FirstLastNameGeoIn FirstLastNameGenderedOut: description: Represents the output of inferring the LIKELY gender from a personal name. @@ -4029,129 +4261,41 @@ components: type: object xml: name: FirstLastNameGenderedOut - BatchFirstLastNameReligionedOut: - description: Represents the output of inferring the LIKELY religion from a list - of personal names. - example: - personalNames: - - firstName: firstName - lastName: lastName - religionAlt: religionAlt - score: 8.008281904610115 - probabilityCalibrated: 0.20549123661408064 - probabilityAltCalibrated: -0.706837403899411 - id: id - religionsTop: - - religionsTop - - religionsTop - explanation: explanation - script: script - religion: religion - - firstName: firstName - lastName: lastName - religionAlt: religionAlt - score: 8.008281904610115 - probabilityCalibrated: 0.20549123661408064 - probabilityAltCalibrated: -0.706837403899411 - id: id - religionsTop: - - religionsTop - - religionsTop - explanation: explanation - script: script - religion: religion - properties: - personalNames: - description: Classified names - items: - $ref: '#/components/schemas/FirstLastNameReligionedOut' - type: array - type: object - xml: - name: BatchFirstLastNameReligionedOut - PersonalNameCastegroupOut: - description: Caste group-coded names + APIKeyOut: example: - castegroup: castegroup - castegroupTop: - - castegroupTop - - castegroupTop - score: 8.008281904610115 - probabilityCalibrated: 0.20549123661408064 - name: name - probabilityAltCalibrated: -0.706837403899411 - id: id - explanation: explanation - castegroupAlt: castegroupAlt - script: script + striped: true + apiKey: apiKey + anonymized: true + learnable: true + ipAddress: ipAddress + admin: true + communityEngageOption: + genderFilter: + - genderFilter + - genderFilter + ethnicityFilter: + - ethnicityFilter + - ethnicityFilter + countryOutFilter: + - countryOutFilter + - countryOutFilter + usRaceEthnicityFilter: + - usRaceEthnicityFilter + - usRaceEthnicityFilter + userId: userId + explainable: true + vetted: true + partner: true + corporate: true + disabled: true properties: - script: - type: string - id: - type: string - explanation: + apiKey: + description: The user API Key. type: string - name: - description: The input name. - type: string - score: - description: "Higher score is better, but score is not normalized. Use calibratedProbability\ - \ if available. " - format: double - maximum: 100 - minimum: 0 - type: number - castegroup: - description: Most likely caste group - type: string - castegroupAlt: - description: "Second best alternative : caste group " - type: string - castegroupTop: - description: List caste group (top 10) - items: - description: List caste group (top 10) - type: string - type: array - probabilityCalibrated: - description: 'The calibrated probability for country to have been guessed - correctly. -1 = still calibrating. ' - format: double - maximum: 1 - minimum: -1 - type: number - probabilityAltCalibrated: - description: 'The calibrated probability for country OR countryAlt to have - been guessed correctly. -1 = still calibrating. ' - format: double - maximum: 1 - minimum: -1 - type: number - type: object - xml: - name: PersonalNameCastegroupOut - APIKeyOut: - example: - striped: true - apiKey: apiKey - partner: true - corporate: true - anonymized: true - learnable: true - ipAddress: ipAddress - admin: true - disabled: true - userId: userId - explainable: true - vetted: true - properties: - apiKey: - description: The user API Key. - type: string - xml: - name: api_key - userId: - description: The user identifier. + xml: + name: api_key + userId: + description: The user identifier. type: string admin: description: The API Key has admin role. @@ -4188,6 +4332,8 @@ components: type: boolean ipAddress: type: string + communityEngageOption: + $ref: '#/components/schemas/CommunityEngageOptionOut' type: object xml: name: APIKeyOut @@ -4317,35 +4463,6 @@ components: type: object xml: name: BatchPersonalNameGeoOut - APIClassifiersStatusOut: - example: - classifiers: - - probabilityCalibrated: true - shuttingDown: true - learning: true - classifierName: classifierName - serving: true - - probabilityCalibrated: true - shuttingDown: true - learning: true - classifierName: classifierName - serving: true - softwareVersion: - softwareNameAndVersion: softwareNameAndVersion - softwareVersion: - - 0 - - 0 - properties: - softwareVersion: - $ref: '#/components/schemas/SoftwareVersionOut' - classifiers: - description: The list of classifiers and versions. - items: - $ref: '#/components/schemas/APIClassifierOut' - type: array - type: object - xml: - name: APIClassifiersStatusOut BatchFirstLastNameCastegroupOut: description: Represents the output of inferring the LIKELY origin from a list of personal names. @@ -4441,7 +4558,7 @@ components: explanation: type: string name: - description: The input name + description: The input name. type: string likelyGender: description: Most likely gender @@ -4569,50 +4686,13 @@ components: $ref: '#/components/schemas/ReligionStatOut' type: array religionStatsAlt: - description: "Geographic religious statistics, assuming country of origin\ - \ OR best alternative is correctly predicted." + description: "Geographic religious statistics, for origin best alternative." items: $ref: '#/components/schemas/ReligionStatOut' type: array type: object xml: name: FirstLastNameOriginedOut - BatchNameGeoIn: - example: - properNouns: - - name: name - id: id - countryIso2: countryIso2 - - name: name - id: id - countryIso2: countryIso2 - properties: - properNouns: - items: - $ref: '#/components/schemas/NameGeoIn' - type: array - type: object - xml: - name: BatchNameGeoIn - BatchFirstLastNameGenderIn: - example: - personalNames: - - firstName: firstName - lastName: lastName - gender: gender - id: id - - firstName: firstName - lastName: lastName - gender: gender - id: id - properties: - personalNames: - items: - $ref: '#/components/schemas/FirstLastNameGenderIn' - type: array - type: object - xml: - name: BatchFirstLastNameGenderIn RegionISO: description: List of countries and regions example: @@ -4791,335 +4871,90 @@ components: type: object xml: name: BatchNameMatchCandidatesOut - BatchPersonalNameParsedOut: + BatchPersonalNameGenderedOut: example: personalNames: - - score: 8.008281904610115 - firstLastName: - firstName: firstName - lastName: lastName - id: id - explanation: explanation - script: script + - genderScale: -0.8398343619077977 + score: 60.27456183070403 + probabilityCalibrated: -0.706837403899411 name: name + likelyGender: male id: id explanation: explanation script: script - nameParserTypeAlt: FN1LN1 - nameParserType: FN1LN1 - - score: 8.008281904610115 - firstLastName: - firstName: firstName - lastName: lastName - id: id - explanation: explanation - script: script + - genderScale: -0.8398343619077977 + score: 60.27456183070403 + probabilityCalibrated: -0.706837403899411 name: name + likelyGender: male id: id explanation: explanation script: script - nameParserTypeAlt: FN1LN1 - nameParserType: FN1LN1 properties: personalNames: - description: Classified parsed names + description: Classified genderized names items: - $ref: '#/components/schemas/PersonalNameParsedOut' + $ref: '#/components/schemas/PersonalNameGenderedOut' type: array type: object xml: - name: BatchPersonalNameParsedOut - FirstLastNameDiasporaedOut: - description: "Represents the output of inferring the LIKELY ethnicity from a\ - \ personal name, given an country of residence." + name: BatchPersonalNameGenderedOut + FeedbackLoopOut: example: - lastName: lastName - probabilityCalibrated: 0.12747533132666566 - ethnicity: Chinese - lifted: true - ethnicityAlt: Japanese - explanation: explanation - script: script - religionStats: - - pct: 5.962133916683182 - religion: religion - - pct: 5.962133916683182 - religion: religion - firstName: firstName - score: 59.621339166831824 - religionStatsAlt: - - pct: 5.962133916683182 - religion: religion - - pct: 5.962133916683182 - religion: religion - probabilityAltCalibrated: -0.539572822613047 - id: id - countryIso2: countryIso2 - ethnicitiesTop: - - ethnicitiesTop - - ethnicitiesTop + feedbackCredits: 0 properties: - script: - type: string - id: - type: string - explanation: - type: string - firstName: - description: The first name (also known as given name) - type: string - lastName: - description: "The last name (also known as family name, or surname)" - type: string - score: - description: "Compatibility to NamSor_v1 Diaspora score value. Higher score\ - \ is better, but score is not normalized. Use calibratedProbability if\ - \ available. " - format: double - maximum: 100 - minimum: 0 - type: number - ethnicityAlt: - description: The second best alternative ethnicity - example: Japanese - type: string - xml: - attribute: true - ethnicity: - description: The most likely ethnicity - example: Chinese - type: string - xml: - attribute: true - lifted: - description: "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." - type: boolean - xml: - attribute: true - countryIso2: - description: "From input data, the countryIso2 of geographic context (US,CA\ - \ etc.)" - type: string - xml: - attribute: true - ethnicitiesTop: - description: List most likely ethnicities (top 10) - items: - description: List most likely ethnicities (top 10) - type: string - type: array - probabilityCalibrated: - description: 'The calibrated probability for ethnicity to have been guessed - correctly. -1 = still calibrating. ' - format: double - maximum: 1 - minimum: -1 - type: number - probabilityAltCalibrated: - description: 'The calibrated probability for ethnicity OR ethnicityAlt to - have been guessed correctly. -1 = still calibrating. ' - format: double - maximum: 1 - minimum: -1 - type: number - religionStats: - description: "Geographic religious statistics, assuming ethnicity is correctly\ - \ predicted." - items: - $ref: '#/components/schemas/ReligionStatOut' - type: array - religionStatsAlt: - description: "Geographic religious statistics, assuming ethnicity OR best\ - \ alternative is correctly predicted." - items: - $ref: '#/components/schemas/ReligionStatOut' - type: array - type: object - xml: - name: FirstLastNameDiasporaedOut - BatchPersonalNameReligionedOut: - example: - personalNames: - - score: 8.008281904610115 - religionAlt: religionAlt - probabilityCalibrated: 0.20549123661408064 - name: name - probabilityAltCalibrated: -0.706837403899411 - id: id - religionsTop: - - religionsTop - - religionsTop - explanation: explanation - script: script - religion: religion - - score: 8.008281904610115 - religionAlt: religionAlt - probabilityCalibrated: 0.20549123661408064 - name: name - probabilityAltCalibrated: -0.706837403899411 - id: id - religionsTop: - - religionsTop - - religionsTop - explanation: explanation - script: script - religion: religion - properties: - personalNames: - description: religious-coded names - items: - $ref: '#/components/schemas/PersonalNameReligionedOut' - type: array - type: object - xml: - name: BatchPersonalNameReligionedOut - BatchPersonalNameGenderedOut: - example: - personalNames: - - genderScale: -0.8398343619077977 - score: 60.27456183070403 - probabilityCalibrated: -0.706837403899411 - name: name - likelyGender: male - id: id - explanation: explanation - script: script - - genderScale: -0.8398343619077977 - score: 60.27456183070403 - probabilityCalibrated: -0.706837403899411 - name: name - likelyGender: male - id: id - explanation: explanation - script: script - properties: - personalNames: - description: Classified genderized names - items: - $ref: '#/components/schemas/PersonalNameGenderedOut' - type: array - type: object - xml: - name: BatchPersonalNameGenderedOut - FeedbackLoopOut: - example: - feedbackCredits: 0 - properties: - feedbackCredits: - description: Number of units recredited as per feedback loop successful - classification - format: int64 - type: integer - type: object - xml: - name: FeedbackLoopOut - APIBillingPeriodUsageOut: - description: The current billing period. - example: - apiKey: apiKey - periodStarted: 7 - stripeCurrentPeriodEnd: 1 - usage: 6 - hardLimit: 1 - subscriptionStarted: 4 - periodEnded: 1 - billingStatus: billingStatus - stripeCurrentPeriodStart: 1 - softLimit: 7 - properties: - apiKey: - description: User API Key. - type: string - subscriptionStarted: - description: Datetime when the user subscribed to the plan. - format: int64 - type: integer - periodStarted: - description: Datetime when the the plan's current period started. - format: int64 - type: integer - periodEnded: - description: Datetime when the the plan's current period endend. - format: int64 - type: integer - stripeCurrentPeriodEnd: - description: Datetime when the the plan's current period endend (in Stripe). - Internal and Stripe periodicity should ~coincide. - format: int64 - type: integer - stripeCurrentPeriodStart: - description: Datetime when the the plan's current period started (in Stripe). - Internal and Stripe periodicity should ~coincide. - format: int64 - type: integer - billingStatus: - description: Current period billing status ex OPEN. - type: string - usage: - description: Current period usage in units (NB some API endpoints use more - than one unit). - format: int64 - type: integer - softLimit: - description: Current period soft limit (reaching the limit sends an email - notification). - format: int64 - type: integer - hardLimit: - description: Current period hard limit (reaching the limit sends an email - notification and blocks the API Key). - format: int64 - type: integer - type: object - xml: - name: APIBillingPeriodUsageOut - APIPeriodUsageOut: - example: - overageInclTax: 5.025004791520295 - overageQuantity: 9 - billingPeriod: - apiKey: apiKey - periodStarted: 7 - stripeCurrentPeriodEnd: 1 - usage: 6 - hardLimit: 1 - subscriptionStarted: 4 - periodEnded: 1 - billingStatus: billingStatus - stripeCurrentPeriodStart: 1 - softLimit: 7 - overageCurrency: overageCurrency - subscription: - stripeStatus: stripeStatus - planBaseFeesKey: planBaseFeesKey - planQuota: 5 - apiKey: apiKey - priceUSD: 2.3021358869347655 - priceOverageUSD: 7.061401241503109 - planStarted: 0 - planName: planName - planStatus: planStatus - priceOverage: 3.616076749251911 - userId: userId - planEnded: 1 - taxRate: 5.962133916683182 - price: 9.301444243932576 - currency: currency - currencyFactor: 2.027123023002322 - stripeSubscription: stripeSubscription - stripeCustomerId: stripeCustomerId - priorPlanStarted: 6 - overageExclTax: 4.965218492984954 - properties: - subscription: - $ref: '#/components/schemas/APIPlanSubscriptionOut' - billingPeriod: - $ref: '#/components/schemas/APIBillingPeriodUsageOut' - overageExclTax: - description: Overage amount including any tax. + feedbackCredits: + description: Number of units recredited as per feedback loop successful + classification + format: int64 + type: integer + type: object + xml: + name: FeedbackLoopOut + APIPeriodUsageOut: + example: + overageInclTax: 5.025004791520295 + overageQuantity: 9 + billingPeriod: + apiKey: apiKey + periodStarted: 7 + stripeCurrentPeriodEnd: 1 + usage: 6 + hardLimit: 1 + subscriptionStarted: 4 + periodEnded: 1 + billingStatus: billingStatus + stripeCurrentPeriodStart: 1 + softLimit: 7 + overageCurrency: overageCurrency + subscription: + stripeStatus: stripeStatus + planBaseFeesKey: planBaseFeesKey + planQuota: 5 + apiKey: apiKey + priceUSD: 2.3021358869347655 + priceOverageUSD: 7.061401241503109 + planStarted: 0 + planName: planName + planStatus: planStatus + priceOverage: 3.616076749251911 + userId: userId + planEnded: 1 + taxRate: 5.962133916683182 + price: 9.301444243932576 + currency: currency + currencyFactor: 2.027123023002322 + stripeSubscription: stripeSubscription + stripeCustomerId: stripeCustomerId + priorPlanStarted: 6 + overageExclTax: 4.965218492984954 + properties: + subscription: + $ref: '#/components/schemas/APIPlanSubscriptionOut' + billingPeriod: + $ref: '#/components/schemas/APIBillingPeriodUsageOut' + overageExclTax: + description: Overage amount including any tax. format: double type: number overageInclTax: @@ -5137,22 +4972,6 @@ components: type: object xml: name: APICurrentUsageOut - PersonalNameIn: - example: - name: name - id: id - properties: - id: - type: string - xml: - attribute: true - name: - type: string - xml: - attribute: true - type: object - xml: - name: PersonalNameIn BatchFirstLastNameGeoSubdivisionIn: example: personalNames: @@ -5238,109 +5057,36 @@ components: type: object xml: name: FirstLastNameGeoSubdivisionIn - APIUsageAggregatedOut: - example: - rowHeaders: - - rowHeaders - - rowHeaders - data: - - - 5 - - 5 - - - 5 - - 5 - historyTruncated: true - colHeaders: - - colHeaders - - colHeaders - totalUsage: 1 - periodStart: 0 - timeUnit: timeUnit - periodEnd: 6 - properties: - timeUnit: - description: "Time unit is DAY, WEEK or MONTH depending on prior usage" - type: string - periodStart: - description: Start datetime of the reporting period - format: int64 - type: integer - periodEnd: - description: End datetime of the reporting period - format: int64 - type: integer - totalUsage: - description: Total usage in the current period - format: int64 - type: integer - historyTruncated: - description: If the history was truncaded due to data limit - type: boolean - data: - description: "Data points : usage per DAY, WEEK or MONTH and per apiService" - items: - description: "Data points : usage per DAY, WEEK or MONTH and per apiService" - items: - description: "Data points : usage per DAY, WEEK or MONTH and per apiService" - format: int32 - type: integer - type: array - type: array - colHeaders: - description: 'apiServices as column headers ' - items: - description: 'apiServices as column headers ' - type: string - type: array - rowHeaders: - description: 'dates as row headers ' - items: - description: 'dates as row headers ' - type: string - type: array - type: object - xml: - name: APIUsageAggregatedOut - APIServicesOut: - example: - apiServices: - - costInUnits: 0 - serviceGroup: serviceGroup - serviceName: serviceName - - costInUnits: 0 - serviceGroup: serviceGroup - serviceName: serviceName - properties: - apiServices: - description: List of API Services - items: - $ref: '#/components/schemas/APIServiceOut' - type: array - type: object - xml: - name: APIServicesOut - BatchNameIn: - example: - properNouns: - - name: name - id: id - - name: name - id: id - properties: - properNouns: - items: - $ref: '#/components/schemas/NameIn' - type: array - type: object - xml: - name: BatchNameIn - FirstLastNameOut: - description: First / last name structure corresponding to the most likely parsing. + FirstLastNameGeoOut: + description: Represents the output of inferring the LIKELY country of Origin + from a personal name. example: - firstName: firstName lastName: lastName - id: id + country: country + topRegion: topRegion + subRegion: subRegion + probabilityCalibrated: 0.20549123661408064 + countryAlt: countryAlt explanation: explanation script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + firstName: firstName + score: 8.008281904610115 + countriesTop: + - countriesTop + - countriesTop + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + probabilityAltCalibrated: -0.706837403899411 + id: id + region: region properties: script: type: string @@ -5354,188 +5100,77 @@ components: lastName: description: "The last name (also known as family name, or surname)" type: string - type: object - xml: - name: FirstLastNameOut - PersonalNameGeoSubclassificationOut: - description: Classified names at sub country level (region or state) - example: - score: 8.008281904610115 - probabilityCalibrated: 0.20549123661408064 - subclassificationTop: - - subclassificationTop - - subclassificationTop - name: name - probabilityAltCalibrated: -0.706837403899411 - id: id - countryIso2: countryIso2 - explanation: explanation - script: script - subClassification: subClassification - subClassificationAlt: subClassificationAlt - properties: - script: - type: string - id: - type: string - explanation: + score: + description: "Higher score is better, but score is not normalized. Use calibratedProbability\ + \ if available. " + format: double + maximum: 100 + minimum: 0 + type: number + country: + description: 'Most likely country ' type: string - name: - description: The input name + countryAlt: + description: "Second best alternative : country " type: string - countryIso2: - description: The input country ISO2 code + region: + description: Most likely region (based on country ISO2 code) type: string - xml: - attribute: true - subClassification: - description: Most likely subclassification ISO_3166-2 code + topRegion: + description: Most likely top region (based on country ISO2 code) type: string - subClassificationAlt: - description: "Second best alternative : subclassification ISO_3166-2 code" + subRegion: + description: Most likely sub region (based on country ISO2 code) type: string - subclassificationTop: - description: List subclassification ISO_3166-2 codes (top 10) + countriesTop: + description: List countries (top 10) items: - description: List subclassification ISO_3166-2 codes (top 10) + description: List countries (top 10) type: string type: array - score: - description: "Compatibility to NamSor_v1 Origin score value. Higher score\ - \ is better, but score is not normalized. Use calibratedProbability if\ - \ available. " - format: double - maximum: 100 - minimum: 0 - type: number probabilityCalibrated: - description: 'The calibrated probability for subclassification to have been - guessed correctly. -1 = still calibrating. ' + description: 'The calibrated probability for country to have been guessed + correctly. -1 = still calibrating. ' format: double maximum: 1 minimum: -1 type: number probabilityAltCalibrated: - description: 'The calibrated probability for subclassification OR subclassificationAlt - to have been guessed correctly. -1 = still calibrating. ' + description: 'The calibrated probability for country OR countryAlt to have + been guessed correctly. -1 = still calibrating. ' format: double maximum: 1 minimum: -1 type: number + religionStats: + description: "Geographic religious statistics, assuming country is correctly\ + \ predicted." + items: + $ref: '#/components/schemas/ReligionStatOut' + type: array + religionStatsAlt: + description: "Geographic religious statistics, for country best alternative." + items: + $ref: '#/components/schemas/ReligionStatOut' + type: array type: object xml: - name: PersonalNameGeoSubclassificationOut - BatchFirstLastNameUSRaceEthnicityOut: - description: "Represents the output of inferring the LIKELY US 'race/ethnicity'\ - \ from a personal name, given US country of residence and (optionally) a ZIP5\ - \ code." + name: FirstLastNameGeoOut + PersonalNameParsedOut: example: - personalNames: - - firstName: firstName - lastName: lastName - raceEthnicityAlt: W_NL - score: 8.008281904610115 - raceEthnicitiesTop: - - raceEthnicitiesTop - - raceEthnicitiesTop - probabilityCalibrated: 0.20549123661408064 - probabilityAltCalibrated: -0.706837403899411 - id: id - explanation: explanation - script: script - raceEthnicity: W_NL - - firstName: firstName + score: 8.008281904610115 + firstLastName: + firstName: firstName lastName: lastName - raceEthnicityAlt: W_NL - score: 8.008281904610115 - raceEthnicitiesTop: - - raceEthnicitiesTop - - raceEthnicitiesTop - probabilityCalibrated: 0.20549123661408064 - probabilityAltCalibrated: -0.706837403899411 id: id explanation: explanation script: script - raceEthnicity: W_NL - properties: - personalNames: - description: Classified US 'race'/ethnicized names - items: - $ref: '#/components/schemas/FirstLastNameUSRaceEthnicityOut' - type: array - type: object - xml: - name: BatchFirstLastNameUSRaceEthnicityOut - BatchPersonalNameIn: - example: - personalNames: - - name: name - id: id - - name: name - id: id - properties: - personalNames: - items: - $ref: '#/components/schemas/PersonalNameIn' - type: array - type: object - xml: - name: BatchPersonalNameIn - BatchFirstLastNamePhoneNumberIn: - example: - personalNamesWithPhoneNumbers: - - firstName: firstName - lastName: lastName - phoneNumber: phoneNumber - id: id - - firstName: firstName - lastName: lastName - phoneNumber: phoneNumber - id: id - properties: - personalNamesWithPhoneNumbers: - items: - $ref: '#/components/schemas/FirstLastNamePhoneNumberIn' - type: array - type: object - xml: - name: BatchFirstLastNamePhoneNumberIn - NameGeoIn: - example: - name: name - id: id - countryIso2: countryIso2 - properties: - id: - type: string - xml: - attribute: true - name: - type: string - xml: - attribute: true - countryIso2: - type: string - xml: - attribute: true - type: object - xml: - name: NameGeoIn - PersonalNameReligionedOut: - description: religious-coded names - example: - score: 8.008281904610115 - religionAlt: religionAlt - probabilityCalibrated: 0.20549123661408064 - name: name - probabilityAltCalibrated: -0.706837403899411 - id: id - religionsTop: - - religionsTop - - religionsTop - explanation: explanation - script: script - religion: religion + name: name + id: id + explanation: explanation + script: script + nameParserTypeAlt: FN1LN1 + nameParserType: FN1LN1 properties: script: type: string @@ -5546,169 +5181,6 @@ components: name: description: The input name. type: string - score: - description: "Higher score is better, but score is not normalized. Use calibratedProbability\ - \ if available. " - format: double - maximum: 100 - minimum: 0 - type: number - religion: - description: Most likely religion - type: string - religionAlt: - description: "Second best alternative : religion " - type: string - religionsTop: - description: List countries (top 10) - items: - description: List countries (top 10) - type: string - type: array - probabilityCalibrated: - description: 'The calibrated probability for country to have been guessed - correctly. -1 = still calibrating. ' - format: double - maximum: 1 - minimum: -1 - type: number - probabilityAltCalibrated: - description: 'The calibrated probability for country OR countryAlt to have - been guessed correctly. -1 = still calibrating. ' - format: double - maximum: 1 - minimum: -1 - type: number - type: object - xml: - name: PersonalNameReligionedOut - FirstLastNamePhoneCodedOut: - description: Represents the output of inferring the LIKELY country and phone - code from a personal name and phone number. - example: - lastName: lastName - originCountryIso2Alt: originCountryIso2Alt - phoneCountryIso2Verified: phoneCountryIso2Verified - verified: true - explanation: explanation - script: script - firstName: firstName - score: 14.658129805029452 - phoneNumber: phoneNumber - phoneCountryCode: 0 - phoneCountryIso2: phoneCountryIso2 - originCountryIso2: originCountryIso2 - phoneCountryIso2Alt: phoneCountryIso2Alt - id: id - internationalPhoneNumberVerified: internationalPhoneNumberVerified - phoneCountryCodeAlt: 6 - countryIso2: countryIso2 - properties: - script: - type: string - id: - type: string - explanation: - type: string - firstName: - description: The first name (also known as given name) - type: string - lastName: - description: "The last name (also known as family name, or surname)" - type: string - internationalPhoneNumberVerified: - description: "The normalized phone number, verified using libphonenumber." - type: string - phoneCountryIso2Verified: - description: "The phone ISO2 country code, verified using libphonenumber." - type: string - phoneCountryCode: - description: "The phone country code of the phone number, verified using\ - \ libphonenumber." - format: int32 - type: integer - phoneCountryCodeAlt: - description: The best alternative phone country code of the phone number. - format: int32 - type: integer - phoneCountryIso2: - description: The likely country of the phone number. - type: string - phoneCountryIso2Alt: - description: The best alternative country of the phone number. - type: string - originCountryIso2: - description: The likely country of origin of the name. - type: string - originCountryIso2Alt: - description: The best alternative country of origin of the name. - type: string - phoneNumber: - description: The input phone number. - type: string - verified: - description: Indicates if the phone number could be positively verified - using libphonenumber. - type: boolean - score: - description: "Higher score is better, but score is not normalized. Use calibratedProbability\ - \ if available. " - format: double - maximum: 100 - minimum: 0 - type: number - countryIso2: - type: string - type: object - xml: - name: FirstLastNamePhoneCodedOut - MatchPersonalFirstLastNameIn: - example: - id: id - name2: - name: name - id: id - name1: - firstName: firstName - lastName: lastName - id: id - properties: - id: - type: string - xml: - attribute: true - name1: - $ref: '#/components/schemas/FirstLastNameIn' - name2: - $ref: '#/components/schemas/PersonalNameIn' - type: object - xml: - name: MatchPersonalFirstLastNameIn - PersonalNameParsedOut: - example: - score: 8.008281904610115 - firstLastName: - firstName: firstName - lastName: lastName - id: id - explanation: explanation - script: script - name: name - id: id - explanation: explanation - script: script - nameParserTypeAlt: FN1LN1 - nameParserType: FN1LN1 - properties: - script: - type: string - id: - type: string - explanation: - type: string - name: - description: The input name - type: string nameParserType: description: "Name parsing is addressed as a classification problem, for\ \ example FN1LN1 means a first then last name order." @@ -5768,54 +5240,14 @@ components: type: object xml: name: PersonalNameParsedOut - BatchPersonalNameGeoSubclassificationOut: - description: Represents the output of inferring the LIKELY country subclassification - (regional names). + BatchPersonalNameGeoSubdivisionIn: example: personalNames: - - score: 8.008281904610115 - probabilityCalibrated: 0.20549123661408064 - subclassificationTop: - - subclassificationTop - - subclassificationTop + - subdivisionIso: subdivisionIso name: name - probabilityAltCalibrated: -0.706837403899411 id: id countryIso2: countryIso2 - explanation: explanation - script: script - subClassification: subClassification - subClassificationAlt: subClassificationAlt - - score: 8.008281904610115 - probabilityCalibrated: 0.20549123661408064 - subclassificationTop: - - subclassificationTop - - subclassificationTop - name: name - probabilityAltCalibrated: -0.706837403899411 - id: id - countryIso2: countryIso2 - explanation: explanation - script: script - subClassification: subClassification - subClassificationAlt: subClassificationAlt - properties: - personalNames: - description: Classified names at sub country level (region or state) - items: - $ref: '#/components/schemas/PersonalNameGeoSubclassificationOut' - type: array - type: object - xml: - name: BatchPersonalNameGeoSubclassificationOut - BatchPersonalNameGeoSubdivisionIn: - example: - personalNames: - - subdivisionIso: subdivisionIso - name: name - id: id - countryIso2: countryIso2 - - subdivisionIso: subdivisionIso + - subdivisionIso: subdivisionIso name: name id: id countryIso2: countryIso2 @@ -5914,73 +5346,6 @@ components: type: object xml: name: BatchFirstLastNameOriginedOut - FirstLastNameReligionedOut: - description: Represents the output of inferring the LIKELY religion from a personal - Indian first/last name. - example: - firstName: firstName - lastName: lastName - religionAlt: religionAlt - score: 8.008281904610115 - probabilityCalibrated: 0.20549123661408064 - probabilityAltCalibrated: -0.706837403899411 - id: id - religionsTop: - - religionsTop - - religionsTop - explanation: explanation - script: script - religion: religion - properties: - script: - type: string - id: - type: string - explanation: - type: string - firstName: - description: The first name (also known as given name) - type: string - lastName: - description: "The last name (also known as family name, or surname)" - type: string - religion: - description: Most likely religion - type: string - religionAlt: - description: "Second best alternative : religion " - type: string - religionsTop: - description: List countries (top 10) - items: - description: List countries (top 10) - type: string - type: array - score: - description: "Compatibility to NamSor_v1 Origin score value. Higher score\ - \ is better, but score is not normalized. Use calibratedProbability if\ - \ available. " - format: double - maximum: 100 - minimum: 0 - type: number - probabilityCalibrated: - description: 'The calibrated probability for caste to have been guessed - correctly. -1 = still calibrating. ' - format: double - maximum: 1 - minimum: -1 - type: number - probabilityAltCalibrated: - description: 'The calibrated probability for caste OR casteAlt to have been - guessed correctly. -1 = still calibrating. ' - format: double - maximum: 1 - minimum: -1 - type: number - type: object - xml: - name: FirstLastNameReligionedOut FirstLastNameGeoZippedIn: example: firstName: firstName @@ -6039,32 +5404,68 @@ components: type: object xml: name: CorridorIn - PersonalNameGeoSubdivisionIn: + BatchPersonalNameDiasporaedOut: + description: "Represents the output of inferring the LIKELY ethnicity from a\ + \ personal name, given an country of residence." example: - subdivisionIso: subdivisionIso - name: name - id: id - countryIso2: countryIso2 + personalNames: + - probabilityCalibrated: 0.20549123661408064 + ethnicity: Chinese + lifted: true + ethnicityAlt: Japanese + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + countryIso2: countryIso2 + ethnicitiesTop: + - ethnicitiesTop + - ethnicitiesTop + - probabilityCalibrated: 0.20549123661408064 + ethnicity: Chinese + lifted: true + ethnicityAlt: Japanese + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + countryIso2: countryIso2 + ethnicitiesTop: + - ethnicitiesTop + - ethnicitiesTop properties: - id: - type: string - xml: - attribute: true - name: - type: string - xml: - attribute: true - countryIso2: - type: string - xml: - attribute: true - subdivisionIso: - type: string - xml: - attribute: true + personalNames: + description: Classified diaspora names + items: + $ref: '#/components/schemas/PersonalNameDiasporaedOut' + type: array type: object xml: - name: PersonalNameGeoSubdivisionIn + name: BatchPersonalNameDiasporaedOut BatchCorridorOut: example: corridorFromTo: @@ -6343,8 +5744,8 @@ components: xml: name: NameMatchCandidateOut ReligionStatOut: - description: "Geographic religious statistics, assuming ethnicity OR best alternative\ - \ is correctly predicted." + description: "Geographic religious statistics, assuming country is correctly\ + \ predicted." example: pct: 5.962133916683182 religion: religion @@ -6357,126 +5758,24 @@ components: type: object xml: name: ReligionStatOut - APIUsageHistoryOut: + FirstLastNameUSRaceEthnicityOut: + description: "Represents the output of inferring the LIKELY US 'race/ethnicity'\ + \ from a personal name, given US country of residence and (optionally) a ZIP5\ + \ code." example: - detailedUsage: - - apiKey: - striped: true - apiKey: apiKey - partner: true - corporate: true - anonymized: true - learnable: true - ipAddress: ipAddress - admin: true - disabled: true - userId: userId - explainable: true - vetted: true - serviceFeaturesUsage: - key: 5 - apiService: apiService - createdDateTime: 0 - lastFlushedDateTime: 1 - totalUsage: 6 - hostAddress: hostAddress - lastUsedDateTime: 5 - - apiKey: - striped: true - apiKey: apiKey - partner: true - corporate: true - anonymized: true - learnable: true - ipAddress: ipAddress - admin: true - disabled: true - userId: userId - explainable: true - vetted: true - serviceFeaturesUsage: - key: 5 - apiService: apiService - createdDateTime: 0 - lastFlushedDateTime: 1 - totalUsage: 6 - hostAddress: hostAddress - lastUsedDateTime: 5 - properties: - detailedUsage: - description: Detailed usage as reported by the deduplicating API counter. - items: - $ref: '#/components/schemas/APICounterV2Out' - type: array - type: object - xml: - name: APIUsageHistoryOut - BatchFirstLastNamePhoneCodedOut: - description: Represents the output of inferring the LIKELY country and phone - code of personal names+phones. - example: - personalNamesWithPhoneNumbers: - - lastName: lastName - originCountryIso2Alt: originCountryIso2Alt - phoneCountryIso2Verified: phoneCountryIso2Verified - verified: true - explanation: explanation - script: script - firstName: firstName - score: 14.658129805029452 - phoneNumber: phoneNumber - phoneCountryCode: 0 - phoneCountryIso2: phoneCountryIso2 - originCountryIso2: originCountryIso2 - phoneCountryIso2Alt: phoneCountryIso2Alt - id: id - internationalPhoneNumberVerified: internationalPhoneNumberVerified - phoneCountryCodeAlt: 6 - countryIso2: countryIso2 - - lastName: lastName - originCountryIso2Alt: originCountryIso2Alt - phoneCountryIso2Verified: phoneCountryIso2Verified - verified: true - explanation: explanation - script: script - firstName: firstName - score: 14.658129805029452 - phoneNumber: phoneNumber - phoneCountryCode: 0 - phoneCountryIso2: phoneCountryIso2 - originCountryIso2: originCountryIso2 - phoneCountryIso2Alt: phoneCountryIso2Alt - id: id - internationalPhoneNumberVerified: internationalPhoneNumberVerified - phoneCountryCodeAlt: 6 - countryIso2: countryIso2 - properties: - personalNamesWithPhoneNumbers: - description: Classified phone-coded names - items: - $ref: '#/components/schemas/FirstLastNamePhoneCodedOut' - type: array - type: object - xml: - name: BatchFirstLastNamePhoneCodedOut - FirstLastNameUSRaceEthnicityOut: - description: "Represents the output of inferring the LIKELY US 'race/ethnicity'\ - \ from a personal name, given US country of residence and (optionally) a ZIP5\ - \ code." - example: - firstName: firstName - lastName: lastName - raceEthnicityAlt: W_NL - score: 8.008281904610115 - raceEthnicitiesTop: - - raceEthnicitiesTop - - raceEthnicitiesTop - probabilityCalibrated: 0.20549123661408064 - probabilityAltCalibrated: -0.706837403899411 - id: id - explanation: explanation - script: script - raceEthnicity: W_NL + firstName: firstName + lastName: lastName + raceEthnicityAlt: W_NL + score: 8.008281904610115 + raceEthnicitiesTop: + - raceEthnicitiesTop + - raceEthnicitiesTop + probabilityCalibrated: 0.20549123661408064 + probabilityAltCalibrated: -0.706837403899411 + id: id + explanation: explanation + script: script + raceEthnicity: W_NL properties: script: type: string @@ -6567,25 +5866,6 @@ components: type: object xml: name: BatchFirstLastNamePhoneNumberGeoIn - BatchFirstLastNameSubdivisionIn: - example: - personalNames: - - firstName: firstName - lastName: lastName - subdivisionIso: subdivisionIso - id: id - - firstName: firstName - lastName: lastName - subdivisionIso: subdivisionIso - id: id - properties: - personalNames: - items: - $ref: '#/components/schemas/FirstLastNameSubdivisionIn' - type: array - type: object - xml: - name: BatchFirstLastNameSubdivisionIn PersonalNameGeoIn: example: name: name @@ -6607,29 +5887,6 @@ components: type: object xml: name: PersonalNameGeoIn - APIServiceOut: - description: List of API Services - example: - costInUnits: 0 - serviceGroup: serviceGroup - serviceName: serviceName - properties: - serviceName: - description: A service name corresponds to classifier name in apiStatus - (ex. personalname_gender or personalfullname_gender) - type: string - serviceGroup: - description: Groups together classifiers providing a similar service (ex. - gender groups personalname_gender and personalfullname_gender) - type: string - costInUnits: - description: Indicates how many units per call this service costs (ex. the - number of units per name) - format: int32 - type: integer - type: object - xml: - name: APIServiceOut BatchProperNounCategorizedOut: description: "Represents the output of inferring the common type (anthroponym,\ \ toponym, brand, etc.) from a list of proper names." @@ -6742,33 +5999,6 @@ components: type: object xml: name: FirstLastNameCasteOut - NameMatchedOut: - description: Classified matched names - example: - score: 0.8008281904610115 - matchStatus: Match - id: id - explanation: explanation - script: script - properties: - script: - type: string - id: - type: string - explanation: - type: string - matchStatus: - description: The name matching status. - enum: - - Match - - Mismatch - type: string - score: - format: double - type: number - type: object - xml: - name: NameMatchedOut BatchMatchPersonalFirstLastNameIn: example: personalNames: @@ -6855,7 +6085,6 @@ components: xml: name: RegionOut PersonalNameGeoOut: - description: Classified geo names example: country: country topRegion: topRegion @@ -6941,8 +6170,7 @@ components: $ref: '#/components/schemas/ReligionStatOut' type: array religionStatsAlt: - description: "Geographic religious statistics, assuming country OR best\ - \ alternative is correctly predicted." + description: "Geographic religious statistics, for country best alternative." items: $ref: '#/components/schemas/ReligionStatOut' type: array @@ -6968,6 +6196,2506 @@ components: type: object xml: name: BatchFirstLastNameGeoIn + BatchPersonalNameCastegroupOut: + example: + personalNames: + - castegroup: castegroup + castegroupTop: + - castegroupTop + - castegroupTop + score: 8.008281904610115 + probabilityCalibrated: 0.20549123661408064 + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + explanation: explanation + castegroupAlt: castegroupAlt + script: script + - castegroup: castegroup + castegroupTop: + - castegroupTop + - castegroupTop + score: 8.008281904610115 + probabilityCalibrated: 0.20549123661408064 + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + explanation: explanation + castegroupAlt: castegroupAlt + script: script + properties: + personalNames: + description: Caste group-coded names + items: + $ref: '#/components/schemas/PersonalNameCastegroupOut' + type: array + type: object + xml: + name: BatchPersonalNameCastegroupOut + APICounterV2Out: + description: Detailed usage as reported by the deduplicating API counter. + example: + apiKey: + striped: true + apiKey: apiKey + anonymized: true + learnable: true + ipAddress: ipAddress + admin: true + communityEngageOption: + genderFilter: + - genderFilter + - genderFilter + ethnicityFilter: + - ethnicityFilter + - ethnicityFilter + countryOutFilter: + - countryOutFilter + - countryOutFilter + usRaceEthnicityFilter: + - usRaceEthnicityFilter + - usRaceEthnicityFilter + userId: userId + explainable: true + vetted: true + partner: true + corporate: true + disabled: true + serviceFeaturesUsage: + key: 5 + apiService: apiService + createdDateTime: 0 + lastFlushedDateTime: 1 + totalUsage: 6 + hostAddress: hostAddress + lastUsedDateTime: 5 + properties: + apiKey: + $ref: '#/components/schemas/APIKeyOut' + apiService: + description: The apiService corresponds to the classifier name. + type: string + hostAddress: + description: The processing hostAddress. + type: string + createdDateTime: + description: The create datetime of the counter. + format: int64 + type: integer + totalUsage: + description: The usage of the counter. + format: int64 + type: integer + lastFlushedDateTime: + description: The flush datetime of the counter. + format: int64 + type: integer + lastUsedDateTime: + description: The last usage datetime of the counter. + format: int64 + type: integer + serviceFeaturesUsage: + additionalProperties: + description: "Usage of special features, such as Chinese, Japanese." + format: int64 + type: integer + description: "Usage of special features, such as Chinese, Japanese." + type: object + type: object + xml: + name: APICallStatOut + NameMatchCandidatesOut: + description: Classified matched names + example: + firstName: firstName + lastName: lastName + orderOption: orderOption + matchCandidates: + - predScoreGivenName: 6.027456183070403 + candidateName: candidateName + probability: 0.8008281904610115 + predScoreFamilyName: 1.4658129805029452 + - predScoreGivenName: 6.027456183070403 + candidateName: candidateName + probability: 0.8008281904610115 + predScoreFamilyName: 1.4658129805029452 + id: id + explanation: explanation + script: script + properties: + script: + type: string + id: + type: string + explanation: + type: string + firstName: + description: The first name (also known as given name) + type: string + lastName: + description: "The last name (also known as family name, or surname)" + type: string + orderOption: + description: The option for ordering + type: string + matchCandidates: + description: The ordered list of name matching candidates + items: + $ref: '#/components/schemas/NameMatchCandidateOut' + type: array + type: object + xml: + name: NameMatchCandidatesOut + NameIn: + example: + name: name + id: id + properties: + id: + type: string + xml: + attribute: true + name: + type: string + xml: + attribute: true + type: object + xml: + name: NameIn + PersonalNameSubdivisionIn: + example: + subdivisionIso: subdivisionIso + name: name + id: id + properties: + id: + type: string + xml: + attribute: true + name: + type: string + xml: + attribute: true + subdivisionIso: + type: string + xml: + attribute: true + type: object + xml: + name: PersonalNameSubdivisionIn + BatchPersonalNameSubdivisionIn: + example: + personalNames: + - subdivisionIso: subdivisionIso + name: name + id: id + - subdivisionIso: subdivisionIso + name: name + id: id + properties: + personalNames: + items: + $ref: '#/components/schemas/PersonalNameSubdivisionIn' + type: array + type: object + xml: + name: BatchPersonalNameSubdivisionIn + BatchPersonalNameUSRaceEthnicityOut: + description: Represents the output of inferring the LIKELY US race/ethnicity + from a list of personal names. + example: + personalNames: + - raceEthnicityAlt: W_NL + score: 8.008281904610115 + raceEthnicitiesTop: + - raceEthnicitiesTop + - raceEthnicitiesTop + probabilityCalibrated: 0.20549123661408064 + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + explanation: explanation + script: script + raceEthnicity: W_NL + - raceEthnicityAlt: W_NL + score: 8.008281904610115 + raceEthnicitiesTop: + - raceEthnicitiesTop + - raceEthnicitiesTop + probabilityCalibrated: 0.20549123661408064 + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + explanation: explanation + script: script + raceEthnicity: W_NL + properties: + personalNames: + description: Classified origined names + items: + $ref: '#/components/schemas/PersonalNameUSRaceEthnicityOut' + type: array + type: object + xml: + name: BatchPersonalNameUSRaceEthnicityOut + APIPlanSubscriptionOut: + description: The API Plan governing the subscription. + example: + stripeStatus: stripeStatus + planBaseFeesKey: planBaseFeesKey + planQuota: 5 + apiKey: apiKey + priceUSD: 2.3021358869347655 + priceOverageUSD: 7.061401241503109 + planStarted: 0 + planName: planName + planStatus: planStatus + priceOverage: 3.616076749251911 + userId: userId + planEnded: 1 + taxRate: 5.962133916683182 + price: 9.301444243932576 + currency: currency + currencyFactor: 2.027123023002322 + stripeSubscription: stripeSubscription + stripeCustomerId: stripeCustomerId + priorPlanStarted: 6 + properties: + apiKey: + description: User API Key. + type: string + planStarted: + description: Datetime when the user subscribed to the current plan. + format: int64 + type: integer + priorPlanStarted: + description: Datetime when the user subscribed to the prior plan. + format: int64 + type: integer + planEnded: + description: Datetime when the user ended the plan. + format: int64 + type: integer + taxRate: + description: Applicable tax rate for the plan. + format: double + type: number + planName: + description: Current plan name. + type: string + planBaseFeesKey: + description: Current plan key (as in Stripe product). + type: string + planStatus: + description: Plan status. + type: string + planQuota: + description: "Current plan quota in quantity of units (NB: some API use\ + \ several units per name)." + format: int64 + type: integer + priceUSD: + description: Current plan monthly price expressed in USD (includes a free + quota). + format: double + type: number + priceOverageUSD: + description: Current plan price for overages expressed in USD (extra price + per unit above the free quota). + format: double + type: number + price: + description: Current plan price for overages expressed in Currency (extra + price per unit above the free quota). + format: double + type: number + priceOverage: + description: Current plan price for overages expressed in Currency (extra + price per unit above the free quota). + format: double + type: number + currency: + description: Current plan Currency for prices. + type: string + currencyFactor: + description: "For USD, GBP, EUR - the factor is 1." + format: double + type: number + stripeCustomerId: + description: Stripe customer identifier. + type: string + stripeStatus: + description: Stripe status ex active. + type: string + stripeSubscription: + description: Stripe subscription identifier. + type: string + userId: + description: Internal user identifier. + type: string + type: object + xml: + name: APIPlanSubscriptionOut + FirstLastNameGeoIn: + example: + firstName: firstName + lastName: lastName + id: id + countryIso2: countryIso2 + properties: + id: + type: string + xml: + attribute: true + firstName: + type: string + xml: + attribute: true + lastName: + type: string + xml: + attribute: true + countryIso2: + type: string + xml: + attribute: true + type: object + xml: + name: FirstLastNameGeoIn + BatchFirstLastNameReligionedOut: + description: Represents the output of inferring the LIKELY religion from a list + of personal names. + example: + personalNames: + - firstName: firstName + lastName: lastName + religionAlt: religionAlt + score: 8.008281904610115 + probabilityCalibrated: 0.20549123661408064 + probabilityAltCalibrated: -0.706837403899411 + id: id + religionsTop: + - religionsTop + - religionsTop + explanation: explanation + script: script + religion: religion + - firstName: firstName + lastName: lastName + religionAlt: religionAlt + score: 8.008281904610115 + probabilityCalibrated: 0.20549123661408064 + probabilityAltCalibrated: -0.706837403899411 + id: id + religionsTop: + - religionsTop + - religionsTop + explanation: explanation + script: script + religion: religion + properties: + personalNames: + description: Classified names + items: + $ref: '#/components/schemas/FirstLastNameReligionedOut' + type: array + type: object + xml: + name: BatchFirstLastNameReligionedOut + PersonalNameOriginedOut: + description: Represents the output of inferring the LIKELY country of Origin + from a personal name. + example: + probabilityCalibrated: 0.20549123661408064 + religionStatsSynthetic: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + explanation: explanation + script: script + regionOrigin: regionOrigin + topRegionOrigin: topRegionOrigin + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + subRegionOrigin: subRegionOrigin + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + countriesOriginTop: + - countriesOriginTop + - countriesOriginTop + id: id + countryOrigin: countryOrigin + countryOriginAlt: countryOriginAlt + properties: + script: + type: string + id: + type: string + explanation: + type: string + name: + description: The input name. + type: string + countryOrigin: + description: Most likely country of Origin + type: string + countryOriginAlt: + description: "Second best alternative : country of Origin" + type: string + countriesOriginTop: + description: List countries of Origin (top 10) + items: + description: List countries of Origin (top 10) + type: string + type: array + score: + description: "Compatibility to NamSor_v1 Origin score value. Higher score\ + \ is better, but score is not normalized. Use calibratedProbability if\ + \ available. " + format: double + maximum: 100 + minimum: 0 + type: number + regionOrigin: + description: Most likely region of Origin (based on countryOrigin ISO2 code) + type: string + topRegionOrigin: + description: Most likely top region of Origin (based on countryOrigin ISO2 + code) + type: string + subRegionOrigin: + description: Most likely sub region of Origin (based on countryOrigin ISO2 + code) + type: string + probabilityCalibrated: + description: 'The calibrated probability for countryOrigin to have been + guessed correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + probabilityAltCalibrated: + description: 'The calibrated probability for countryOrigin OR countryOriginAlt + to have been guessed correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + religionStats: + description: "Geographic religious statistics, assuming country of origin\ + \ is correctly predicted." + items: + $ref: '#/components/schemas/ReligionStatOut' + type: array + religionStatsAlt: + description: "Geographic religious statistics, for country best alternative." + items: + $ref: '#/components/schemas/ReligionStatOut' + type: array + religionStatsSynthetic: + description: "Geographic religious statistics, assuming country of origin\ + \ OR best alternative is correctly predicted." + items: + $ref: '#/components/schemas/ReligionStatOut' + type: array + type: object + xml: + name: PersonalNameOriginedOut + PersonalNameCastegroupOut: + description: Caste group-coded names + example: + castegroup: castegroup + castegroupTop: + - castegroupTop + - castegroupTop + score: 8.008281904610115 + probabilityCalibrated: 0.20549123661408064 + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + explanation: explanation + castegroupAlt: castegroupAlt + script: script + properties: + script: + type: string + id: + type: string + explanation: + type: string + name: + description: The input name. + type: string + score: + description: "Higher score is better, but score is not normalized. Use calibratedProbability\ + \ if available. " + format: double + maximum: 100 + minimum: 0 + type: number + castegroup: + description: Most likely caste group + type: string + castegroupAlt: + description: "Second best alternative : caste group " + type: string + castegroupTop: + description: List caste group (top 10) + items: + description: List caste group (top 10) + type: string + type: array + probabilityCalibrated: + description: 'The calibrated probability for country to have been guessed + correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + probabilityAltCalibrated: + description: 'The calibrated probability for country OR countryAlt to have + been guessed correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + type: object + xml: + name: PersonalNameCastegroupOut + APIClassifiersStatusOut: + example: + classifiers: + - probabilityCalibrated: true + shuttingDown: true + learning: true + classifierName: classifierName + serving: true + - probabilityCalibrated: true + shuttingDown: true + learning: true + classifierName: classifierName + serving: true + softwareVersion: + softwareNameAndVersion: softwareNameAndVersion + softwareVersion: + - 0 + - 0 + properties: + softwareVersion: + $ref: '#/components/schemas/SoftwareVersionOut' + classifiers: + description: The list of classifiers and versions. + items: + $ref: '#/components/schemas/APIClassifierOut' + type: array + type: object + xml: + name: APIClassifiersStatusOut + BatchNameGeoIn: + example: + properNouns: + - name: name + id: id + countryIso2: countryIso2 + - name: name + id: id + countryIso2: countryIso2 + properties: + properNouns: + items: + $ref: '#/components/schemas/NameGeoIn' + type: array + type: object + xml: + name: BatchNameGeoIn + BatchFirstLastNameGenderIn: + example: + personalNames: + - firstName: firstName + lastName: lastName + gender: gender + id: id + - firstName: firstName + lastName: lastName + gender: gender + id: id + properties: + personalNames: + items: + $ref: '#/components/schemas/FirstLastNameGenderIn' + type: array + type: object + xml: + name: BatchFirstLastNameGenderIn + BatchPersonalNameParsedOut: + example: + personalNames: + - score: 8.008281904610115 + firstLastName: + firstName: firstName + lastName: lastName + id: id + explanation: explanation + script: script + name: name + id: id + explanation: explanation + script: script + nameParserTypeAlt: FN1LN1 + nameParserType: FN1LN1 + - score: 8.008281904610115 + firstLastName: + firstName: firstName + lastName: lastName + id: id + explanation: explanation + script: script + name: name + id: id + explanation: explanation + script: script + nameParserTypeAlt: FN1LN1 + nameParserType: FN1LN1 + properties: + personalNames: + description: Classified parsed names + items: + $ref: '#/components/schemas/PersonalNameParsedOut' + type: array + type: object + xml: + name: BatchPersonalNameParsedOut + FirstLastNameDiasporaedOut: + description: "Represents the output of inferring the LIKELY ethnicity from a\ + \ personal name, given an country of residence." + example: + lastName: lastName + probabilityCalibrated: 0.12747533132666566 + ethnicity: Chinese + lifted: true + ethnicityAlt: Japanese + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + firstName: firstName + score: 59.621339166831824 + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + probabilityAltCalibrated: -0.539572822613047 + id: id + countryIso2: countryIso2 + ethnicitiesTop: + - ethnicitiesTop + - ethnicitiesTop + properties: + script: + type: string + id: + type: string + explanation: + type: string + firstName: + description: The first name (also known as given name) + type: string + lastName: + description: "The last name (also known as family name, or surname)" + type: string + score: + description: "Compatibility to NamSor_v1 Diaspora score value. Higher score\ + \ is better, but score is not normalized. Use calibratedProbability if\ + \ available. " + format: double + maximum: 100 + minimum: 0 + type: number + ethnicityAlt: + description: The second best alternative ethnicity + example: Japanese + type: string + xml: + attribute: true + ethnicity: + description: The most likely ethnicity + example: Chinese + type: string + xml: + attribute: true + lifted: + description: "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." + type: boolean + xml: + attribute: true + countryIso2: + description: "From input data, the countryIso2 of geographic context (US,CA\ + \ etc.)" + type: string + xml: + attribute: true + ethnicitiesTop: + description: List most likely ethnicities (top 10) + items: + description: List most likely ethnicities (top 10) + type: string + type: array + probabilityCalibrated: + description: 'The calibrated probability for ethnicity to have been guessed + correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + probabilityAltCalibrated: + description: 'The calibrated probability for ethnicity OR ethnicityAlt to + have been guessed correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + religionStats: + description: "Geographic religious statistics, assuming ethnicity is correctly\ + \ predicted." + items: + $ref: '#/components/schemas/ReligionStatOut' + type: array + religionStatsAlt: + description: "Geographic religious statistics, for country best alternative." + items: + $ref: '#/components/schemas/ReligionStatOut' + type: array + type: object + xml: + name: FirstLastNameDiasporaedOut + BatchPersonalNameReligionedOut: + example: + personalNames: + - score: 8.008281904610115 + religionAlt: religionAlt + probabilityCalibrated: 0.20549123661408064 + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + religionsTop: + - religionsTop + - religionsTop + explanation: explanation + script: script + religion: religion + - score: 8.008281904610115 + religionAlt: religionAlt + probabilityCalibrated: 0.20549123661408064 + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + religionsTop: + - religionsTop + - religionsTop + explanation: explanation + script: script + religion: religion + properties: + personalNames: + description: religious-coded names + items: + $ref: '#/components/schemas/PersonalNameReligionedOut' + type: array + type: object + xml: + name: BatchPersonalNameReligionedOut + BatchFirstLastNameGeoOut: + example: + personalNames: + - lastName: lastName + country: country + topRegion: topRegion + subRegion: subRegion + probabilityCalibrated: 0.20549123661408064 + countryAlt: countryAlt + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + firstName: firstName + score: 8.008281904610115 + countriesTop: + - countriesTop + - countriesTop + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + probabilityAltCalibrated: -0.706837403899411 + id: id + region: region + - lastName: lastName + country: country + topRegion: topRegion + subRegion: subRegion + probabilityCalibrated: 0.20549123661408064 + countryAlt: countryAlt + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + firstName: firstName + score: 8.008281904610115 + countriesTop: + - countriesTop + - countriesTop + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + probabilityAltCalibrated: -0.706837403899411 + id: id + region: region + properties: + personalNames: + description: Classified names + items: + $ref: '#/components/schemas/FirstLastNameGeoOut' + type: array + type: object + xml: + name: BatchFirstLastNameGeoOut + APIBillingPeriodUsageOut: + description: The current billing period. + example: + apiKey: apiKey + periodStarted: 7 + stripeCurrentPeriodEnd: 1 + usage: 6 + hardLimit: 1 + subscriptionStarted: 4 + periodEnded: 1 + billingStatus: billingStatus + stripeCurrentPeriodStart: 1 + softLimit: 7 + properties: + apiKey: + description: User API Key. + type: string + subscriptionStarted: + description: Datetime when the user subscribed to the plan. + format: int64 + type: integer + periodStarted: + description: Datetime when the the plan's current period started. + format: int64 + type: integer + periodEnded: + description: Datetime when the the plan's current period endend. + format: int64 + type: integer + stripeCurrentPeriodEnd: + description: Datetime when the the plan's current period endend (in Stripe). + Internal and Stripe periodicity should ~coincide. + format: int64 + type: integer + stripeCurrentPeriodStart: + description: Datetime when the the plan's current period started (in Stripe). + Internal and Stripe periodicity should ~coincide. + format: int64 + type: integer + billingStatus: + description: Current period billing status ex OPEN. + type: string + usage: + description: Current period usage in units (NB some API endpoints use more + than one unit). + format: int64 + type: integer + softLimit: + description: Current period soft limit (reaching the limit sends an email + notification). + format: int64 + type: integer + hardLimit: + description: Current period hard limit (reaching the limit sends an email + notification and blocks the API Key). + format: int64 + type: integer + type: object + xml: + name: APIBillingPeriodUsageOut + PersonalNameIn: + example: + name: name + id: id + properties: + id: + type: string + xml: + attribute: true + name: + type: string + xml: + attribute: true + type: object + xml: + name: PersonalNameIn + APIUsageAggregatedOut: + example: + rowHeaders: + - rowHeaders + - rowHeaders + data: + - - 5 + - 5 + - - 5 + - 5 + historyTruncated: true + colHeaders: + - colHeaders + - colHeaders + totalUsage: 1 + periodStart: 0 + timeUnit: timeUnit + periodEnd: 6 + properties: + timeUnit: + description: "Time unit is DAY, WEEK or MONTH depending on prior usage" + type: string + periodStart: + description: Start datetime of the reporting period + format: int64 + type: integer + periodEnd: + description: End datetime of the reporting period + format: int64 + type: integer + totalUsage: + description: Total usage in the current period + format: int64 + type: integer + historyTruncated: + description: If the history was truncaded due to data limit + type: boolean + data: + description: "Data points : usage per DAY, WEEK or MONTH and per apiService" + items: + description: "Data points : usage per DAY, WEEK or MONTH and per apiService" + items: + description: "Data points : usage per DAY, WEEK or MONTH and per apiService" + format: int32 + type: integer + type: array + type: array + colHeaders: + description: 'apiServices as column headers ' + items: + description: 'apiServices as column headers ' + type: string + type: array + rowHeaders: + description: 'dates as row headers ' + items: + description: 'dates as row headers ' + type: string + type: array + type: object + xml: + name: APIUsageAggregatedOut + APIServicesOut: + example: + apiServices: + - costInUnits: 0 + serviceGroup: serviceGroup + serviceName: serviceName + - costInUnits: 0 + serviceGroup: serviceGroup + serviceName: serviceName + properties: + apiServices: + description: List of API Services + items: + $ref: '#/components/schemas/APIServiceOut' + type: array + type: object + xml: + name: APIServicesOut + BatchNameIn: + example: + properNouns: + - name: name + id: id + - name: name + id: id + properties: + properNouns: + items: + $ref: '#/components/schemas/NameIn' + type: array + type: object + xml: + name: BatchNameIn + FirstLastNameOut: + description: First / last name structure corresponding to the most likely parsing. + example: + firstName: firstName + lastName: lastName + id: id + explanation: explanation + script: script + properties: + script: + type: string + id: + type: string + explanation: + type: string + firstName: + description: The first name (also known as given name) + type: string + lastName: + description: "The last name (also known as family name, or surname)" + type: string + type: object + xml: + name: FirstLastNameOut + PersonalNameGeoSubclassificationOut: + description: Classified names at sub country level (region or state) + example: + score: 8.008281904610115 + probabilityCalibrated: 0.20549123661408064 + subclassificationTop: + - subclassificationTop + - subclassificationTop + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + countryIso2: countryIso2 + explanation: explanation + script: script + subClassification: subClassification + subClassificationAlt: subClassificationAlt + properties: + script: + type: string + id: + type: string + explanation: + type: string + name: + description: The input name. + type: string + countryIso2: + description: The input country ISO2 code + type: string + xml: + attribute: true + subClassification: + description: Most likely subclassification ISO_3166-2 code + type: string + subClassificationAlt: + description: "Second best alternative : subclassification ISO_3166-2 code" + type: string + subclassificationTop: + description: List subclassification ISO_3166-2 codes (top 10) + items: + description: List subclassification ISO_3166-2 codes (top 10) + type: string + type: array + score: + description: "Compatibility to NamSor_v1 Origin score value. Higher score\ + \ is better, but score is not normalized. Use calibratedProbability if\ + \ available. " + format: double + maximum: 100 + minimum: 0 + type: number + probabilityCalibrated: + description: 'The calibrated probability for subclassification to have been + guessed correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + probabilityAltCalibrated: + description: 'The calibrated probability for subclassification OR subclassificationAlt + to have been guessed correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + type: object + xml: + name: PersonalNameGeoSubclassificationOut + BatchFirstLastNameUSRaceEthnicityOut: + description: "Represents the output of inferring the LIKELY US 'race/ethnicity'\ + \ from a personal name, given US country of residence and (optionally) a ZIP5\ + \ code." + example: + personalNames: + - firstName: firstName + lastName: lastName + raceEthnicityAlt: W_NL + score: 8.008281904610115 + raceEthnicitiesTop: + - raceEthnicitiesTop + - raceEthnicitiesTop + probabilityCalibrated: 0.20549123661408064 + probabilityAltCalibrated: -0.706837403899411 + id: id + explanation: explanation + script: script + raceEthnicity: W_NL + - firstName: firstName + lastName: lastName + raceEthnicityAlt: W_NL + score: 8.008281904610115 + raceEthnicitiesTop: + - raceEthnicitiesTop + - raceEthnicitiesTop + probabilityCalibrated: 0.20549123661408064 + probabilityAltCalibrated: -0.706837403899411 + id: id + explanation: explanation + script: script + raceEthnicity: W_NL + properties: + personalNames: + description: Classified US 'race'/ethnicized names + items: + $ref: '#/components/schemas/FirstLastNameUSRaceEthnicityOut' + type: array + type: object + xml: + name: BatchFirstLastNameUSRaceEthnicityOut + BatchPersonalNameIn: + example: + personalNames: + - name: name + id: id + - name: name + id: id + properties: + personalNames: + items: + $ref: '#/components/schemas/PersonalNameIn' + type: array + type: object + xml: + name: BatchPersonalNameIn + BatchFirstLastNamePhoneNumberIn: + example: + personalNamesWithPhoneNumbers: + - firstName: firstName + lastName: lastName + phoneNumber: phoneNumber + id: id + - firstName: firstName + lastName: lastName + phoneNumber: phoneNumber + id: id + properties: + personalNamesWithPhoneNumbers: + items: + $ref: '#/components/schemas/FirstLastNamePhoneNumberIn' + type: array + type: object + xml: + name: BatchFirstLastNamePhoneNumberIn + NameGeoIn: + example: + name: name + id: id + countryIso2: countryIso2 + properties: + id: + type: string + xml: + attribute: true + name: + type: string + xml: + attribute: true + countryIso2: + type: string + xml: + attribute: true + type: object + xml: + name: NameGeoIn + PersonalNameReligionedOut: + description: religious-coded names + example: + score: 8.008281904610115 + religionAlt: religionAlt + probabilityCalibrated: 0.20549123661408064 + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + religionsTop: + - religionsTop + - religionsTop + explanation: explanation + script: script + religion: religion + properties: + script: + type: string + id: + type: string + explanation: + type: string + name: + description: The input name. + type: string + score: + description: "Higher score is better, but score is not normalized. Use calibratedProbability\ + \ if available. " + format: double + maximum: 100 + minimum: 0 + type: number + religion: + description: Most likely religion + type: string + religionAlt: + description: "Second best alternative : religion " + type: string + religionsTop: + description: List religions (top 10) + items: + description: List religions (top 10) + type: string + type: array + probabilityCalibrated: + description: 'The calibrated probability for country to have been guessed + correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + probabilityAltCalibrated: + description: 'The calibrated probability for country OR countryAlt to have + been guessed correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + type: object + xml: + name: PersonalNameReligionedOut + FirstLastNamePhoneCodedOut: + description: Represents the output of inferring the LIKELY country and phone + code from a personal name and phone number. + example: + lastName: lastName + originCountryIso2Alt: originCountryIso2Alt + phoneCountryIso2Verified: phoneCountryIso2Verified + verified: true + explanation: explanation + script: script + firstName: firstName + score: 14.658129805029452 + phoneNumber: phoneNumber + phoneCountryCode: 0 + phoneCountryIso2: phoneCountryIso2 + originCountryIso2: originCountryIso2 + phoneCountryIso2Alt: phoneCountryIso2Alt + id: id + internationalPhoneNumberVerified: internationalPhoneNumberVerified + phoneCountryCodeAlt: 6 + countryIso2: countryIso2 + properties: + script: + type: string + id: + type: string + explanation: + type: string + firstName: + description: The first name (also known as given name) + type: string + lastName: + description: "The last name (also known as family name, or surname)" + type: string + internationalPhoneNumberVerified: + description: "The normalized phone number, verified using libphonenumber." + type: string + phoneCountryIso2Verified: + description: "The phone ISO2 country code, verified using libphonenumber." + type: string + phoneCountryCode: + description: "The phone country code of the phone number, verified using\ + \ libphonenumber." + format: int32 + type: integer + phoneCountryCodeAlt: + description: The best alternative phone country code of the phone number. + format: int32 + type: integer + phoneCountryIso2: + description: The likely country of the phone number. + type: string + phoneCountryIso2Alt: + description: The best alternative country of the phone number. + type: string + originCountryIso2: + description: The likely country of origin of the name. + type: string + originCountryIso2Alt: + description: The best alternative country of origin of the name. + type: string + phoneNumber: + description: The input phone number. + type: string + verified: + description: Indicates if the phone number could be positively verified + using libphonenumber. + type: boolean + score: + description: "Higher score is better, but score is not normalized. Use calibratedProbability\ + \ if available. " + format: double + maximum: 100 + minimum: 0 + type: number + countryIso2: + type: string + type: object + xml: + name: FirstLastNamePhoneCodedOut + MatchPersonalFirstLastNameIn: + example: + id: id + name2: + name: name + id: id + name1: + firstName: firstName + lastName: lastName + id: id + properties: + id: + type: string + xml: + attribute: true + name1: + $ref: '#/components/schemas/FirstLastNameIn' + name2: + $ref: '#/components/schemas/PersonalNameIn' + type: object + xml: + name: MatchPersonalFirstLastNameIn + BatchPersonalNameGeoSubclassificationOut: + description: Represents the output of inferring the LIKELY country subclassification + (regional names). + example: + personalNames: + - score: 8.008281904610115 + probabilityCalibrated: 0.20549123661408064 + subclassificationTop: + - subclassificationTop + - subclassificationTop + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + countryIso2: countryIso2 + explanation: explanation + script: script + subClassification: subClassification + subClassificationAlt: subClassificationAlt + - score: 8.008281904610115 + probabilityCalibrated: 0.20549123661408064 + subclassificationTop: + - subclassificationTop + - subclassificationTop + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + countryIso2: countryIso2 + explanation: explanation + script: script + subClassification: subClassification + subClassificationAlt: subClassificationAlt + properties: + personalNames: + description: Classified names at sub country level (region or state) + items: + $ref: '#/components/schemas/PersonalNameGeoSubclassificationOut' + type: array + type: object + xml: + name: BatchPersonalNameGeoSubclassificationOut + FirstLastNameReligionedOut: + description: Represents the output of inferring the LIKELY religion from a personal + Indian first/last name. + example: + firstName: firstName + lastName: lastName + religionAlt: religionAlt + score: 8.008281904610115 + probabilityCalibrated: 0.20549123661408064 + probabilityAltCalibrated: -0.706837403899411 + id: id + religionsTop: + - religionsTop + - religionsTop + explanation: explanation + script: script + religion: religion + properties: + script: + type: string + id: + type: string + explanation: + type: string + firstName: + description: The first name (also known as given name) + type: string + lastName: + description: "The last name (also known as family name, or surname)" + type: string + religion: + description: Most likely religion + type: string + religionAlt: + description: "Second best alternative : religion " + type: string + religionsTop: + description: List countries (top 10) + items: + description: List countries (top 10) + type: string + type: array + score: + description: "Compatibility to NamSor_v1 Origin score value. Higher score\ + \ is better, but score is not normalized. Use calibratedProbability if\ + \ available. " + format: double + maximum: 100 + minimum: 0 + type: number + probabilityCalibrated: + description: 'The calibrated probability for caste to have been guessed + correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + probabilityAltCalibrated: + description: 'The calibrated probability for caste OR casteAlt to have been + guessed correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + type: object + xml: + name: FirstLastNameReligionedOut + PersonalNameUSRaceEthnicityOut: + description: "Represents the output of inferring the LIKELY US 'race/ethnicity'\ + \ from a personal name, given US country of residence and (optionally) a ZIP5\ + \ code." + example: + raceEthnicityAlt: W_NL + score: 8.008281904610115 + raceEthnicitiesTop: + - raceEthnicitiesTop + - raceEthnicitiesTop + probabilityCalibrated: 0.20549123661408064 + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + explanation: explanation + script: script + raceEthnicity: W_NL + properties: + script: + type: string + id: + type: string + explanation: + type: string + name: + description: The input name. + type: string + raceEthnicityAlt: + description: Second most likely US 'race'/ethnicity + enum: + - W_NL + - HL + - A + - B_NL + - AI_AN + - PI + type: string + xml: + attribute: true + raceEthnicity: + description: Most likely US 'race'/ethnicity + enum: + - W_NL + - HL + - A + - B_NL + - AI_AN + - PI + type: string + xml: + attribute: true + score: + description: "Higher score is better, but score is not normalized. Use calibratedProbability\ + \ if available. " + format: double + maximum: 100 + minimum: 0 + type: number + raceEthnicitiesTop: + description: List 'race'/ethnicities + items: + description: List 'race'/ethnicities + type: string + type: array + probabilityCalibrated: + description: 'The calibrated probability for raceEthnicity to have been + guessed correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + probabilityAltCalibrated: + description: 'The calibrated probability for raceEthnicity OR raceEthnicityAlt + to have been guessed correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + type: object + xml: + name: PersonalNameUSRaceEthnicityOut + PersonalNameGeoSubdivisionIn: + example: + subdivisionIso: subdivisionIso + name: name + id: id + countryIso2: countryIso2 + properties: + id: + type: string + xml: + attribute: true + name: + type: string + xml: + attribute: true + countryIso2: + type: string + xml: + attribute: true + subdivisionIso: + type: string + xml: + attribute: true + type: object + xml: + name: PersonalNameGeoSubdivisionIn + CommunityEngageOptionOut: + example: + genderFilter: + - genderFilter + - genderFilter + ethnicityFilter: + - ethnicityFilter + - ethnicityFilter + countryOutFilter: + - countryOutFilter + - countryOutFilter + usRaceEthnicityFilter: + - usRaceEthnicityFilter + - usRaceEthnicityFilter + properties: + genderFilter: + description: The gender filter (null to allow all) + items: + description: The gender filter (null to allow all) + type: string + type: array + ethnicityFilter: + description: The ethnicity filter (null to allow all) + items: + description: The ethnicity filter (null to allow all) + type: string + type: array + countryOutFilter: + description: The output country filter (null to allow all) + items: + description: The output country filter (null to allow all) + type: string + type: array + usRaceEthnicityFilter: + description: The output US race/ethnicity filter (null to allow all) + items: + description: The output US race/ethnicity filter (null to allow all) + type: string + type: array + type: object + xml: + name: CommunityEngageOptionOut + BatchPersonalNameOriginedOut: + description: Represents the output of inferring the LIKELY origin from a list + of personal names. + example: + personalNames: + - probabilityCalibrated: 0.20549123661408064 + religionStatsSynthetic: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + explanation: explanation + script: script + regionOrigin: regionOrigin + topRegionOrigin: topRegionOrigin + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + subRegionOrigin: subRegionOrigin + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + countriesOriginTop: + - countriesOriginTop + - countriesOriginTop + id: id + countryOrigin: countryOrigin + countryOriginAlt: countryOriginAlt + - probabilityCalibrated: 0.20549123661408064 + religionStatsSynthetic: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + explanation: explanation + script: script + regionOrigin: regionOrigin + topRegionOrigin: topRegionOrigin + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + subRegionOrigin: subRegionOrigin + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + countriesOriginTop: + - countriesOriginTop + - countriesOriginTop + id: id + countryOrigin: countryOrigin + countryOriginAlt: countryOriginAlt + properties: + personalNames: + description: Classified origined names + items: + $ref: '#/components/schemas/PersonalNameOriginedOut' + type: array + type: object + xml: + name: BatchPersonalNameOriginedOut + APIUsageHistoryOut: + example: + detailedUsage: + - apiKey: + striped: true + apiKey: apiKey + anonymized: true + learnable: true + ipAddress: ipAddress + admin: true + communityEngageOption: + genderFilter: + - genderFilter + - genderFilter + ethnicityFilter: + - ethnicityFilter + - ethnicityFilter + countryOutFilter: + - countryOutFilter + - countryOutFilter + usRaceEthnicityFilter: + - usRaceEthnicityFilter + - usRaceEthnicityFilter + userId: userId + explainable: true + vetted: true + partner: true + corporate: true + disabled: true + serviceFeaturesUsage: + key: 5 + apiService: apiService + createdDateTime: 0 + lastFlushedDateTime: 1 + totalUsage: 6 + hostAddress: hostAddress + lastUsedDateTime: 5 + - apiKey: + striped: true + apiKey: apiKey + anonymized: true + learnable: true + ipAddress: ipAddress + admin: true + communityEngageOption: + genderFilter: + - genderFilter + - genderFilter + ethnicityFilter: + - ethnicityFilter + - ethnicityFilter + countryOutFilter: + - countryOutFilter + - countryOutFilter + usRaceEthnicityFilter: + - usRaceEthnicityFilter + - usRaceEthnicityFilter + userId: userId + explainable: true + vetted: true + partner: true + corporate: true + disabled: true + serviceFeaturesUsage: + key: 5 + apiService: apiService + createdDateTime: 0 + lastFlushedDateTime: 1 + totalUsage: 6 + hostAddress: hostAddress + lastUsedDateTime: 5 + properties: + detailedUsage: + description: Detailed usage as reported by the deduplicating API counter. + items: + $ref: '#/components/schemas/APICounterV2Out' + type: array + type: object + xml: + name: APIUsageHistoryOut + PersonalNameDiasporaedOut: + description: "Represents the output of inferring the LIKELY ethnicity from a\ + \ personal name, given an country of residence." + example: + probabilityCalibrated: 0.20549123661408064 + ethnicity: Chinese + lifted: true + ethnicityAlt: Japanese + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + countryIso2: countryIso2 + ethnicitiesTop: + - ethnicitiesTop + - ethnicitiesTop + properties: + script: + type: string + id: + type: string + explanation: + type: string + name: + description: The input name. + type: string + score: + description: "Compatibility to NamSor_v1 Diaspora score value. Higher score\ + \ is better, but score is not normalized. Use calibratedProbability if\ + \ available. " + format: double + maximum: 100 + minimum: 0 + type: number + ethnicityAlt: + description: The second best alternative ethnicity + example: Japanese + type: string + xml: + attribute: true + ethnicity: + description: The most likely ethnicity + example: Chinese + type: string + xml: + attribute: true + lifted: + description: "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." + type: boolean + xml: + attribute: true + countryIso2: + description: "From input data, the countryIso2 of geographic context (US,CA\ + \ etc.)" + type: string + xml: + attribute: true + ethnicitiesTop: + description: List most likely ethnicities (top 10) + items: + description: List most likely ethnicities (top 10) + type: string + type: array + probabilityCalibrated: + description: 'The calibrated probability for ethnicity to have been guessed + correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + probabilityAltCalibrated: + description: 'The calibrated probability for ethnicity OR ethnicityAlt to + have been guessed correctly. -1 = still calibrating. ' + format: double + maximum: 1 + minimum: -1 + type: number + religionStats: + description: "Geographic religious statistics, assuming ethnicity is correctly\ + \ predicted." + items: + $ref: '#/components/schemas/ReligionStatOut' + type: array + religionStatsAlt: + description: "Geographic religious statistics, for country best alternative." + items: + $ref: '#/components/schemas/ReligionStatOut' + type: array + type: object + xml: + name: PersonalNameDiasporaedOut + BatchFirstLastNamePhoneCodedOut: + description: Represents the output of inferring the LIKELY country and phone + code of personal names+phones. + example: + personalNamesWithPhoneNumbers: + - lastName: lastName + originCountryIso2Alt: originCountryIso2Alt + phoneCountryIso2Verified: phoneCountryIso2Verified + verified: true + explanation: explanation + script: script + firstName: firstName + score: 14.658129805029452 + phoneNumber: phoneNumber + phoneCountryCode: 0 + phoneCountryIso2: phoneCountryIso2 + originCountryIso2: originCountryIso2 + phoneCountryIso2Alt: phoneCountryIso2Alt + id: id + internationalPhoneNumberVerified: internationalPhoneNumberVerified + phoneCountryCodeAlt: 6 + countryIso2: countryIso2 + - lastName: lastName + originCountryIso2Alt: originCountryIso2Alt + phoneCountryIso2Verified: phoneCountryIso2Verified + verified: true + explanation: explanation + script: script + firstName: firstName + score: 14.658129805029452 + phoneNumber: phoneNumber + phoneCountryCode: 0 + phoneCountryIso2: phoneCountryIso2 + originCountryIso2: originCountryIso2 + phoneCountryIso2Alt: phoneCountryIso2Alt + id: id + internationalPhoneNumberVerified: internationalPhoneNumberVerified + phoneCountryCodeAlt: 6 + countryIso2: countryIso2 + properties: + personalNamesWithPhoneNumbers: + description: Classified phone-coded names + items: + $ref: '#/components/schemas/FirstLastNamePhoneCodedOut' + type: array + type: object + xml: + name: BatchFirstLastNamePhoneCodedOut + BatchFirstLastNameSubdivisionIn: + example: + personalNames: + - firstName: firstName + lastName: lastName + subdivisionIso: subdivisionIso + id: id + - firstName: firstName + lastName: lastName + subdivisionIso: subdivisionIso + id: id + properties: + personalNames: + items: + $ref: '#/components/schemas/FirstLastNameSubdivisionIn' + type: array + type: object + xml: + name: BatchFirstLastNameSubdivisionIn + BatchCommunityEngageFullOut: + example: + engagementCandidates: + - prime: true + country: + country: country + topRegion: topRegion + subRegion: subRegion + probabilityCalibrated: 0.20549123661408064 + countryAlt: countryAlt + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + countriesTop: + - countriesTop + - countriesTop + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + region: region + gender: + genderScale: -0.8398343619077977 + score: 60.27456183070403 + probabilityCalibrated: -0.706837403899411 + name: name + likelyGender: male + id: id + explanation: explanation + script: script + scoped: true + PersonalNameUSRaceEthnicityOut: + raceEthnicityAlt: W_NL + score: 8.008281904610115 + raceEthnicitiesTop: + - raceEthnicitiesTop + - raceEthnicitiesTop + probabilityCalibrated: 0.20549123661408064 + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + explanation: explanation + script: script + raceEthnicity: W_NL + PersonalNameDiasporaedOut: + probabilityCalibrated: 0.20549123661408064 + ethnicity: Chinese + lifted: true + ethnicityAlt: Japanese + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + countryIso2: countryIso2 + ethnicitiesTop: + - ethnicitiesTop + - ethnicitiesTop + id: id + PersonalNameOriginedOut: + probabilityCalibrated: 0.20549123661408064 + religionStatsSynthetic: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + explanation: explanation + script: script + regionOrigin: regionOrigin + topRegionOrigin: topRegionOrigin + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + subRegionOrigin: subRegionOrigin + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + countriesOriginTop: + - countriesOriginTop + - countriesOriginTop + id: id + countryOrigin: countryOrigin + countryOriginAlt: countryOriginAlt + script: script + - prime: true + country: + country: country + topRegion: topRegion + subRegion: subRegion + probabilityCalibrated: 0.20549123661408064 + countryAlt: countryAlt + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + countriesTop: + - countriesTop + - countriesTop + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + region: region + gender: + genderScale: -0.8398343619077977 + score: 60.27456183070403 + probabilityCalibrated: -0.706837403899411 + name: name + likelyGender: male + id: id + explanation: explanation + script: script + scoped: true + PersonalNameUSRaceEthnicityOut: + raceEthnicityAlt: W_NL + score: 8.008281904610115 + raceEthnicitiesTop: + - raceEthnicitiesTop + - raceEthnicitiesTop + probabilityCalibrated: 0.20549123661408064 + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + explanation: explanation + script: script + raceEthnicity: W_NL + PersonalNameDiasporaedOut: + probabilityCalibrated: 0.20549123661408064 + ethnicity: Chinese + lifted: true + ethnicityAlt: Japanese + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + countryIso2: countryIso2 + ethnicitiesTop: + - ethnicitiesTop + - ethnicitiesTop + id: id + PersonalNameOriginedOut: + probabilityCalibrated: 0.20549123661408064 + religionStatsSynthetic: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + explanation: explanation + script: script + regionOrigin: regionOrigin + topRegionOrigin: topRegionOrigin + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + subRegionOrigin: subRegionOrigin + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + countriesOriginTop: + - countriesOriginTop + - countriesOriginTop + id: id + countryOrigin: countryOrigin + countryOriginAlt: countryOriginAlt + script: script + properties: + engagementCandidates: + description: Classified community engagement candidates + items: + $ref: '#/components/schemas/CommunityEngageOut' + type: array + type: object + xml: + name: BatchCommunityEngageFullOut + APIServiceOut: + description: List of API Services + example: + costInUnits: 0 + serviceGroup: serviceGroup + serviceName: serviceName + properties: + serviceName: + description: A service name corresponds to classifier name in apiStatus + (ex. personalname_gender or personalfullname_gender) + type: string + serviceGroup: + description: Groups together classifiers providing a similar service (ex. + gender groups personalname_gender and personalfullname_gender) + type: string + costInUnits: + description: Indicates how many units per call this service costs (ex. the + number of units per name) + format: int32 + type: integer + type: object + xml: + name: APIServiceOut + NameMatchedOut: + description: Classified matched names + example: + score: 0.8008281904610115 + matchStatus: Match + id: id + explanation: explanation + script: script + properties: + script: + type: string + id: + type: string + explanation: + type: string + matchStatus: + description: The name matching status. + enum: + - Match + - Mismatch + type: string + score: + format: double + type: number + type: object + xml: + name: NameMatchedOut + BatchCommunityEngageOut: + example: + engagementCandidates: + - prime: true + country: + country: country + topRegion: topRegion + subRegion: subRegion + probabilityCalibrated: 0.20549123661408064 + countryAlt: countryAlt + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + countriesTop: + - countriesTop + - countriesTop + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + region: region + gender: + genderScale: -0.8398343619077977 + score: 60.27456183070403 + probabilityCalibrated: -0.706837403899411 + name: name + likelyGender: male + id: id + explanation: explanation + script: script + scoped: true + PersonalNameUSRaceEthnicityOut: + raceEthnicityAlt: W_NL + score: 8.008281904610115 + raceEthnicitiesTop: + - raceEthnicitiesTop + - raceEthnicitiesTop + probabilityCalibrated: 0.20549123661408064 + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + explanation: explanation + script: script + raceEthnicity: W_NL + PersonalNameDiasporaedOut: + probabilityCalibrated: 0.20549123661408064 + ethnicity: Chinese + lifted: true + ethnicityAlt: Japanese + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + countryIso2: countryIso2 + ethnicitiesTop: + - ethnicitiesTop + - ethnicitiesTop + id: id + PersonalNameOriginedOut: + probabilityCalibrated: 0.20549123661408064 + religionStatsSynthetic: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + explanation: explanation + script: script + regionOrigin: regionOrigin + topRegionOrigin: topRegionOrigin + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + subRegionOrigin: subRegionOrigin + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + countriesOriginTop: + - countriesOriginTop + - countriesOriginTop + id: id + countryOrigin: countryOrigin + countryOriginAlt: countryOriginAlt + script: script + - prime: true + country: + country: country + topRegion: topRegion + subRegion: subRegion + probabilityCalibrated: 0.20549123661408064 + countryAlt: countryAlt + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + countriesTop: + - countriesTop + - countriesTop + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + region: region + gender: + genderScale: -0.8398343619077977 + score: 60.27456183070403 + probabilityCalibrated: -0.706837403899411 + name: name + likelyGender: male + id: id + explanation: explanation + script: script + scoped: true + PersonalNameUSRaceEthnicityOut: + raceEthnicityAlt: W_NL + score: 8.008281904610115 + raceEthnicitiesTop: + - raceEthnicitiesTop + - raceEthnicitiesTop + probabilityCalibrated: 0.20549123661408064 + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + explanation: explanation + script: script + raceEthnicity: W_NL + PersonalNameDiasporaedOut: + probabilityCalibrated: 0.20549123661408064 + ethnicity: Chinese + lifted: true + ethnicityAlt: Japanese + explanation: explanation + script: script + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + id: id + countryIso2: countryIso2 + ethnicitiesTop: + - ethnicitiesTop + - ethnicitiesTop + id: id + PersonalNameOriginedOut: + probabilityCalibrated: 0.20549123661408064 + religionStatsSynthetic: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + explanation: explanation + script: script + regionOrigin: regionOrigin + topRegionOrigin: topRegionOrigin + religionStats: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + score: 8.008281904610115 + subRegionOrigin: subRegionOrigin + religionStatsAlt: + - pct: 5.962133916683182 + religion: religion + - pct: 5.962133916683182 + religion: religion + name: name + probabilityAltCalibrated: -0.706837403899411 + countriesOriginTop: + - countriesOriginTop + - countriesOriginTop + id: id + countryOrigin: countryOrigin + countryOriginAlt: countryOriginAlt + script: script + properties: + engagementCandidates: + description: Classified community engagement candidates + items: + $ref: '#/components/schemas/CommunityEngageOut' + type: array + type: object + xml: + name: BatchCommunityEngageOut securitySchemes: api_key: description: api_key required diff --git a/build.gradle b/build.gradle index 95cf32f4..278cd493 100644 --- a/build.gradle +++ b/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 { diff --git a/build.sbt b/build.sbt index 298aae2f..ace03167 100644 --- a/build.sbt +++ b/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"), diff --git a/docs/APIKeyOut.md b/docs/APIKeyOut.md index ffc233ee..a6e7d92b 100644 --- a/docs/APIKeyOut.md +++ b/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] | diff --git a/docs/AdminApi.md b/docs/AdminApi.md index cdc674e2..6c1b8d36 100644 --- a/docs/AdminApi.md +++ b/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* # **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 { # **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 | diff --git a/docs/BatchCommunityEngageFullOut.md b/docs/BatchCommunityEngageFullOut.md new file mode 100644 index 00000000..6ce52f5e --- /dev/null +++ b/docs/BatchCommunityEngageFullOut.md @@ -0,0 +1,13 @@ + + +# BatchCommunityEngageFullOut + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**engagementCandidates** | [**List<CommunityEngageOut>**](CommunityEngageOut.md) | Classified community engagement candidates | [optional] | + + + diff --git a/docs/BatchCommunityEngageOut.md b/docs/BatchCommunityEngageOut.md new file mode 100644 index 00000000..dd5385cc --- /dev/null +++ b/docs/BatchCommunityEngageOut.md @@ -0,0 +1,13 @@ + + +# BatchCommunityEngageOut + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**engagementCandidates** | [**List<CommunityEngageOut>**](CommunityEngageOut.md) | Classified community engagement candidates | [optional] | + + + diff --git a/docs/BatchFirstLastNameGeoOut.md b/docs/BatchFirstLastNameGeoOut.md new file mode 100644 index 00000000..968d9c65 --- /dev/null +++ b/docs/BatchFirstLastNameGeoOut.md @@ -0,0 +1,13 @@ + + +# BatchFirstLastNameGeoOut + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**personalNames** | [**List<FirstLastNameGeoOut>**](FirstLastNameGeoOut.md) | Classified names | [optional] | + + + diff --git a/docs/BatchPersonalNameDiasporaedOut.md b/docs/BatchPersonalNameDiasporaedOut.md new file mode 100644 index 00000000..fa9b8c8c --- /dev/null +++ b/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] | + + + diff --git a/docs/BatchPersonalNameOriginedOut.md b/docs/BatchPersonalNameOriginedOut.md new file mode 100644 index 00000000..276d80c1 --- /dev/null +++ b/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] | + + + diff --git a/docs/BatchPersonalNameUSRaceEthnicityOut.md b/docs/BatchPersonalNameUSRaceEthnicityOut.md new file mode 100644 index 00000000..4df6429f --- /dev/null +++ b/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] | + + + diff --git a/docs/CommunityEngageOptionOut.md b/docs/CommunityEngageOptionOut.md new file mode 100644 index 00000000..9ada8d89 --- /dev/null +++ b/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] | + + + diff --git a/docs/CommunityEngageOut.md b/docs/CommunityEngageOut.md new file mode 100644 index 00000000..7e5b5938 --- /dev/null +++ b/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] | + + + diff --git a/docs/FirstLastNameDiasporaedOut.md b/docs/FirstLastNameDiasporaedOut.md index 24effe37..3801b461 100644 --- a/docs/FirstLastNameDiasporaedOut.md +++ b/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] | diff --git a/docs/FirstLastNameGeoOut.md b/docs/FirstLastNameGeoOut.md new file mode 100644 index 00000000..e70944f9 --- /dev/null +++ b/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] | + + + diff --git a/docs/FirstLastNameOriginedOut.md b/docs/FirstLastNameOriginedOut.md index a5ee041e..594672a5 100644 --- a/docs/FirstLastNameOriginedOut.md +++ b/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] | diff --git a/docs/JapaneseApi.md b/docs/JapaneseApi.md index fd2550ca..f457b1be 100644 --- a/docs/JapaneseApi.md +++ b/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 { # **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 { # **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 diff --git a/docs/PersonalApi.md b/docs/PersonalApi.md index 32c8b038..fe5c5340 100644 --- a/docs/PersonalApi.md +++ b/docs/PersonalApi.md @@ -4,12 +4,20 @@ All URIs are relative to *https://v2.namsor.com/NamSorAPIv2* | Method | HTTP request | Description | |------------- | ------------- | -------------| +| [**communityEngage**](PersonalApi.md#communityEngage) | **GET** /api2/json/communityEngage/{countryIso2}/{firstName}/{lastName} | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) | +| [**communityEngageBatch**](PersonalApi.md#communityEngageBatch) | **POST** /api2/json/communityEngageBatch | Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) | +| [**communityEngageFull**](PersonalApi.md#communityEngageFull) | **GET** /api2/json/communityEngageFull/{countryIso2}/{personalNameFull} | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) | +| [**communityEngageFullBatch**](PersonalApi.md#communityEngageFullBatch) | **POST** /api2/json/communityEngageFullBatch | Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) | | [**corridor**](PersonalApi.md#corridor) | **GET** /api2/json/corridor/{countryIso2From}/{firstNameFrom}/{lastNameFrom}/{countryIso2To}/{firstNameTo}/{lastNameTo} | [USES 20 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com) | | [**corridorBatch**](PersonalApi.md#corridorBatch) | **POST** /api2/json/corridorBatch | [USES 20 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com) | | [**country**](PersonalApi.md#country) | **GET** /api2/json/country/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin. | | [**countryBatch**](PersonalApi.md#countryBatch) | **POST** /api2/json/countryBatch | [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin. | +| [**countryFnLn**](PersonalApi.md#countryFnLn) | **GET** /api2/json/countryFnLn/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal first / last name, or one surname. Assumes names as they are in the country of residence OR the country of origin. | +| [**countryFnLnBatch**](PersonalApi.md#countryFnLnBatch) | **POST** /api2/json/countryFnLnBatch | [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal first / last names, or surnames. Assumes names as they are in the country of residence OR the country of origin. | | [**diaspora**](PersonalApi.md#diaspora) | **GET** /api2/json/diaspora/{countryIso2}/{firstName}/{lastName} | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) | | [**diasporaBatch**](PersonalApi.md#diasporaBatch) | **POST** /api2/json/diasporaBatch | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) | +| [**diasporaFull**](PersonalApi.md#diasporaFull) | **GET** /api2/json/diasporaFull/{countryIso2}/{personalNameFull} | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) | +| [**diasporaFullBatch**](PersonalApi.md#diasporaFullBatch) | **POST** /api2/json/diasporaFullBatch | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) | | [**gender**](PersonalApi.md#gender) | **GET** /api2/json/gender/{firstName} | Infer the likely gender of a just a fiven name, assuming default 'US' local context. Please use preferably full names and local geographic context for better accuracy. | | [**gender1**](PersonalApi.md#gender1) | **GET** /api2/json/gender/{firstName}/{lastName} | Infer the likely gender of a name. | | [**genderBatch**](PersonalApi.md#genderBatch) | **POST** /api2/json/genderBatch | Infer the likely gender of up to 100 names, detecting automatically the cultural context. | @@ -21,6 +29,8 @@ All URIs are relative to *https://v2.namsor.com/NamSorAPIv2* | [**genderGeoBatch**](PersonalApi.md#genderGeoBatch) | **POST** /api2/json/genderGeoBatch | Infer the likely gender of up to 100 names, each given a local context (ISO2 country code). | | [**origin**](PersonalApi.md#origin) | **GET** /api2/json/origin/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead. | | [**originBatch**](PersonalApi.md#originBatch) | **POST** /api2/json/originBatch | [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context. | +| [**originFull**](PersonalApi.md#originFull) | **GET** /api2/json/originFull/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead. | +| [**originFullBatch**](PersonalApi.md#originFullBatch) | **POST** /api2/json/originFullBatch | [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context. | | [**parseName**](PersonalApi.md#parseName) | **GET** /api2/json/parseName/{nameFull} | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. | | [**parseNameBatch**](PersonalApi.md#parseNameBatch) | **POST** /api2/json/parseNameBatch | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. | | [**parseNameGeo**](PersonalApi.md#parseNameGeo) | **GET** /api2/json/parseName/{nameFull}/{countryIso2} | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. For better accuracy, provide a geographic context. | @@ -35,10 +45,296 @@ All URIs are relative to *https://v2.namsor.com/NamSorAPIv2* | [**subclassificationFullBatch**](PersonalApi.md#subclassificationFullBatch) | **POST** /api2/json/subclassificationFullBatch | [USES 10 UNITS PER NAME] Infer the likely origin of a list of up to 100 names at a country subclassification level (state or regeion). Initially, this is only supported for India (ISO2 code 'IN'). | | [**usRaceEthnicity**](PersonalApi.md#usRaceEthnicity) | **GET** /api2/json/usRaceEthnicity/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). | | [**usRaceEthnicityBatch**](PersonalApi.md#usRaceEthnicityBatch) | **POST** /api2/json/usRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). | +| [**usRaceEthnicityFull**](PersonalApi.md#usRaceEthnicityFull) | **GET** /api2/json/usRaceEthnicityFull/{personalNameFull} | [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). | +| [**usRaceEthnicityFullBatch**](PersonalApi.md#usRaceEthnicityFullBatch) | **POST** /api2/json/usRaceEthnicityFullBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). | | [**usRaceEthnicityZIP5**](PersonalApi.md#usRaceEthnicityZIP5) | **GET** /api2/json/usRaceEthnicityZIP5/{firstName}/{lastName}/{zip5Code} | [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). | | [**usZipRaceEthnicityBatch**](PersonalApi.md#usZipRaceEthnicityBatch) | **POST** /api2/json/usZipRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). | + +# **communityEngage** +> CommunityEngageOut communityEngage(countryIso2, firstName, lastName) + +[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + +### 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.invoke.models.*; +import com.namsor.sdk2.api.PersonalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://v2.namsor.com/NamSorAPIv2"); + + // 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"); + + PersonalApi apiInstance = new PersonalApi(defaultClient); + String countryIso2 = "countryIso2_example"; // String | + String firstName = "firstName_example"; // String | + String lastName = "lastName_example"; // String | + try { + CommunityEngageOut result = apiInstance.communityEngage(countryIso2, firstName, lastName); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PersonalApi#communityEngage"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **countryIso2** | **String**| | | +| **firstName** | **String**| | | +| **lastName** | **String**| | | + +### Return type + +[**CommunityEngageOut**](CommunityEngageOut.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A community engagement candidate. | - | +| **401** | Missing or incorrect API Key | - | +| **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | + + +# **communityEngageBatch** +> BatchCommunityEngageOut communityEngageBatch(batchFirstLastNameGeoIn) + +Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + +### 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.invoke.models.*; +import com.namsor.sdk2.api.PersonalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://v2.namsor.com/NamSorAPIv2"); + + // 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"); + + PersonalApi apiInstance = new PersonalApi(defaultClient); + BatchFirstLastNameGeoIn batchFirstLastNameGeoIn = new BatchFirstLastNameGeoIn(); // BatchFirstLastNameGeoIn | A list of personal names + try { + BatchCommunityEngageOut result = apiInstance.communityEngageBatch(batchFirstLastNameGeoIn); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PersonalApi#communityEngageBatch"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **batchFirstLastNameGeoIn** | [**BatchFirstLastNameGeoIn**](BatchFirstLastNameGeoIn.md)| A list of personal names | [optional] | + +### Return type + +[**BatchCommunityEngageOut**](BatchCommunityEngageOut.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A list of diaspora / ethnicity given a name and residency. | - | +| **401** | Missing or incorrect API Key | - | +| **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | +| **400** | Bad request (ex. too many names) | - | + + +# **communityEngageFull** +> CommunityEngageOut communityEngageFull(countryIso2, personalNameFull) + +[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + +### 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.invoke.models.*; +import com.namsor.sdk2.api.PersonalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://v2.namsor.com/NamSorAPIv2"); + + // 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"); + + PersonalApi apiInstance = new PersonalApi(defaultClient); + String countryIso2 = "countryIso2_example"; // String | + String personalNameFull = "personalNameFull_example"; // String | + try { + CommunityEngageOut result = apiInstance.communityEngageFull(countryIso2, personalNameFull); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PersonalApi#communityEngageFull"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **countryIso2** | **String**| | | +| **personalNameFull** | **String**| | | + +### Return type + +[**CommunityEngageOut**](CommunityEngageOut.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A community engagement candidate. | - | +| **401** | Missing or incorrect API Key | - | +| **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | + + +# **communityEngageFullBatch** +> BatchCommunityEngageFullOut communityEngageFullBatch(batchPersonalNameGeoIn) + +Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + +### 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.invoke.models.*; +import com.namsor.sdk2.api.PersonalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://v2.namsor.com/NamSorAPIv2"); + + // 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"); + + PersonalApi apiInstance = new PersonalApi(defaultClient); + BatchPersonalNameGeoIn batchPersonalNameGeoIn = new BatchPersonalNameGeoIn(); // BatchPersonalNameGeoIn | A list of personal names + try { + BatchCommunityEngageFullOut result = apiInstance.communityEngageFullBatch(batchPersonalNameGeoIn); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PersonalApi#communityEngageFullBatch"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **batchPersonalNameGeoIn** | [**BatchPersonalNameGeoIn**](BatchPersonalNameGeoIn.md)| A list of personal names | [optional] | + +### Return type + +[**BatchCommunityEngageFullOut**](BatchCommunityEngageFullOut.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A list cummunity engagement candidates. | - | +| **401** | Missing or incorrect API Key | - | +| **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | +| **400** | Bad request (ex. too many names) | - | + # **corridor** > CorridorOut corridor(countryIso2From, firstNameFrom, lastNameFrom, countryIso2To, firstNameTo, lastNameTo) @@ -322,7 +618,148 @@ public class Example { ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | A list of genderized names. | - | +| **200** | A list of origined names. | - | +| **401** | Missing or incorrect API Key | - | +| **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | +| **400** | Bad request (ex. too many names) | - | + + +# **countryFnLn** +> FirstLastNameOriginedOut countryFnLn(firstName, lastName) + +[USES 10 UNITS PER NAME] Infer the likely country of residence of a personal first / last name, or one surname. Assumes names as they are in the country of residence OR the country of origin. + +### 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.invoke.models.*; +import com.namsor.sdk2.api.PersonalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://v2.namsor.com/NamSorAPIv2"); + + // 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"); + + PersonalApi apiInstance = new PersonalApi(defaultClient); + String firstName = "firstName_example"; // String | + String lastName = "lastName_example"; // String | + try { + FirstLastNameOriginedOut result = apiInstance.countryFnLn(firstName, lastName); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PersonalApi#countryFnLn"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **firstName** | **String**| | | +| **lastName** | **String**| | | + +### Return type + +[**FirstLastNameOriginedOut**](FirstLastNameOriginedOut.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A origined name. | - | +| **401** | Missing or incorrect API Key | - | +| **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | + + +# **countryFnLnBatch** +> BatchFirstLastNameGeoOut countryFnLnBatch(batchFirstLastNameIn) + +[USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal first / last names, or surnames. Assumes names as they are in the country of residence OR the country of origin. + +### 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.invoke.models.*; +import com.namsor.sdk2.api.PersonalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://v2.namsor.com/NamSorAPIv2"); + + // 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"); + + PersonalApi apiInstance = new PersonalApi(defaultClient); + BatchFirstLastNameIn batchFirstLastNameIn = new BatchFirstLastNameIn(); // BatchFirstLastNameIn | A list of personal names + try { + BatchFirstLastNameGeoOut result = apiInstance.countryFnLnBatch(batchFirstLastNameIn); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PersonalApi#countryFnLnBatch"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **batchFirstLastNameIn** | [**BatchFirstLastNameIn**](BatchFirstLastNameIn.md)| A list of personal names | [optional] | + +### Return type + +[**BatchFirstLastNameGeoOut**](BatchFirstLastNameGeoOut.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A list of origined names. | - | | **401** | Missing or incorrect API Key | - | | **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | | **400** | Bad request (ex. too many names) | - | @@ -451,7 +888,148 @@ public class Example { ### Return type -[**BatchFirstLastNameDiasporaedOut**](BatchFirstLastNameDiasporaedOut.md) +[**BatchFirstLastNameDiasporaedOut**](BatchFirstLastNameDiasporaedOut.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A list of diaspora / ethnicity given a name and residency. | - | +| **401** | Missing or incorrect API Key | - | +| **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | +| **400** | Bad request (ex. too many names) | - | + + +# **diasporaFull** +> PersonalNameDiasporaedOut diasporaFull(countryIso2, personalNameFull) + +[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) + +### 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.invoke.models.*; +import com.namsor.sdk2.api.PersonalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://v2.namsor.com/NamSorAPIv2"); + + // 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"); + + PersonalApi apiInstance = new PersonalApi(defaultClient); + String countryIso2 = "countryIso2_example"; // String | + String personalNameFull = "personalNameFull_example"; // String | + try { + PersonalNameDiasporaedOut result = apiInstance.diasporaFull(countryIso2, personalNameFull); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PersonalApi#diasporaFull"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **countryIso2** | **String**| | | +| **personalNameFull** | **String**| | | + +### Return type + +[**PersonalNameDiasporaedOut**](PersonalNameDiasporaedOut.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A diaspora / ethnicity for given name and geography. | - | +| **401** | Missing or incorrect API Key | - | +| **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | + + +# **diasporaFullBatch** +> BatchPersonalNameDiasporaedOut diasporaFullBatch(batchPersonalNameGeoIn) + +[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) + +### 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.invoke.models.*; +import com.namsor.sdk2.api.PersonalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://v2.namsor.com/NamSorAPIv2"); + + // 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"); + + PersonalApi apiInstance = new PersonalApi(defaultClient); + BatchPersonalNameGeoIn batchPersonalNameGeoIn = new BatchPersonalNameGeoIn(); // BatchPersonalNameGeoIn | A list of personal names + try { + BatchPersonalNameDiasporaedOut result = apiInstance.diasporaFullBatch(batchPersonalNameGeoIn); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PersonalApi#diasporaFullBatch"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **batchPersonalNameGeoIn** | [**BatchPersonalNameGeoIn**](BatchPersonalNameGeoIn.md)| A list of personal names | [optional] | + +### Return type + +[**BatchPersonalNameDiasporaedOut**](BatchPersonalNameDiasporaedOut.md) ### Authorization @@ -1244,6 +1822,145 @@ public class Example { | **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | | **400** | Bad request (ex. too many names) | - | + +# **originFull** +> PersonalNameOriginedOut originFull(personalNameFull) + +[USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead. + +### 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.invoke.models.*; +import com.namsor.sdk2.api.PersonalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://v2.namsor.com/NamSorAPIv2"); + + // 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"); + + PersonalApi apiInstance = new PersonalApi(defaultClient); + String personalNameFull = "personalNameFull_example"; // String | + try { + PersonalNameOriginedOut result = apiInstance.originFull(personalNameFull); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PersonalApi#originFull"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **personalNameFull** | **String**| | | + +### Return type + +[**PersonalNameOriginedOut**](PersonalNameOriginedOut.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A origined name. | - | +| **401** | Missing or incorrect API Key | - | +| **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | + + +# **originFullBatch** +> BatchPersonalNameOriginedOut originFullBatch(batchPersonalNameIn) + +[USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context. + +### 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.invoke.models.*; +import com.namsor.sdk2.api.PersonalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://v2.namsor.com/NamSorAPIv2"); + + // 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"); + + PersonalApi apiInstance = new PersonalApi(defaultClient); + BatchPersonalNameIn batchPersonalNameIn = new BatchPersonalNameIn(); // BatchPersonalNameIn | A list of personal names + try { + BatchPersonalNameOriginedOut result = apiInstance.originFullBatch(batchPersonalNameIn); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PersonalApi#originFullBatch"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **batchPersonalNameIn** | [**BatchPersonalNameIn**](BatchPersonalNameIn.md)| A list of personal names | [optional] | + +### Return type + +[**BatchPersonalNameOriginedOut**](BatchPersonalNameOriginedOut.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A list of genderized names. | - | +| **401** | Missing or incorrect API Key | - | +| **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | +| **400** | Bad request (ex. too many names) | - | + # **parseName** > PersonalNameParsedOut parseName(nameFull) @@ -2237,6 +2954,145 @@ public class Example { | **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | | **400** | Bad request (ex. too many names) | - | + +# **usRaceEthnicityFull** +> PersonalNameUSRaceEthnicityOut usRaceEthnicityFull(personalNameFull) + +[USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). + +### 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.invoke.models.*; +import com.namsor.sdk2.api.PersonalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://v2.namsor.com/NamSorAPIv2"); + + // 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"); + + PersonalApi apiInstance = new PersonalApi(defaultClient); + String personalNameFull = "personalNameFull_example"; // String | + try { + PersonalNameUSRaceEthnicityOut result = apiInstance.usRaceEthnicityFull(personalNameFull); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PersonalApi#usRaceEthnicityFull"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **personalNameFull** | **String**| | | + +### Return type + +[**PersonalNameUSRaceEthnicityOut**](PersonalNameUSRaceEthnicityOut.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | a US resident's likely race/ethnicity : W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally | - | +| **401** | Missing or incorrect API Key | - | +| **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | + + +# **usRaceEthnicityFullBatch** +> BatchPersonalNameUSRaceEthnicityOut usRaceEthnicityFullBatch(batchPersonalNameGeoIn) + +[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). + +### 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.invoke.models.*; +import com.namsor.sdk2.api.PersonalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://v2.namsor.com/NamSorAPIv2"); + + // 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"); + + PersonalApi apiInstance = new PersonalApi(defaultClient); + BatchPersonalNameGeoIn batchPersonalNameGeoIn = new BatchPersonalNameGeoIn(); // BatchPersonalNameGeoIn | A list of personal names + try { + BatchPersonalNameUSRaceEthnicityOut result = apiInstance.usRaceEthnicityFullBatch(batchPersonalNameGeoIn); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling PersonalApi#usRaceEthnicityFullBatch"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| +| **batchPersonalNameGeoIn** | [**BatchPersonalNameGeoIn**](BatchPersonalNameGeoIn.md)| A list of personal names | [optional] | + +### Return type + +[**BatchPersonalNameUSRaceEthnicityOut**](BatchPersonalNameUSRaceEthnicityOut.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A list of US resident's likely race/ethnicity. W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally | - | +| **401** | Missing or incorrect API Key | - | +| **403** | Email not Verified, or API Limit Reached, or API Key Disabled | - | +| **400** | Bad request (ex. too many names) | - | + # **usRaceEthnicityZIP5** > FirstLastNameUSRaceEthnicityOut usRaceEthnicityZIP5(firstName, lastName, zip5Code) diff --git a/docs/PersonalNameDiasporaedOut.md b/docs/PersonalNameDiasporaedOut.md new file mode 100644 index 00000000..35f518a4 --- /dev/null +++ b/docs/PersonalNameDiasporaedOut.md @@ -0,0 +1,27 @@ + + +# PersonalNameDiasporaedOut + +Represents the output of inferring the LIKELY ethnicity from a personal name, given an country of residence. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**script** | **String** | | [optional] | +|**id** | **String** | | [optional] | +|**explanation** | **String** | | [optional] | +|**name** | **String** | The input name. | [optional] | +|**score** | **Double** | Compatibility to NamSor_v1 Diaspora score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] | +|**ethnicityAlt** | **String** | The second best alternative ethnicity | [optional] | +|**ethnicity** | **String** | The most likely ethnicity | [optional] | +|**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] | +|**religionStats** | [**List<ReligionStatOut>**](ReligionStatOut.md) | Geographic religious statistics, assuming ethnicity is correctly predicted. | [optional] | +|**religionStatsAlt** | [**List<ReligionStatOut>**](ReligionStatOut.md) | Geographic religious statistics, for country best alternative. | [optional] | + + + diff --git a/docs/PersonalNameGenderedOut.md b/docs/PersonalNameGenderedOut.md index b9ba64c4..bf3365d5 100644 --- a/docs/PersonalNameGenderedOut.md +++ b/docs/PersonalNameGenderedOut.md @@ -11,7 +11,7 @@ Classified genderized names |**script** | **String** | | [optional] | |**id** | **String** | | [optional] | |**explanation** | **String** | | [optional] | -|**name** | **String** | The input name | [optional] | +|**name** | **String** | The input name. | [optional] | |**likelyGender** | [**LikelyGenderEnum**](#LikelyGenderEnum) | Most likely gender | [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] | diff --git a/docs/PersonalNameGeoOut.md b/docs/PersonalNameGeoOut.md index ba09ec14..cd0fa216 100644 --- a/docs/PersonalNameGeoOut.md +++ b/docs/PersonalNameGeoOut.md @@ -2,7 +2,6 @@ # PersonalNameGeoOut -Classified geo names ## Properties @@ -22,7 +21,7 @@ Classified geo names |**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, assuming country OR best alternative is correctly predicted. | [optional] | +|**religionStatsAlt** | [**List<ReligionStatOut>**](ReligionStatOut.md) | Geographic religious statistics, for country best alternative. | [optional] | diff --git a/docs/PersonalNameGeoSubclassificationOut.md b/docs/PersonalNameGeoSubclassificationOut.md index 4d51097e..42ddd274 100644 --- a/docs/PersonalNameGeoSubclassificationOut.md +++ b/docs/PersonalNameGeoSubclassificationOut.md @@ -11,7 +11,7 @@ Classified names at sub country level (region or state) |**script** | **String** | | [optional] | |**id** | **String** | | [optional] | |**explanation** | **String** | | [optional] | -|**name** | **String** | The input name | [optional] | +|**name** | **String** | The input name. | [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] | diff --git a/docs/PersonalNameOriginedOut.md b/docs/PersonalNameOriginedOut.md new file mode 100644 index 00000000..34c33382 --- /dev/null +++ b/docs/PersonalNameOriginedOut.md @@ -0,0 +1,29 @@ + + +# PersonalNameOriginedOut + +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] | +|**name** | **String** | The input name. | [optional] | +|**countryOrigin** | **String** | Most likely country of Origin | [optional] | +|**countryOriginAlt** | **String** | Second best alternative : country of Origin | [optional] | +|**countriesOriginTop** | **List<String>** | List countries of Origin (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] | +|**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. -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, for country best alternative. | [optional] | +|**religionStatsSynthetic** | [**List<ReligionStatOut>**](ReligionStatOut.md) | Geographic religious statistics, assuming country of origin OR best alternative is correctly predicted. | [optional] | + + + diff --git a/docs/PersonalNameParsedOut.md b/docs/PersonalNameParsedOut.md index 85254e19..22aa203a 100644 --- a/docs/PersonalNameParsedOut.md +++ b/docs/PersonalNameParsedOut.md @@ -10,7 +10,7 @@ |**script** | **String** | | [optional] | |**id** | **String** | | [optional] | |**explanation** | **String** | | [optional] | -|**name** | **String** | The input name | [optional] | +|**name** | **String** | The input name. | [optional] | |**nameParserType** | [**NameParserTypeEnum**](#NameParserTypeEnum) | Name parsing is addressed as a classification problem, for example FN1LN1 means a first then last name order. | [optional] | |**nameParserTypeAlt** | [**NameParserTypeAltEnum**](#NameParserTypeAltEnum) | Second best alternative parsing. Name parsing is addressed as a classification problem, for example FN1LN1 means a first then last name order. | [optional] | |**firstLastName** | [**FirstLastNameOut**](FirstLastNameOut.md) | | [optional] | diff --git a/docs/PersonalNameReligionedOut.md b/docs/PersonalNameReligionedOut.md index 553f94ed..aa736f56 100644 --- a/docs/PersonalNameReligionedOut.md +++ b/docs/PersonalNameReligionedOut.md @@ -15,7 +15,7 @@ religious-coded names |**score** | **Double** | Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] | |**religion** | **String** | Most likely religion | [optional] | |**religionAlt** | **String** | Second best alternative : religion | [optional] | -|**religionsTop** | **List<String>** | List countries (top 10) | [optional] | +|**religionsTop** | **List<String>** | List religions (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] | diff --git a/docs/PersonalNameUSRaceEthnicityOut.md b/docs/PersonalNameUSRaceEthnicityOut.md new file mode 100644 index 00000000..30dd4916 --- /dev/null +++ b/docs/PersonalNameUSRaceEthnicityOut.md @@ -0,0 +1,49 @@ + + +# PersonalNameUSRaceEthnicityOut + +Represents the output of inferring the LIKELY US 'race/ethnicity' from a personal name, given US country of residence and (optionally) a ZIP5 code. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**script** | **String** | | [optional] | +|**id** | **String** | | [optional] | +|**explanation** | **String** | | [optional] | +|**name** | **String** | The input name. | [optional] | +|**raceEthnicityAlt** | [**RaceEthnicityAltEnum**](#RaceEthnicityAltEnum) | Second most likely US 'race'/ethnicity | [optional] | +|**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. -1 = still calibrating. | [optional] | +|**probabilityAltCalibrated** | **Double** | The calibrated probability for raceEthnicity OR raceEthnicityAlt to have been guessed correctly. -1 = still calibrating. | [optional] | + + + +## Enum: RaceEthnicityAltEnum + +| Name | Value | +|---- | -----| +| W_NL | "W_NL" | +| HL | "HL" | +| A | "A" | +| B_NL | "B_NL" | +| AI_AN | "AI_AN" | +| PI | "PI" | + + + +## Enum: RaceEthnicityEnum + +| Name | Value | +|---- | -----| +| W_NL | "W_NL" | +| HL | "HL" | +| A | "A" | +| B_NL | "B_NL" | +| AI_AN | "AI_AN" | +| PI | "PI" | + + + diff --git a/docs/ReligionStatOut.md b/docs/ReligionStatOut.md index b8abdf13..ad0eb611 100644 --- a/docs/ReligionStatOut.md +++ b/docs/ReligionStatOut.md @@ -2,7 +2,7 @@ # ReligionStatOut -Geographic religious statistics, assuming ethnicity OR best alternative is correctly predicted. +Geographic religious statistics, assuming country is correctly predicted. ## Properties diff --git a/pom.xml b/pom.xml index 0b0ae542..4e0a574d 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ namsor-sdk2 jar namsor-sdk2 - 2.0.27 + 2.0.29 https://github.com/openapitools/openapi-generator OpenAPI Java diff --git a/run-java.bash b/run-java.bash index 99b2689d..941401c6 100755 --- a/run-java.bash +++ b/run-java.bash @@ -2,7 +2,7 @@ echo update openapi-generator ./bin/utils/openapi-generator-cli.sh rm -Rf ./namsor/client/java/ echo run openapi-generator -java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate --git-repo-id namsor-java-sdk2 --git-user-id namsor --artifact-version 2.0.27 --group-id com.namsor --artifact-id namsor-sdk2 --invoker-package com.namsor.sdk2.invoke --model-package com.namsor.sdk2.model --api-package com.namsor.sdk2.api -i https://v2uk.namsor.com/NamSorAPIv2/api2/openapi.json -g java -o namsor/client/java +java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate --git-repo-id namsor-java-sdk2 --git-user-id namsor --artifact-version 2.0.29 --group-id com.namsor --artifact-id namsor-sdk2 --invoker-package com.namsor.sdk2.invoke --model-package com.namsor.sdk2.model --api-package com.namsor.sdk2.api -i https://v2uk.namsor.com/NamSorAPIv2/api2/openapi.json -g java -o namsor/client/java cd ./namsor/client/java/ mvn clean package cd target diff --git a/src/main/java/com/namsor/sdk2/api/AdminApi.java b/src/main/java/com/namsor/sdk2/api/AdminApi.java index b305239a..c33e08df 100644 --- a/src/main/java/com/namsor/sdk2/api/AdminApi.java +++ b/src/main/java/com/namsor/sdk2/api/AdminApi.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -85,7 +85,6 @@ public void setCustomBaseUrl(String customBaseUrl) { * Build call for anonymize * @param source (required) * @param anonymized (required) - * @param token (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -96,7 +95,7 @@ public void setCustomBaseUrl(String customBaseUrl) { 401 Missing or incorrect API Key - */ - public okhttp3.Call anonymizeCall(String source, Boolean anonymized, String token, final ApiCallback _callback) throws ApiException { + public okhttp3.Call anonymizeCall(String source, Boolean anonymized, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -113,10 +112,9 @@ public okhttp3.Call anonymizeCall(String source, Boolean anonymized, String toke Object localVarPostBody = null; // create path and map variables - String localVarPath = "/api2/json/anonymize/{source}/{anonymized}/{token}" + String localVarPath = "/api2/json/anonymize/{source}/{anonymized}" .replace("{" + "source" + "}", localVarApiClient.escapeString(source.toString())) - .replace("{" + "anonymized" + "}", localVarApiClient.escapeString(anonymized.toString())) - .replace("{" + "token" + "}", localVarApiClient.escapeString(token.toString())); + .replace("{" + "anonymized" + "}", localVarApiClient.escapeString(anonymized.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -125,7 +123,6 @@ public okhttp3.Call anonymizeCall(String source, Boolean anonymized, String toke Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/json" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -144,7 +141,7 @@ public okhttp3.Call anonymizeCall(String source, Boolean anonymized, String toke } @SuppressWarnings("rawtypes") - private okhttp3.Call anonymizeValidateBeforeCall(String source, Boolean anonymized, String token, final ApiCallback _callback) throws ApiException { + private okhttp3.Call anonymizeValidateBeforeCall(String source, Boolean anonymized, final ApiCallback _callback) throws ApiException { // verify the required parameter 'source' is set if (source == null) { throw new ApiException("Missing the required parameter 'source' when calling anonymize(Async)"); @@ -155,12 +152,7 @@ private okhttp3.Call anonymizeValidateBeforeCall(String source, Boolean anonymiz throw new ApiException("Missing the required parameter 'anonymized' when calling anonymize(Async)"); } - // verify the required parameter 'token' is set - if (token == null) { - throw new ApiException("Missing the required parameter 'token' when calling anonymize(Async)"); - } - - return anonymizeCall(source, anonymized, token, _callback); + return anonymizeCall(source, anonymized, _callback); } @@ -169,8 +161,6 @@ private okhttp3.Call anonymizeValidateBeforeCall(String source, Boolean anonymiz * * @param source (required) * @param anonymized (required) - * @param token (required) - * @return APIKeyOut * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -179,9 +169,8 @@ private okhttp3.Call anonymizeValidateBeforeCall(String source, Boolean anonymiz
401 Missing or incorrect API Key -
*/ - public APIKeyOut anonymize(String source, Boolean anonymized, String token) throws ApiException { - ApiResponse localVarResp = anonymizeWithHttpInfo(source, anonymized, token); - return localVarResp.getData(); + public void anonymize(String source, Boolean anonymized) throws ApiException { + anonymizeWithHttpInfo(source, anonymized); } /** @@ -189,8 +178,7 @@ public APIKeyOut anonymize(String source, Boolean anonymized, String token) thro * * @param source (required) * @param anonymized (required) - * @param token (required) - * @return ApiResponse<APIKeyOut> + * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -199,10 +187,9 @@ public APIKeyOut anonymize(String source, Boolean anonymized, String token) thro
401 Missing or incorrect API Key -
*/ - public ApiResponse anonymizeWithHttpInfo(String source, Boolean anonymized, String token) throws ApiException { - okhttp3.Call localVarCall = anonymizeValidateBeforeCall(source, anonymized, token, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); + public ApiResponse anonymizeWithHttpInfo(String source, Boolean anonymized) throws ApiException { + okhttp3.Call localVarCall = anonymizeValidateBeforeCall(source, anonymized, null); + return localVarApiClient.execute(localVarCall); } /** @@ -210,7 +197,6 @@ public ApiResponse anonymizeWithHttpInfo(String source, Boolean anony * * @param source (required) * @param anonymized (required) - * @param token (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 @@ -221,17 +207,17 @@ public ApiResponse anonymizeWithHttpInfo(String source, Boolean anony 401 Missing or incorrect API Key - */ - public okhttp3.Call anonymizeAsync(String source, Boolean anonymized, String token, final ApiCallback _callback) throws ApiException { + public okhttp3.Call anonymizeAsync(String source, Boolean anonymized, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = anonymizeValidateBeforeCall(source, anonymized, token, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + okhttp3.Call localVarCall = anonymizeValidateBeforeCall(source, anonymized, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } /** * Build call for anonymize1 * @param source (required) * @param anonymized (required) + * @param token (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -242,7 +228,7 @@ public okhttp3.Call anonymizeAsync(String source, Boolean anonymized, String tok 401 Missing or incorrect API Key - */ - public okhttp3.Call anonymize1Call(String source, Boolean anonymized, final ApiCallback _callback) throws ApiException { + public okhttp3.Call anonymize1Call(String source, Boolean anonymized, String token, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -259,9 +245,10 @@ public okhttp3.Call anonymize1Call(String source, Boolean anonymized, final ApiC Object localVarPostBody = null; // create path and map variables - String localVarPath = "/api2/json/anonymize/{source}/{anonymized}" + String localVarPath = "/api2/json/anonymize/{source}/{anonymized}/{token}" .replace("{" + "source" + "}", localVarApiClient.escapeString(source.toString())) - .replace("{" + "anonymized" + "}", localVarApiClient.escapeString(anonymized.toString())); + .replace("{" + "anonymized" + "}", localVarApiClient.escapeString(anonymized.toString())) + .replace("{" + "token" + "}", localVarApiClient.escapeString(token.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -270,6 +257,7 @@ public okhttp3.Call anonymize1Call(String source, Boolean anonymized, final ApiC Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { + "application/json" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -288,7 +276,7 @@ public okhttp3.Call anonymize1Call(String source, Boolean anonymized, final ApiC } @SuppressWarnings("rawtypes") - private okhttp3.Call anonymize1ValidateBeforeCall(String source, Boolean anonymized, final ApiCallback _callback) throws ApiException { + private okhttp3.Call anonymize1ValidateBeforeCall(String source, Boolean anonymized, String token, final ApiCallback _callback) throws ApiException { // verify the required parameter 'source' is set if (source == null) { throw new ApiException("Missing the required parameter 'source' when calling anonymize1(Async)"); @@ -299,7 +287,12 @@ private okhttp3.Call anonymize1ValidateBeforeCall(String source, Boolean anonymi throw new ApiException("Missing the required parameter 'anonymized' when calling anonymize1(Async)"); } - return anonymize1Call(source, anonymized, _callback); + // verify the required parameter 'token' is set + if (token == null) { + throw new ApiException("Missing the required parameter 'token' when calling anonymize1(Async)"); + } + + return anonymize1Call(source, anonymized, token, _callback); } @@ -308,6 +301,8 @@ private okhttp3.Call anonymize1ValidateBeforeCall(String source, Boolean anonymi * * @param source (required) * @param anonymized (required) + * @param token (required) + * @return APIKeyOut * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -316,8 +311,9 @@ private okhttp3.Call anonymize1ValidateBeforeCall(String source, Boolean anonymi
401 Missing or incorrect API Key -
*/ - public void anonymize1(String source, Boolean anonymized) throws ApiException { - anonymize1WithHttpInfo(source, anonymized); + public APIKeyOut anonymize1(String source, Boolean anonymized, String token) throws ApiException { + ApiResponse localVarResp = anonymize1WithHttpInfo(source, anonymized, token); + return localVarResp.getData(); } /** @@ -325,7 +321,8 @@ public void anonymize1(String source, Boolean anonymized) throws ApiException { * * @param source (required) * @param anonymized (required) - * @return ApiResponse<Void> + * @param token (required) + * @return ApiResponse<APIKeyOut> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -334,9 +331,10 @@ public void anonymize1(String source, Boolean anonymized) throws ApiException {
401 Missing or incorrect API Key -
*/ - public ApiResponse anonymize1WithHttpInfo(String source, Boolean anonymized) throws ApiException { - okhttp3.Call localVarCall = anonymize1ValidateBeforeCall(source, anonymized, null); - return localVarApiClient.execute(localVarCall); + public ApiResponse anonymize1WithHttpInfo(String source, Boolean anonymized, String token) throws ApiException { + okhttp3.Call localVarCall = anonymize1ValidateBeforeCall(source, anonymized, token, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); } /** @@ -344,6 +342,7 @@ public ApiResponse anonymize1WithHttpInfo(String source, Boolean anonymize * * @param source (required) * @param anonymized (required) + * @param token (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 @@ -354,10 +353,11 @@ public ApiResponse anonymize1WithHttpInfo(String source, Boolean anonymize 401 Missing or incorrect API Key - */ - public okhttp3.Call anonymize1Async(String source, Boolean anonymized, final ApiCallback _callback) throws ApiException { + public okhttp3.Call anonymize1Async(String source, Boolean anonymized, String token, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = anonymize1ValidateBeforeCall(source, anonymized, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); + okhttp3.Call localVarCall = anonymize1ValidateBeforeCall(source, anonymized, token, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** diff --git a/src/main/java/com/namsor/sdk2/api/ChineseApi.java b/src/main/java/com/namsor/sdk2/api/ChineseApi.java index 800a590d..51abceeb 100644 --- a/src/main/java/com/namsor/sdk2/api/ChineseApi.java +++ b/src/main/java/com/namsor/sdk2/api/ChineseApi.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/com/namsor/sdk2/api/GeneralApi.java b/src/main/java/com/namsor/sdk2/api/GeneralApi.java index 36728b41..5bbb786d 100644 --- a/src/main/java/com/namsor/sdk2/api/GeneralApi.java +++ b/src/main/java/com/namsor/sdk2/api/GeneralApi.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/com/namsor/sdk2/api/IndianApi.java b/src/main/java/com/namsor/sdk2/api/IndianApi.java index f7482afd..24c622e0 100644 --- a/src/main/java/com/namsor/sdk2/api/IndianApi.java +++ b/src/main/java/com/namsor/sdk2/api/IndianApi.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/com/namsor/sdk2/api/JapaneseApi.java b/src/main/java/com/namsor/sdk2/api/JapaneseApi.java index b7523acf..4ddc6d24 100644 --- a/src/main/java/com/namsor/sdk2/api/JapaneseApi.java +++ b/src/main/java/com/namsor/sdk2/api/JapaneseApi.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -753,6 +753,7 @@ public okhttp3.Call japaneseNameGenderKanjiCandidatesBatchAsync(BatchFirstLastNa * Build call for japaneseNameKanjiCandidates * @param japaneseSurnameLatin (required) * @param japaneseGivenNameLatin (required) + * @param knownGender (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -764,7 +765,7 @@ public okhttp3.Call japaneseNameGenderKanjiCandidatesBatchAsync(BatchFirstLastNa 403 Email not Verified, or API Limit Reached, or API Key Disabled - */ - public okhttp3.Call japaneseNameKanjiCandidatesCall(String japaneseSurnameLatin, String japaneseGivenNameLatin, final ApiCallback _callback) throws ApiException { + public okhttp3.Call japaneseNameKanjiCandidatesCall(String japaneseSurnameLatin, String japaneseGivenNameLatin, String knownGender, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -781,9 +782,10 @@ public okhttp3.Call japaneseNameKanjiCandidatesCall(String japaneseSurnameLatin, Object localVarPostBody = null; // create path and map variables - String localVarPath = "/api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}" + String localVarPath = "/api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{knownGender}" .replace("{" + "japaneseSurnameLatin" + "}", localVarApiClient.escapeString(japaneseSurnameLatin.toString())) - .replace("{" + "japaneseGivenNameLatin" + "}", localVarApiClient.escapeString(japaneseGivenNameLatin.toString())); + .replace("{" + "japaneseGivenNameLatin" + "}", localVarApiClient.escapeString(japaneseGivenNameLatin.toString())) + .replace("{" + "knownGender" + "}", localVarApiClient.escapeString(knownGender.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -811,7 +813,7 @@ public okhttp3.Call japaneseNameKanjiCandidatesCall(String japaneseSurnameLatin, } @SuppressWarnings("rawtypes") - private okhttp3.Call japaneseNameKanjiCandidatesValidateBeforeCall(String japaneseSurnameLatin, String japaneseGivenNameLatin, final ApiCallback _callback) throws ApiException { + private okhttp3.Call japaneseNameKanjiCandidatesValidateBeforeCall(String japaneseSurnameLatin, String japaneseGivenNameLatin, String knownGender, final ApiCallback _callback) throws ApiException { // verify the required parameter 'japaneseSurnameLatin' is set if (japaneseSurnameLatin == null) { throw new ApiException("Missing the required parameter 'japaneseSurnameLatin' when calling japaneseNameKanjiCandidates(Async)"); @@ -822,15 +824,21 @@ private okhttp3.Call japaneseNameKanjiCandidatesValidateBeforeCall(String japane throw new ApiException("Missing the required parameter 'japaneseGivenNameLatin' when calling japaneseNameKanjiCandidates(Async)"); } - return japaneseNameKanjiCandidatesCall(japaneseSurnameLatin, japaneseGivenNameLatin, _callback); + // verify the required parameter 'knownGender' is set + if (knownGender == null) { + throw new ApiException("Missing the required parameter 'knownGender' when calling japaneseNameKanjiCandidates(Async)"); + } + + return japaneseNameKanjiCandidatesCall(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender, _callback); } /** - * 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. * * @param japaneseSurnameLatin (required) * @param japaneseGivenNameLatin (required) + * @param knownGender (required) * @return NameMatchCandidatesOut * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -841,16 +849,17 @@ private okhttp3.Call japaneseNameKanjiCandidatesValidateBeforeCall(String japane 403 Email not Verified, or API Limit Reached, or API Key Disabled - */ - public NameMatchCandidatesOut japaneseNameKanjiCandidates(String japaneseSurnameLatin, String japaneseGivenNameLatin) throws ApiException { - ApiResponse localVarResp = japaneseNameKanjiCandidatesWithHttpInfo(japaneseSurnameLatin, japaneseGivenNameLatin); + public NameMatchCandidatesOut japaneseNameKanjiCandidates(String japaneseSurnameLatin, String japaneseGivenNameLatin, String knownGender) throws ApiException { + ApiResponse localVarResp = japaneseNameKanjiCandidatesWithHttpInfo(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender); return localVarResp.getData(); } /** - * 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. * * @param japaneseSurnameLatin (required) * @param japaneseGivenNameLatin (required) + * @param knownGender (required) * @return ApiResponse<NameMatchCandidatesOut> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -861,17 +870,18 @@ public NameMatchCandidatesOut japaneseNameKanjiCandidates(String japaneseSurname 403 Email not Verified, or API Limit Reached, or API Key Disabled - */ - public ApiResponse japaneseNameKanjiCandidatesWithHttpInfo(String japaneseSurnameLatin, String japaneseGivenNameLatin) throws ApiException { - okhttp3.Call localVarCall = japaneseNameKanjiCandidatesValidateBeforeCall(japaneseSurnameLatin, japaneseGivenNameLatin, null); + public ApiResponse japaneseNameKanjiCandidatesWithHttpInfo(String japaneseSurnameLatin, String japaneseGivenNameLatin, String knownGender) throws ApiException { + okhttp3.Call localVarCall = japaneseNameKanjiCandidatesValidateBeforeCall(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae (asynchronously) + * Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae - and a known gender. (asynchronously) * * @param japaneseSurnameLatin (required) * @param japaneseGivenNameLatin (required) + * @param knownGender (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 @@ -883,9 +893,9 @@ public ApiResponse japaneseNameKanjiCandidatesWithHttpIn 403 Email not Verified, or API Limit Reached, or API Key Disabled - */ - public okhttp3.Call japaneseNameKanjiCandidatesAsync(String japaneseSurnameLatin, String japaneseGivenNameLatin, final ApiCallback _callback) throws ApiException { + public okhttp3.Call japaneseNameKanjiCandidatesAsync(String japaneseSurnameLatin, String japaneseGivenNameLatin, String knownGender, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = japaneseNameKanjiCandidatesValidateBeforeCall(japaneseSurnameLatin, japaneseGivenNameLatin, _callback); + okhttp3.Call localVarCall = japaneseNameKanjiCandidatesValidateBeforeCall(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -894,7 +904,6 @@ public okhttp3.Call japaneseNameKanjiCandidatesAsync(String japaneseSurnameLatin * Build call for japaneseNameKanjiCandidates1 * @param japaneseSurnameLatin (required) * @param japaneseGivenNameLatin (required) - * @param knownGender (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -906,7 +915,7 @@ public okhttp3.Call japaneseNameKanjiCandidatesAsync(String japaneseSurnameLatin 403 Email not Verified, or API Limit Reached, or API Key Disabled - */ - public okhttp3.Call japaneseNameKanjiCandidates1Call(String japaneseSurnameLatin, String japaneseGivenNameLatin, String knownGender, final ApiCallback _callback) throws ApiException { + public okhttp3.Call japaneseNameKanjiCandidates1Call(String japaneseSurnameLatin, String japaneseGivenNameLatin, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -923,10 +932,9 @@ public okhttp3.Call japaneseNameKanjiCandidates1Call(String japaneseSurnameLatin Object localVarPostBody = null; // create path and map variables - String localVarPath = "/api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{knownGender}" + String localVarPath = "/api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}" .replace("{" + "japaneseSurnameLatin" + "}", localVarApiClient.escapeString(japaneseSurnameLatin.toString())) - .replace("{" + "japaneseGivenNameLatin" + "}", localVarApiClient.escapeString(japaneseGivenNameLatin.toString())) - .replace("{" + "knownGender" + "}", localVarApiClient.escapeString(knownGender.toString())); + .replace("{" + "japaneseGivenNameLatin" + "}", localVarApiClient.escapeString(japaneseGivenNameLatin.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -954,7 +962,7 @@ public okhttp3.Call japaneseNameKanjiCandidates1Call(String japaneseSurnameLatin } @SuppressWarnings("rawtypes") - private okhttp3.Call japaneseNameKanjiCandidates1ValidateBeforeCall(String japaneseSurnameLatin, String japaneseGivenNameLatin, String knownGender, final ApiCallback _callback) throws ApiException { + private okhttp3.Call japaneseNameKanjiCandidates1ValidateBeforeCall(String japaneseSurnameLatin, String japaneseGivenNameLatin, final ApiCallback _callback) throws ApiException { // verify the required parameter 'japaneseSurnameLatin' is set if (japaneseSurnameLatin == null) { throw new ApiException("Missing the required parameter 'japaneseSurnameLatin' when calling japaneseNameKanjiCandidates1(Async)"); @@ -965,21 +973,15 @@ private okhttp3.Call japaneseNameKanjiCandidates1ValidateBeforeCall(String japan throw new ApiException("Missing the required parameter 'japaneseGivenNameLatin' when calling japaneseNameKanjiCandidates1(Async)"); } - // verify the required parameter 'knownGender' is set - if (knownGender == null) { - throw new ApiException("Missing the required parameter 'knownGender' when calling japaneseNameKanjiCandidates1(Async)"); - } - - return japaneseNameKanjiCandidates1Call(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender, _callback); + return japaneseNameKanjiCandidates1Call(japaneseSurnameLatin, japaneseGivenNameLatin, _callback); } /** - * 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 * * @param japaneseSurnameLatin (required) * @param japaneseGivenNameLatin (required) - * @param knownGender (required) * @return NameMatchCandidatesOut * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -990,17 +992,16 @@ private okhttp3.Call japaneseNameKanjiCandidates1ValidateBeforeCall(String japan 403 Email not Verified, or API Limit Reached, or API Key Disabled - */ - public NameMatchCandidatesOut japaneseNameKanjiCandidates1(String japaneseSurnameLatin, String japaneseGivenNameLatin, String knownGender) throws ApiException { - ApiResponse localVarResp = japaneseNameKanjiCandidates1WithHttpInfo(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender); + public NameMatchCandidatesOut japaneseNameKanjiCandidates1(String japaneseSurnameLatin, String japaneseGivenNameLatin) throws ApiException { + ApiResponse localVarResp = japaneseNameKanjiCandidates1WithHttpInfo(japaneseSurnameLatin, japaneseGivenNameLatin); return localVarResp.getData(); } /** - * 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 * * @param japaneseSurnameLatin (required) * @param japaneseGivenNameLatin (required) - * @param knownGender (required) * @return ApiResponse<NameMatchCandidatesOut> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1011,18 +1012,17 @@ public NameMatchCandidatesOut japaneseNameKanjiCandidates1(String japaneseSurnam 403 Email not Verified, or API Limit Reached, or API Key Disabled - */ - public ApiResponse japaneseNameKanjiCandidates1WithHttpInfo(String japaneseSurnameLatin, String japaneseGivenNameLatin, String knownGender) throws ApiException { - okhttp3.Call localVarCall = japaneseNameKanjiCandidates1ValidateBeforeCall(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender, null); + public ApiResponse japaneseNameKanjiCandidates1WithHttpInfo(String japaneseSurnameLatin, String japaneseGivenNameLatin) throws ApiException { + okhttp3.Call localVarCall = japaneseNameKanjiCandidates1ValidateBeforeCall(japaneseSurnameLatin, japaneseGivenNameLatin, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae - and a known gender. (asynchronously) + * Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae (asynchronously) * * @param japaneseSurnameLatin (required) * @param japaneseGivenNameLatin (required) - * @param knownGender (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 @@ -1034,9 +1034,9 @@ public ApiResponse japaneseNameKanjiCandidates1WithHttpI 403 Email not Verified, or API Limit Reached, or API Key Disabled - */ - public okhttp3.Call japaneseNameKanjiCandidates1Async(String japaneseSurnameLatin, String japaneseGivenNameLatin, String knownGender, final ApiCallback _callback) throws ApiException { + public okhttp3.Call japaneseNameKanjiCandidates1Async(String japaneseSurnameLatin, String japaneseGivenNameLatin, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = japaneseNameKanjiCandidates1ValidateBeforeCall(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender, _callback); + okhttp3.Call localVarCall = japaneseNameKanjiCandidates1ValidateBeforeCall(japaneseSurnameLatin, japaneseGivenNameLatin, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; diff --git a/src/main/java/com/namsor/sdk2/api/PersonalApi.java b/src/main/java/com/namsor/sdk2/api/PersonalApi.java index 1958eb4a..f71117e1 100644 --- a/src/main/java/com/namsor/sdk2/api/PersonalApi.java +++ b/src/main/java/com/namsor/sdk2/api/PersonalApi.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -27,11 +27,14 @@ import java.io.IOException; +import com.namsor.sdk2.model.BatchCommunityEngageFullOut; +import com.namsor.sdk2.model.BatchCommunityEngageOut; import com.namsor.sdk2.model.BatchCorridorIn; import com.namsor.sdk2.model.BatchCorridorOut; import com.namsor.sdk2.model.BatchFirstLastNameDiasporaedOut; import com.namsor.sdk2.model.BatchFirstLastNameGenderedOut; import com.namsor.sdk2.model.BatchFirstLastNameGeoIn; +import com.namsor.sdk2.model.BatchFirstLastNameGeoOut; import com.namsor.sdk2.model.BatchFirstLastNameGeoSubclassificationOut; import com.namsor.sdk2.model.BatchFirstLastNameGeoSubdivisionIn; import com.namsor.sdk2.model.BatchFirstLastNameGeoZippedIn; @@ -39,14 +42,18 @@ import com.namsor.sdk2.model.BatchFirstLastNameOriginedOut; import com.namsor.sdk2.model.BatchFirstLastNameReligionedOut; import com.namsor.sdk2.model.BatchFirstLastNameUSRaceEthnicityOut; +import com.namsor.sdk2.model.BatchPersonalNameDiasporaedOut; import com.namsor.sdk2.model.BatchPersonalNameGenderedOut; import com.namsor.sdk2.model.BatchPersonalNameGeoIn; import com.namsor.sdk2.model.BatchPersonalNameGeoOut; import com.namsor.sdk2.model.BatchPersonalNameGeoSubclassificationOut; import com.namsor.sdk2.model.BatchPersonalNameGeoSubdivisionIn; import com.namsor.sdk2.model.BatchPersonalNameIn; +import com.namsor.sdk2.model.BatchPersonalNameOriginedOut; import com.namsor.sdk2.model.BatchPersonalNameParsedOut; import com.namsor.sdk2.model.BatchPersonalNameReligionedOut; +import com.namsor.sdk2.model.BatchPersonalNameUSRaceEthnicityOut; +import com.namsor.sdk2.model.CommunityEngageOut; import com.namsor.sdk2.model.CorridorOut; import com.namsor.sdk2.model.FirstLastNameDiasporaedOut; import com.namsor.sdk2.model.FirstLastNameGenderedOut; @@ -54,10 +61,13 @@ import com.namsor.sdk2.model.FirstLastNameOriginedOut; import com.namsor.sdk2.model.FirstLastNameReligionedOut; import com.namsor.sdk2.model.FirstLastNameUSRaceEthnicityOut; +import com.namsor.sdk2.model.PersonalNameDiasporaedOut; import com.namsor.sdk2.model.PersonalNameGenderedOut; import com.namsor.sdk2.model.PersonalNameGeoOut; +import com.namsor.sdk2.model.PersonalNameOriginedOut; import com.namsor.sdk2.model.PersonalNameParsedOut; import com.namsor.sdk2.model.PersonalNameReligionedOut; +import com.namsor.sdk2.model.PersonalNameUSRaceEthnicityOut; import java.lang.reflect.Type; import java.util.ArrayList; @@ -104,25 +114,22 @@ public void setCustomBaseUrl(String customBaseUrl) { } /** - * Build call for corridor - * @param countryIso2From (required) - * @param firstNameFrom (required) - * @param lastNameFrom (required) - * @param countryIso2To (required) - * @param firstNameTo (required) - * @param lastNameTo (required) + * Build call for communityEngage + * @param countryIso2 (required) + * @param firstName (required) + * @param lastName (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 Two classified names. -
200 A community engagement candidate. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
*/ - public okhttp3.Call corridorCall(String countryIso2From, String firstNameFrom, String lastNameFrom, String countryIso2To, String firstNameTo, String lastNameTo, final ApiCallback _callback) throws ApiException { + public okhttp3.Call communityEngageCall(String countryIso2, String firstName, String lastName, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -139,13 +146,10 @@ public okhttp3.Call corridorCall(String countryIso2From, String firstNameFrom, S Object localVarPostBody = null; // create path and map variables - String localVarPath = "/api2/json/corridor/{countryIso2From}/{firstNameFrom}/{lastNameFrom}/{countryIso2To}/{firstNameTo}/{lastNameTo}" - .replace("{" + "countryIso2From" + "}", localVarApiClient.escapeString(countryIso2From.toString())) - .replace("{" + "firstNameFrom" + "}", localVarApiClient.escapeString(firstNameFrom.toString())) - .replace("{" + "lastNameFrom" + "}", localVarApiClient.escapeString(lastNameFrom.toString())) - .replace("{" + "countryIso2To" + "}", localVarApiClient.escapeString(countryIso2To.toString())) - .replace("{" + "firstNameTo" + "}", localVarApiClient.escapeString(firstNameTo.toString())) - .replace("{" + "lastNameTo" + "}", localVarApiClient.escapeString(lastNameTo.toString())); + String localVarPath = "/api2/json/communityEngage/{countryIso2}/{firstName}/{lastName}" + .replace("{" + "countryIso2" + "}", localVarApiClient.escapeString(countryIso2.toString())) + .replace("{" + "firstName" + "}", localVarApiClient.escapeString(firstName.toString())) + .replace("{" + "lastName" + "}", localVarApiClient.escapeString(lastName.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -173,133 +177,1223 @@ public okhttp3.Call corridorCall(String countryIso2From, String firstNameFrom, S } @SuppressWarnings("rawtypes") - private okhttp3.Call corridorValidateBeforeCall(String countryIso2From, String firstNameFrom, String lastNameFrom, String countryIso2To, String firstNameTo, String lastNameTo, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'countryIso2From' is set - if (countryIso2From == null) { - throw new ApiException("Missing the required parameter 'countryIso2From' when calling corridor(Async)"); + private okhttp3.Call communityEngageValidateBeforeCall(String countryIso2, String firstName, String lastName, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'countryIso2' is set + if (countryIso2 == null) { + throw new ApiException("Missing the required parameter 'countryIso2' when calling communityEngage(Async)"); } - // verify the required parameter 'firstNameFrom' is set - if (firstNameFrom == null) { - throw new ApiException("Missing the required parameter 'firstNameFrom' when calling corridor(Async)"); + // verify the required parameter 'firstName' is set + if (firstName == null) { + throw new ApiException("Missing the required parameter 'firstName' when calling communityEngage(Async)"); } - // verify the required parameter 'lastNameFrom' is set - if (lastNameFrom == null) { - throw new ApiException("Missing the required parameter 'lastNameFrom' when calling corridor(Async)"); + // verify the required parameter 'lastName' is set + if (lastName == null) { + throw new ApiException("Missing the required parameter 'lastName' when calling communityEngage(Async)"); } - // verify the required parameter 'countryIso2To' is set - if (countryIso2To == null) { - throw new ApiException("Missing the required parameter 'countryIso2To' when calling corridor(Async)"); + return communityEngageCall(countryIso2, firstName, lastName, _callback); + + } + + /** + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + * + * @param countryIso2 (required) + * @param firstName (required) + * @param lastName (required) + * @return CommunityEngageOut + * @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 A community engagement candidate. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public CommunityEngageOut communityEngage(String countryIso2, String firstName, String lastName) throws ApiException { + ApiResponse localVarResp = communityEngageWithHttpInfo(countryIso2, firstName, lastName); + return localVarResp.getData(); + } + + /** + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + * + * @param countryIso2 (required) + * @param firstName (required) + * @param lastName (required) + * @return ApiResponse<CommunityEngageOut> + * @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 A community engagement candidate. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public ApiResponse communityEngageWithHttpInfo(String countryIso2, String firstName, String lastName) throws ApiException { + okhttp3.Call localVarCall = communityEngageValidateBeforeCall(countryIso2, firstName, lastName, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) (asynchronously) + * + * @param countryIso2 (required) + * @param firstName (required) + * @param lastName (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 A community engagement candidate. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public okhttp3.Call communityEngageAsync(String countryIso2, String firstName, String lastName, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = communityEngageValidateBeforeCall(countryIso2, firstName, lastName, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for communityEngageBatch + * @param batchFirstLastNameGeoIn A list of personal names (optional) + * @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 A list of diaspora / ethnicity given a name and residency. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public okhttp3.Call communityEngageBatchCall(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; } - // verify the required parameter 'firstNameTo' is set - if (firstNameTo == null) { - throw new ApiException("Missing the required parameter 'firstNameTo' when calling corridor(Async)"); + Object localVarPostBody = batchFirstLastNameGeoIn; + + // create path and map variables + String localVarPath = "/api2/json/communityEngageBatch"; + + 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); } - // verify the required parameter 'lastNameTo' is set - if (lastNameTo == null) { - throw new ApiException("Missing the required parameter 'lastNameTo' when calling corridor(Async)"); + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); } - return corridorCall(countryIso2From, firstNameFrom, lastNameFrom, countryIso2To, firstNameTo, lastNameTo, _callback); + String[] localVarAuthNames = new String[] { "api_key" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call communityEngageBatchValidateBeforeCall(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn, final ApiCallback _callback) throws ApiException { + return communityEngageBatchCall(batchFirstLastNameGeoIn, _callback); } /** - * [USES 20 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com) + * Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) * - * @param countryIso2From (required) - * @param firstNameFrom (required) - * @param lastNameFrom (required) - * @param countryIso2To (required) - * @param firstNameTo (required) - * @param lastNameTo (required) - * @return CorridorOut + * @param batchFirstLastNameGeoIn A list of personal names (optional) + * @return BatchCommunityEngageOut * @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 Two classified names. -
200 A list of diaspora / ethnicity given a name and residency. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public BatchCommunityEngageOut communityEngageBatch(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn) throws ApiException { + ApiResponse localVarResp = communityEngageBatchWithHttpInfo(batchFirstLastNameGeoIn); + return localVarResp.getData(); + } + + /** + * Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + * + * @param batchFirstLastNameGeoIn A list of personal names (optional) + * @return ApiResponse<BatchCommunityEngageOut> + * @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 A list of diaspora / ethnicity given a name and residency. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public ApiResponse communityEngageBatchWithHttpInfo(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn) throws ApiException { + okhttp3.Call localVarCall = communityEngageBatchValidateBeforeCall(batchFirstLastNameGeoIn, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) (asynchronously) + * + * @param batchFirstLastNameGeoIn A list of personal names (optional) + * @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 A list of diaspora / ethnicity given a name and residency. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public okhttp3.Call communityEngageBatchAsync(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = communityEngageBatchValidateBeforeCall(batchFirstLastNameGeoIn, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for communityEngageFull + * @param countryIso2 (required) + * @param personalNameFull (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 A community engagement candidate. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public okhttp3.Call communityEngageFullCall(String countryIso2, String personalNameFull, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/api2/json/communityEngageFull/{countryIso2}/{personalNameFull}" + .replace("{" + "countryIso2" + "}", localVarApiClient.escapeString(countryIso2.toString())) + .replace("{" + "personalNameFull" + "}", localVarApiClient.escapeString(personalNameFull.toString())); + + 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 = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "api_key" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call communityEngageFullValidateBeforeCall(String countryIso2, String personalNameFull, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'countryIso2' is set + if (countryIso2 == null) { + throw new ApiException("Missing the required parameter 'countryIso2' when calling communityEngageFull(Async)"); + } + + // verify the required parameter 'personalNameFull' is set + if (personalNameFull == null) { + throw new ApiException("Missing the required parameter 'personalNameFull' when calling communityEngageFull(Async)"); + } + + return communityEngageFullCall(countryIso2, personalNameFull, _callback); + + } + + /** + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + * + * @param countryIso2 (required) + * @param personalNameFull (required) + * @return CommunityEngageOut + * @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 A community engagement candidate. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public CommunityEngageOut communityEngageFull(String countryIso2, String personalNameFull) throws ApiException { + ApiResponse localVarResp = communityEngageFullWithHttpInfo(countryIso2, personalNameFull); + return localVarResp.getData(); + } + + /** + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + * + * @param countryIso2 (required) + * @param personalNameFull (required) + * @return ApiResponse<CommunityEngageOut> + * @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 A community engagement candidate. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public ApiResponse communityEngageFullWithHttpInfo(String countryIso2, String personalNameFull) throws ApiException { + okhttp3.Call localVarCall = communityEngageFullValidateBeforeCall(countryIso2, personalNameFull, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) (asynchronously) + * + * @param countryIso2 (required) + * @param personalNameFull (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 A community engagement candidate. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public okhttp3.Call communityEngageFullAsync(String countryIso2, String personalNameFull, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = communityEngageFullValidateBeforeCall(countryIso2, personalNameFull, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for communityEngageFullBatch + * @param batchPersonalNameGeoIn A list of personal names (optional) + * @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 A list cummunity engagement candidates. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public okhttp3.Call communityEngageFullBatchCall(BatchPersonalNameGeoIn batchPersonalNameGeoIn, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = batchPersonalNameGeoIn; + + // create path and map variables + String localVarPath = "/api2/json/communityEngageFullBatch"; + + 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); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "api_key" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call communityEngageFullBatchValidateBeforeCall(BatchPersonalNameGeoIn batchPersonalNameGeoIn, final ApiCallback _callback) throws ApiException { + return communityEngageFullBatchCall(batchPersonalNameGeoIn, _callback); + + } + + /** + * Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + * + * @param batchPersonalNameGeoIn A list of personal names (optional) + * @return BatchCommunityEngageFullOut + * @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 A list cummunity engagement candidates. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public BatchCommunityEngageFullOut communityEngageFullBatch(BatchPersonalNameGeoIn batchPersonalNameGeoIn) throws ApiException { + ApiResponse localVarResp = communityEngageFullBatchWithHttpInfo(batchPersonalNameGeoIn); + return localVarResp.getData(); + } + + /** + * Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + * + * @param batchPersonalNameGeoIn A list of personal names (optional) + * @return ApiResponse<BatchCommunityEngageFullOut> + * @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 A list cummunity engagement candidates. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public ApiResponse communityEngageFullBatchWithHttpInfo(BatchPersonalNameGeoIn batchPersonalNameGeoIn) throws ApiException { + okhttp3.Call localVarCall = communityEngageFullBatchValidateBeforeCall(batchPersonalNameGeoIn, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) (asynchronously) + * + * @param batchPersonalNameGeoIn A list of personal names (optional) + * @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 A list cummunity engagement candidates. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public okhttp3.Call communityEngageFullBatchAsync(BatchPersonalNameGeoIn batchPersonalNameGeoIn, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = communityEngageFullBatchValidateBeforeCall(batchPersonalNameGeoIn, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for corridor + * @param countryIso2From (required) + * @param firstNameFrom (required) + * @param lastNameFrom (required) + * @param countryIso2To (required) + * @param firstNameTo (required) + * @param lastNameTo (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 Two classified names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public okhttp3.Call corridorCall(String countryIso2From, String firstNameFrom, String lastNameFrom, String countryIso2To, String firstNameTo, String lastNameTo, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/api2/json/corridor/{countryIso2From}/{firstNameFrom}/{lastNameFrom}/{countryIso2To}/{firstNameTo}/{lastNameTo}" + .replace("{" + "countryIso2From" + "}", localVarApiClient.escapeString(countryIso2From.toString())) + .replace("{" + "firstNameFrom" + "}", localVarApiClient.escapeString(firstNameFrom.toString())) + .replace("{" + "lastNameFrom" + "}", localVarApiClient.escapeString(lastNameFrom.toString())) + .replace("{" + "countryIso2To" + "}", localVarApiClient.escapeString(countryIso2To.toString())) + .replace("{" + "firstNameTo" + "}", localVarApiClient.escapeString(firstNameTo.toString())) + .replace("{" + "lastNameTo" + "}", localVarApiClient.escapeString(lastNameTo.toString())); + + 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 = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "api_key" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call corridorValidateBeforeCall(String countryIso2From, String firstNameFrom, String lastNameFrom, String countryIso2To, String firstNameTo, String lastNameTo, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'countryIso2From' is set + if (countryIso2From == null) { + throw new ApiException("Missing the required parameter 'countryIso2From' when calling corridor(Async)"); + } + + // verify the required parameter 'firstNameFrom' is set + if (firstNameFrom == null) { + throw new ApiException("Missing the required parameter 'firstNameFrom' when calling corridor(Async)"); + } + + // verify the required parameter 'lastNameFrom' is set + if (lastNameFrom == null) { + throw new ApiException("Missing the required parameter 'lastNameFrom' when calling corridor(Async)"); + } + + // verify the required parameter 'countryIso2To' is set + if (countryIso2To == null) { + throw new ApiException("Missing the required parameter 'countryIso2To' when calling corridor(Async)"); + } + + // verify the required parameter 'firstNameTo' is set + if (firstNameTo == null) { + throw new ApiException("Missing the required parameter 'firstNameTo' when calling corridor(Async)"); + } + + // verify the required parameter 'lastNameTo' is set + if (lastNameTo == null) { + throw new ApiException("Missing the required parameter 'lastNameTo' when calling corridor(Async)"); + } + + return corridorCall(countryIso2From, firstNameFrom, lastNameFrom, countryIso2To, firstNameTo, lastNameTo, _callback); + + } + + /** + * [USES 20 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com) + * + * @param countryIso2From (required) + * @param firstNameFrom (required) + * @param lastNameFrom (required) + * @param countryIso2To (required) + * @param firstNameTo (required) + * @param lastNameTo (required) + * @return CorridorOut + * @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 Two classified names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public CorridorOut corridor(String countryIso2From, String firstNameFrom, String lastNameFrom, String countryIso2To, String firstNameTo, String lastNameTo) throws ApiException { + ApiResponse localVarResp = corridorWithHttpInfo(countryIso2From, firstNameFrom, lastNameFrom, countryIso2To, firstNameTo, lastNameTo); + return localVarResp.getData(); + } + + /** + * [USES 20 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com) + * + * @param countryIso2From (required) + * @param firstNameFrom (required) + * @param lastNameFrom (required) + * @param countryIso2To (required) + * @param firstNameTo (required) + * @param lastNameTo (required) + * @return ApiResponse<CorridorOut> + * @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 Two classified names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public ApiResponse corridorWithHttpInfo(String countryIso2From, String firstNameFrom, String lastNameFrom, String countryIso2To, String firstNameTo, String lastNameTo) throws ApiException { + okhttp3.Call localVarCall = corridorValidateBeforeCall(countryIso2From, firstNameFrom, lastNameFrom, countryIso2To, firstNameTo, lastNameTo, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * [USES 20 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com) (asynchronously) + * + * @param countryIso2From (required) + * @param firstNameFrom (required) + * @param lastNameFrom (required) + * @param countryIso2To (required) + * @param firstNameTo (required) + * @param lastNameTo (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 Two classified names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public okhttp3.Call corridorAsync(String countryIso2From, String firstNameFrom, String lastNameFrom, String countryIso2To, String firstNameTo, String lastNameTo, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = corridorValidateBeforeCall(countryIso2From, firstNameFrom, lastNameFrom, countryIso2To, firstNameTo, lastNameTo, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for corridorBatch + * @param batchCorridorIn A list of name pairs, with country code (nameFrom -> nameTo). (optional) + * @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 A list of classified name pairs. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public okhttp3.Call corridorBatchCall(BatchCorridorIn batchCorridorIn, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = batchCorridorIn; + + // create path and map variables + String localVarPath = "/api2/json/corridorBatch"; + + 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); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "api_key" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call corridorBatchValidateBeforeCall(BatchCorridorIn batchCorridorIn, final ApiCallback _callback) throws ApiException { + return corridorBatchCall(batchCorridorIn, _callback); + + } + + /** + * [USES 20 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com) + * + * @param batchCorridorIn A list of name pairs, with country code (nameFrom -> nameTo). (optional) + * @return BatchCorridorOut + * @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 A list of classified name pairs. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public BatchCorridorOut corridorBatch(BatchCorridorIn batchCorridorIn) throws ApiException { + ApiResponse localVarResp = corridorBatchWithHttpInfo(batchCorridorIn); + return localVarResp.getData(); + } + + /** + * [USES 20 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com) + * + * @param batchCorridorIn A list of name pairs, with country code (nameFrom -> nameTo). (optional) + * @return ApiResponse<BatchCorridorOut> + * @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 A list of classified name pairs. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public ApiResponse corridorBatchWithHttpInfo(BatchCorridorIn batchCorridorIn) throws ApiException { + okhttp3.Call localVarCall = corridorBatchValidateBeforeCall(batchCorridorIn, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * [USES 20 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com) (asynchronously) + * + * @param batchCorridorIn A list of name pairs, with country code (nameFrom -> nameTo). (optional) + * @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 A list of classified name pairs. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public okhttp3.Call corridorBatchAsync(BatchCorridorIn batchCorridorIn, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = corridorBatchValidateBeforeCall(batchCorridorIn, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for country + * @param personalNameFull (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 A origined name. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public okhttp3.Call countryCall(String personalNameFull, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/api2/json/country/{personalNameFull}" + .replace("{" + "personalNameFull" + "}", localVarApiClient.escapeString(personalNameFull.toString())); + + 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 = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "api_key" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call countryValidateBeforeCall(String personalNameFull, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'personalNameFull' is set + if (personalNameFull == null) { + throw new ApiException("Missing the required parameter 'personalNameFull' when calling country(Async)"); + } + + return countryCall(personalNameFull, _callback); + + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin. + * + * @param personalNameFull (required) + * @return PersonalNameGeoOut + * @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 A origined name. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public PersonalNameGeoOut country(String personalNameFull) throws ApiException { + ApiResponse localVarResp = countryWithHttpInfo(personalNameFull); + return localVarResp.getData(); + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin. + * + * @param personalNameFull (required) + * @return ApiResponse<PersonalNameGeoOut> + * @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 A origined name. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public ApiResponse countryWithHttpInfo(String personalNameFull) throws ApiException { + okhttp3.Call localVarCall = countryValidateBeforeCall(personalNameFull, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin. (asynchronously) + * + * @param personalNameFull (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 A origined name. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public okhttp3.Call countryAsync(String personalNameFull, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = countryValidateBeforeCall(personalNameFull, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for countryBatch + * @param batchPersonalNameIn A list of personal names (optional) + * @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 A list of origined names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public okhttp3.Call countryBatchCall(BatchPersonalNameIn batchPersonalNameIn, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = batchPersonalNameIn; + + // create path and map variables + String localVarPath = "/api2/json/countryBatch"; + + 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); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "api_key" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call countryBatchValidateBeforeCall(BatchPersonalNameIn batchPersonalNameIn, final ApiCallback _callback) throws ApiException { + return countryBatchCall(batchPersonalNameIn, _callback); + + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin. + * + * @param batchPersonalNameIn A list of personal names (optional) + * @return BatchPersonalNameGeoOut + * @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 A list of origined names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public BatchPersonalNameGeoOut countryBatch(BatchPersonalNameIn batchPersonalNameIn) throws ApiException { + ApiResponse localVarResp = countryBatchWithHttpInfo(batchPersonalNameIn); + return localVarResp.getData(); + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin. + * + * @param batchPersonalNameIn A list of personal names (optional) + * @return ApiResponse<BatchPersonalNameGeoOut> + * @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 A list of origined names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public ApiResponse countryBatchWithHttpInfo(BatchPersonalNameIn batchPersonalNameIn) throws ApiException { + okhttp3.Call localVarCall = countryBatchValidateBeforeCall(batchPersonalNameIn, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin. (asynchronously) + * + * @param batchPersonalNameIn A list of personal names (optional) + * @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 A list of origined names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public okhttp3.Call countryBatchAsync(BatchPersonalNameIn batchPersonalNameIn, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = countryBatchValidateBeforeCall(batchPersonalNameIn, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for countryFnLn + * @param firstName (required) + * @param lastName (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 A origined name. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public okhttp3.Call countryFnLnCall(String firstName, String lastName, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/api2/json/countryFnLn/{firstName}/{lastName}" + .replace("{" + "firstName" + "}", localVarApiClient.escapeString(firstName.toString())) + .replace("{" + "lastName" + "}", localVarApiClient.escapeString(lastName.toString())); + + 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 = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "api_key" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call countryFnLnValidateBeforeCall(String firstName, String lastName, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'firstName' is set + if (firstName == null) { + throw new ApiException("Missing the required parameter 'firstName' when calling countryFnLn(Async)"); + } + + // verify the required parameter 'lastName' is set + if (lastName == null) { + throw new ApiException("Missing the required parameter 'lastName' when calling countryFnLn(Async)"); + } + + return countryFnLnCall(firstName, lastName, _callback); + + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal first / last name, or one surname. Assumes names as they are in the country of residence OR the country of origin. + * + * @param firstName (required) + * @param lastName (required) + * @return FirstLastNameOriginedOut + * @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 A origined name. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
*/ - public CorridorOut corridor(String countryIso2From, String firstNameFrom, String lastNameFrom, String countryIso2To, String firstNameTo, String lastNameTo) throws ApiException { - ApiResponse localVarResp = corridorWithHttpInfo(countryIso2From, firstNameFrom, lastNameFrom, countryIso2To, firstNameTo, lastNameTo); + public FirstLastNameOriginedOut countryFnLn(String firstName, String lastName) throws ApiException { + ApiResponse localVarResp = countryFnLnWithHttpInfo(firstName, lastName); return localVarResp.getData(); } /** - * [USES 20 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com) + * [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal first / last name, or one surname. Assumes names as they are in the country of residence OR the country of origin. * - * @param countryIso2From (required) - * @param firstNameFrom (required) - * @param lastNameFrom (required) - * @param countryIso2To (required) - * @param firstNameTo (required) - * @param lastNameTo (required) - * @return ApiResponse<CorridorOut> + * @param firstName (required) + * @param lastName (required) + * @return ApiResponse<FirstLastNameOriginedOut> * @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 Two classified names. -
200 A origined name. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
*/ - public ApiResponse corridorWithHttpInfo(String countryIso2From, String firstNameFrom, String lastNameFrom, String countryIso2To, String firstNameTo, String lastNameTo) throws ApiException { - okhttp3.Call localVarCall = corridorValidateBeforeCall(countryIso2From, firstNameFrom, lastNameFrom, countryIso2To, firstNameTo, lastNameTo, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse countryFnLnWithHttpInfo(String firstName, String lastName) throws ApiException { + okhttp3.Call localVarCall = countryFnLnValidateBeforeCall(firstName, lastName, null); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * [USES 20 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com) (asynchronously) + * [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal first / last name, or one surname. Assumes names as they are in the country of residence OR the country of origin. (asynchronously) * - * @param countryIso2From (required) - * @param firstNameFrom (required) - * @param lastNameFrom (required) - * @param countryIso2To (required) - * @param firstNameTo (required) - * @param lastNameTo (required) + * @param firstName (required) + * @param lastName (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 Two classified names. -
200 A origined name. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
*/ - public okhttp3.Call corridorAsync(String countryIso2From, String firstNameFrom, String lastNameFrom, String countryIso2To, String firstNameTo, String lastNameTo, final ApiCallback _callback) throws ApiException { + public okhttp3.Call countryFnLnAsync(String firstName, String lastName, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = corridorValidateBeforeCall(countryIso2From, firstNameFrom, lastNameFrom, countryIso2To, firstNameTo, lastNameTo, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + okhttp3.Call localVarCall = countryFnLnValidateBeforeCall(firstName, lastName, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for corridorBatch - * @param batchCorridorIn A list of name pairs, with country code (nameFrom -> nameTo). (optional) + * Build call for countryFnLnBatch + * @param batchFirstLastNameIn A list of personal names (optional) * @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 A list of classified name pairs. -
200 A list of origined names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
*/ - public okhttp3.Call corridorBatchCall(BatchCorridorIn batchCorridorIn, final ApiCallback _callback) throws ApiException { + public okhttp3.Call countryFnLnBatchCall(BatchFirstLastNameIn batchFirstLastNameIn, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -313,10 +1407,10 @@ public okhttp3.Call corridorBatchCall(BatchCorridorIn batchCorridorIn, final Api basePath = null; } - Object localVarPostBody = batchCorridorIn; + Object localVarPostBody = batchFirstLastNameIn; // create path and map variables - String localVarPath = "/api2/json/corridorBatch"; + String localVarPath = "/api2/json/countryFnLnBatch"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -345,90 +1439,92 @@ public okhttp3.Call corridorBatchCall(BatchCorridorIn batchCorridorIn, final Api } @SuppressWarnings("rawtypes") - private okhttp3.Call corridorBatchValidateBeforeCall(BatchCorridorIn batchCorridorIn, final ApiCallback _callback) throws ApiException { - return corridorBatchCall(batchCorridorIn, _callback); + private okhttp3.Call countryFnLnBatchValidateBeforeCall(BatchFirstLastNameIn batchFirstLastNameIn, final ApiCallback _callback) throws ApiException { + return countryFnLnBatchCall(batchFirstLastNameIn, _callback); } /** - * [USES 20 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com) + * [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal first / last names, or surnames. Assumes names as they are in the country of residence OR the country of origin. * - * @param batchCorridorIn A list of name pairs, with country code (nameFrom -> nameTo). (optional) - * @return BatchCorridorOut + * @param batchFirstLastNameIn A list of personal names (optional) + * @return BatchFirstLastNameGeoOut * @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 A list of classified name pairs. -
200 A list of origined names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
*/ - public BatchCorridorOut corridorBatch(BatchCorridorIn batchCorridorIn) throws ApiException { - ApiResponse localVarResp = corridorBatchWithHttpInfo(batchCorridorIn); + public BatchFirstLastNameGeoOut countryFnLnBatch(BatchFirstLastNameIn batchFirstLastNameIn) throws ApiException { + ApiResponse localVarResp = countryFnLnBatchWithHttpInfo(batchFirstLastNameIn); return localVarResp.getData(); } /** - * [USES 20 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com) + * [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal first / last names, or surnames. Assumes names as they are in the country of residence OR the country of origin. * - * @param batchCorridorIn A list of name pairs, with country code (nameFrom -> nameTo). (optional) - * @return ApiResponse<BatchCorridorOut> + * @param batchFirstLastNameIn A list of personal names (optional) + * @return ApiResponse<BatchFirstLastNameGeoOut> * @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 A list of classified name pairs. -
200 A list of origined names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
*/ - public ApiResponse corridorBatchWithHttpInfo(BatchCorridorIn batchCorridorIn) throws ApiException { - okhttp3.Call localVarCall = corridorBatchValidateBeforeCall(batchCorridorIn, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse countryFnLnBatchWithHttpInfo(BatchFirstLastNameIn batchFirstLastNameIn) throws ApiException { + okhttp3.Call localVarCall = countryFnLnBatchValidateBeforeCall(batchFirstLastNameIn, null); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * [USES 20 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com) (asynchronously) + * [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal first / last names, or surnames. Assumes names as they are in the country of residence OR the country of origin. (asynchronously) * - * @param batchCorridorIn A list of name pairs, with country code (nameFrom -> nameTo). (optional) + * @param batchFirstLastNameIn A list of personal names (optional) * @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 A list of classified name pairs. -
200 A list of origined names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
*/ - public okhttp3.Call corridorBatchAsync(BatchCorridorIn batchCorridorIn, final ApiCallback _callback) throws ApiException { + public okhttp3.Call countryFnLnBatchAsync(BatchFirstLastNameIn batchFirstLastNameIn, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = corridorBatchValidateBeforeCall(batchCorridorIn, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + okhttp3.Call localVarCall = countryFnLnBatchValidateBeforeCall(batchFirstLastNameIn, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for country - * @param personalNameFull (required) + * Build call for diaspora + * @param countryIso2 (required) + * @param firstName (required) + * @param lastName (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 A origined name. -
200 A diaspora / ethnicity for given name and geography. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
*/ - public okhttp3.Call countryCall(String personalNameFull, final ApiCallback _callback) throws ApiException { + public okhttp3.Call diasporaCall(String countryIso2, String firstName, String lastName, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -445,8 +1541,10 @@ public okhttp3.Call countryCall(String personalNameFull, final ApiCallback _call Object localVarPostBody = null; // create path and map variables - String localVarPath = "/api2/json/country/{personalNameFull}" - .replace("{" + "personalNameFull" + "}", localVarApiClient.escapeString(personalNameFull.toString())); + String localVarPath = "/api2/json/diaspora/{countryIso2}/{firstName}/{lastName}" + .replace("{" + "countryIso2" + "}", localVarApiClient.escapeString(countryIso2.toString())) + .replace("{" + "firstName" + "}", localVarApiClient.escapeString(firstName.toString())) + .replace("{" + "lastName" + "}", localVarApiClient.escapeString(lastName.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -474,93 +1572,109 @@ public okhttp3.Call countryCall(String personalNameFull, final ApiCallback _call } @SuppressWarnings("rawtypes") - private okhttp3.Call countryValidateBeforeCall(String personalNameFull, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'personalNameFull' is set - if (personalNameFull == null) { - throw new ApiException("Missing the required parameter 'personalNameFull' when calling country(Async)"); + private okhttp3.Call diasporaValidateBeforeCall(String countryIso2, String firstName, String lastName, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'countryIso2' is set + if (countryIso2 == null) { + throw new ApiException("Missing the required parameter 'countryIso2' when calling diaspora(Async)"); } - return countryCall(personalNameFull, _callback); + // verify the required parameter 'firstName' is set + if (firstName == null) { + throw new ApiException("Missing the required parameter 'firstName' when calling diaspora(Async)"); + } + + // verify the required parameter 'lastName' is set + if (lastName == null) { + throw new ApiException("Missing the required parameter 'lastName' when calling diaspora(Async)"); + } + + return diasporaCall(countryIso2, firstName, lastName, _callback); } /** - * [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin. + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) * - * @param personalNameFull (required) - * @return PersonalNameGeoOut + * @param countryIso2 (required) + * @param firstName (required) + * @param lastName (required) + * @return FirstLastNameDiasporaedOut * @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 A origined name. -
200 A diaspora / ethnicity for given name and geography. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
*/ - public PersonalNameGeoOut country(String personalNameFull) throws ApiException { - ApiResponse localVarResp = countryWithHttpInfo(personalNameFull); + public FirstLastNameDiasporaedOut diaspora(String countryIso2, String firstName, String lastName) throws ApiException { + ApiResponse localVarResp = diasporaWithHttpInfo(countryIso2, firstName, lastName); return localVarResp.getData(); } /** - * [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin. + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) * - * @param personalNameFull (required) - * @return ApiResponse<PersonalNameGeoOut> + * @param countryIso2 (required) + * @param firstName (required) + * @param lastName (required) + * @return ApiResponse<FirstLastNameDiasporaedOut> * @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 A origined name. -
200 A diaspora / ethnicity for given name and geography. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
*/ - public ApiResponse countryWithHttpInfo(String personalNameFull) throws ApiException { - okhttp3.Call localVarCall = countryValidateBeforeCall(personalNameFull, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse diasporaWithHttpInfo(String countryIso2, String firstName, String lastName) throws ApiException { + okhttp3.Call localVarCall = diasporaValidateBeforeCall(countryIso2, firstName, lastName, null); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin. (asynchronously) + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) (asynchronously) * - * @param personalNameFull (required) + * @param countryIso2 (required) + * @param firstName (required) + * @param lastName (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 A origined name. -
200 A diaspora / ethnicity for given name and geography. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
*/ - public okhttp3.Call countryAsync(String personalNameFull, final ApiCallback _callback) throws ApiException { + public okhttp3.Call diasporaAsync(String countryIso2, String firstName, String lastName, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = countryValidateBeforeCall(personalNameFull, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + okhttp3.Call localVarCall = diasporaValidateBeforeCall(countryIso2, firstName, lastName, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for countryBatch - * @param batchPersonalNameIn A list of personal names (optional) + * Build call for diasporaBatch + * @param batchFirstLastNameGeoIn A list of personal names (optional) * @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 A list of genderized names. -
200 A list of diaspora / ethnicity given a name and residency. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
*/ - public okhttp3.Call countryBatchCall(BatchPersonalNameIn batchPersonalNameIn, final ApiCallback _callback) throws ApiException { + public okhttp3.Call diasporaBatchCall(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -574,10 +1688,10 @@ public okhttp3.Call countryBatchCall(BatchPersonalNameIn batchPersonalNameIn, fi basePath = null; } - Object localVarPostBody = batchPersonalNameIn; + Object localVarPostBody = batchFirstLastNameGeoIn; // create path and map variables - String localVarPath = "/api2/json/countryBatch"; + String localVarPath = "/api2/json/diasporaBatch"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -606,80 +1720,79 @@ public okhttp3.Call countryBatchCall(BatchPersonalNameIn batchPersonalNameIn, fi } @SuppressWarnings("rawtypes") - private okhttp3.Call countryBatchValidateBeforeCall(BatchPersonalNameIn batchPersonalNameIn, final ApiCallback _callback) throws ApiException { - return countryBatchCall(batchPersonalNameIn, _callback); + private okhttp3.Call diasporaBatchValidateBeforeCall(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn, final ApiCallback _callback) throws ApiException { + return diasporaBatchCall(batchFirstLastNameGeoIn, _callback); } /** - * [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin. + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) * - * @param batchPersonalNameIn A list of personal names (optional) - * @return BatchPersonalNameGeoOut + * @param batchFirstLastNameGeoIn A list of personal names (optional) + * @return BatchFirstLastNameDiasporaedOut * @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 A list of genderized names. -
200 A list of diaspora / ethnicity given a name and residency. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
*/ - public BatchPersonalNameGeoOut countryBatch(BatchPersonalNameIn batchPersonalNameIn) throws ApiException { - ApiResponse localVarResp = countryBatchWithHttpInfo(batchPersonalNameIn); + public BatchFirstLastNameDiasporaedOut diasporaBatch(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn) throws ApiException { + ApiResponse localVarResp = diasporaBatchWithHttpInfo(batchFirstLastNameGeoIn); return localVarResp.getData(); } /** - * [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin. + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) * - * @param batchPersonalNameIn A list of personal names (optional) - * @return ApiResponse<BatchPersonalNameGeoOut> + * @param batchFirstLastNameGeoIn A list of personal names (optional) + * @return ApiResponse<BatchFirstLastNameDiasporaedOut> * @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 A list of genderized names. -
200 A list of diaspora / ethnicity given a name and residency. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
*/ - public ApiResponse countryBatchWithHttpInfo(BatchPersonalNameIn batchPersonalNameIn) throws ApiException { - okhttp3.Call localVarCall = countryBatchValidateBeforeCall(batchPersonalNameIn, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse diasporaBatchWithHttpInfo(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn) throws ApiException { + okhttp3.Call localVarCall = diasporaBatchValidateBeforeCall(batchFirstLastNameGeoIn, null); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin. (asynchronously) + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) (asynchronously) * - * @param batchPersonalNameIn A list of personal names (optional) + * @param batchFirstLastNameGeoIn A list of personal names (optional) * @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 A list of genderized names. -
200 A list of diaspora / ethnicity given a name and residency. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
*/ - public okhttp3.Call countryBatchAsync(BatchPersonalNameIn batchPersonalNameIn, final ApiCallback _callback) throws ApiException { + public okhttp3.Call diasporaBatchAsync(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = countryBatchValidateBeforeCall(batchPersonalNameIn, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + okhttp3.Call localVarCall = diasporaBatchValidateBeforeCall(batchFirstLastNameGeoIn, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for diaspora + * Build call for diasporaFull * @param countryIso2 (required) - * @param firstName (required) - * @param lastName (required) + * @param personalNameFull (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -691,7 +1804,7 @@ public okhttp3.Call countryBatchAsync(BatchPersonalNameIn batchPersonalNameIn, f 403 Email not Verified, or API Limit Reached, or API Key Disabled - */ - public okhttp3.Call diasporaCall(String countryIso2, String firstName, String lastName, final ApiCallback _callback) throws ApiException { + public okhttp3.Call diasporaFullCall(String countryIso2, String personalNameFull, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -708,10 +1821,9 @@ public okhttp3.Call diasporaCall(String countryIso2, String firstName, String la Object localVarPostBody = null; // create path and map variables - String localVarPath = "/api2/json/diaspora/{countryIso2}/{firstName}/{lastName}" + String localVarPath = "/api2/json/diasporaFull/{countryIso2}/{personalNameFull}" .replace("{" + "countryIso2" + "}", localVarApiClient.escapeString(countryIso2.toString())) - .replace("{" + "firstName" + "}", localVarApiClient.escapeString(firstName.toString())) - .replace("{" + "lastName" + "}", localVarApiClient.escapeString(lastName.toString())); + .replace("{" + "personalNameFull" + "}", localVarApiClient.escapeString(personalNameFull.toString())); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -739,23 +1851,18 @@ public okhttp3.Call diasporaCall(String countryIso2, String firstName, String la } @SuppressWarnings("rawtypes") - private okhttp3.Call diasporaValidateBeforeCall(String countryIso2, String firstName, String lastName, final ApiCallback _callback) throws ApiException { + private okhttp3.Call diasporaFullValidateBeforeCall(String countryIso2, String personalNameFull, final ApiCallback _callback) throws ApiException { // verify the required parameter 'countryIso2' is set if (countryIso2 == null) { - throw new ApiException("Missing the required parameter 'countryIso2' when calling diaspora(Async)"); - } - - // verify the required parameter 'firstName' is set - if (firstName == null) { - throw new ApiException("Missing the required parameter 'firstName' when calling diaspora(Async)"); + throw new ApiException("Missing the required parameter 'countryIso2' when calling diasporaFull(Async)"); } - // verify the required parameter 'lastName' is set - if (lastName == null) { - throw new ApiException("Missing the required parameter 'lastName' when calling diaspora(Async)"); + // verify the required parameter 'personalNameFull' is set + if (personalNameFull == null) { + throw new ApiException("Missing the required parameter 'personalNameFull' when calling diasporaFull(Async)"); } - return diasporaCall(countryIso2, firstName, lastName, _callback); + return diasporaFullCall(countryIso2, personalNameFull, _callback); } @@ -763,9 +1870,8 @@ private okhttp3.Call diasporaValidateBeforeCall(String countryIso2, String first * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) * * @param countryIso2 (required) - * @param firstName (required) - * @param lastName (required) - * @return FirstLastNameDiasporaedOut + * @param personalNameFull (required) + * @return PersonalNameDiasporaedOut * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -775,8 +1881,8 @@ private okhttp3.Call diasporaValidateBeforeCall(String countryIso2, String first
403 Email not Verified, or API Limit Reached, or API Key Disabled -
*/ - public FirstLastNameDiasporaedOut diaspora(String countryIso2, String firstName, String lastName) throws ApiException { - ApiResponse localVarResp = diasporaWithHttpInfo(countryIso2, firstName, lastName); + public PersonalNameDiasporaedOut diasporaFull(String countryIso2, String personalNameFull) throws ApiException { + ApiResponse localVarResp = diasporaFullWithHttpInfo(countryIso2, personalNameFull); return localVarResp.getData(); } @@ -784,9 +1890,8 @@ public FirstLastNameDiasporaedOut diaspora(String countryIso2, String firstName, * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) * * @param countryIso2 (required) - * @param firstName (required) - * @param lastName (required) - * @return ApiResponse<FirstLastNameDiasporaedOut> + * @param personalNameFull (required) + * @return ApiResponse<PersonalNameDiasporaedOut> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -796,9 +1901,9 @@ public FirstLastNameDiasporaedOut diaspora(String countryIso2, String firstName,
403 Email not Verified, or API Limit Reached, or API Key Disabled -
*/ - public ApiResponse diasporaWithHttpInfo(String countryIso2, String firstName, String lastName) throws ApiException { - okhttp3.Call localVarCall = diasporaValidateBeforeCall(countryIso2, firstName, lastName, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse diasporaFullWithHttpInfo(String countryIso2, String personalNameFull) throws ApiException { + okhttp3.Call localVarCall = diasporaFullValidateBeforeCall(countryIso2, personalNameFull, null); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -806,8 +1911,7 @@ public ApiResponse diasporaWithHttpInfo(String count * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) (asynchronously) * * @param countryIso2 (required) - * @param firstName (required) - * @param lastName (required) + * @param personalNameFull (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 @@ -819,16 +1923,16 @@ public ApiResponse diasporaWithHttpInfo(String count 403 Email not Verified, or API Limit Reached, or API Key Disabled - */ - public okhttp3.Call diasporaAsync(String countryIso2, String firstName, String lastName, final ApiCallback _callback) throws ApiException { + public okhttp3.Call diasporaFullAsync(String countryIso2, String personalNameFull, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = diasporaValidateBeforeCall(countryIso2, firstName, lastName, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + okhttp3.Call localVarCall = diasporaFullValidateBeforeCall(countryIso2, personalNameFull, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for diasporaBatch - * @param batchFirstLastNameGeoIn A list of personal names (optional) + * Build call for diasporaFullBatch + * @param batchPersonalNameGeoIn A list of personal names (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -841,7 +1945,7 @@ public okhttp3.Call diasporaAsync(String countryIso2, String firstName, String l 400 Bad request (ex. too many names) - */ - public okhttp3.Call diasporaBatchCall(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn, final ApiCallback _callback) throws ApiException { + public okhttp3.Call diasporaFullBatchCall(BatchPersonalNameGeoIn batchPersonalNameGeoIn, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -855,10 +1959,10 @@ public okhttp3.Call diasporaBatchCall(BatchFirstLastNameGeoIn batchFirstLastName basePath = null; } - Object localVarPostBody = batchFirstLastNameGeoIn; + Object localVarPostBody = batchPersonalNameGeoIn; // create path and map variables - String localVarPath = "/api2/json/diasporaBatch"; + String localVarPath = "/api2/json/diasporaFullBatch"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -887,16 +1991,16 @@ public okhttp3.Call diasporaBatchCall(BatchFirstLastNameGeoIn batchFirstLastName } @SuppressWarnings("rawtypes") - private okhttp3.Call diasporaBatchValidateBeforeCall(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn, final ApiCallback _callback) throws ApiException { - return diasporaBatchCall(batchFirstLastNameGeoIn, _callback); + private okhttp3.Call diasporaFullBatchValidateBeforeCall(BatchPersonalNameGeoIn batchPersonalNameGeoIn, final ApiCallback _callback) throws ApiException { + return diasporaFullBatchCall(batchPersonalNameGeoIn, _callback); } /** * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) * - * @param batchFirstLastNameGeoIn A list of personal names (optional) - * @return BatchFirstLastNameDiasporaedOut + * @param batchPersonalNameGeoIn A list of personal names (optional) + * @return BatchPersonalNameDiasporaedOut * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -906,17 +2010,17 @@ private okhttp3.Call diasporaBatchValidateBeforeCall(BatchFirstLastNameGeoIn bat
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
- */ - public BatchFirstLastNameDiasporaedOut diasporaBatch(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn) throws ApiException { - ApiResponse localVarResp = diasporaBatchWithHttpInfo(batchFirstLastNameGeoIn); + */ + public BatchPersonalNameDiasporaedOut diasporaFullBatch(BatchPersonalNameGeoIn batchPersonalNameGeoIn) throws ApiException { + ApiResponse localVarResp = diasporaFullBatchWithHttpInfo(batchPersonalNameGeoIn); return localVarResp.getData(); } /** * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) * - * @param batchFirstLastNameGeoIn A list of personal names (optional) - * @return ApiResponse<BatchFirstLastNameDiasporaedOut> + * @param batchPersonalNameGeoIn A list of personal names (optional) + * @return ApiResponse<BatchPersonalNameDiasporaedOut> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -927,16 +2031,16 @@ public BatchFirstLastNameDiasporaedOut diasporaBatch(BatchFirstLastNameGeoIn bat
400 Bad request (ex. too many names) -
*/ - public ApiResponse diasporaBatchWithHttpInfo(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn) throws ApiException { - okhttp3.Call localVarCall = diasporaBatchValidateBeforeCall(batchFirstLastNameGeoIn, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse diasporaFullBatchWithHttpInfo(BatchPersonalNameGeoIn batchPersonalNameGeoIn) throws ApiException { + okhttp3.Call localVarCall = diasporaFullBatchValidateBeforeCall(batchPersonalNameGeoIn, null); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) (asynchronously) * - * @param batchFirstLastNameGeoIn A list of personal names (optional) + * @param batchPersonalNameGeoIn A list of personal names (optional) * @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 @@ -949,10 +2053,10 @@ public ApiResponse diasporaBatchWithHttpInfo(Ba 400 Bad request (ex. too many names) - */ - public okhttp3.Call diasporaBatchAsync(BatchFirstLastNameGeoIn batchFirstLastNameGeoIn, final ApiCallback _callback) throws ApiException { + public okhttp3.Call diasporaFullBatchAsync(BatchPersonalNameGeoIn batchPersonalNameGeoIn, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = diasporaBatchValidateBeforeCall(batchFirstLastNameGeoIn, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + okhttp3.Call localVarCall = diasporaFullBatchValidateBeforeCall(batchPersonalNameGeoIn, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -2313,8 +3417,269 @@ public okhttp3.Call originAsync(String firstName, String lastName, final ApiCall return localVarCall; } /** - * Build call for originBatch - * @param batchFirstLastNameIn A list of personal names (optional) + * Build call for originBatch + * @param batchFirstLastNameIn A list of personal names (optional) + * @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 A list of genderized names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public okhttp3.Call originBatchCall(BatchFirstLastNameIn batchFirstLastNameIn, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = batchFirstLastNameIn; + + // create path and map variables + String localVarPath = "/api2/json/originBatch"; + + 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); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "api_key" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call originBatchValidateBeforeCall(BatchFirstLastNameIn batchFirstLastNameIn, final ApiCallback _callback) throws ApiException { + return originBatchCall(batchFirstLastNameIn, _callback); + + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context. + * + * @param batchFirstLastNameIn A list of personal names (optional) + * @return BatchFirstLastNameOriginedOut + * @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 A list of genderized names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public BatchFirstLastNameOriginedOut originBatch(BatchFirstLastNameIn batchFirstLastNameIn) throws ApiException { + ApiResponse localVarResp = originBatchWithHttpInfo(batchFirstLastNameIn); + return localVarResp.getData(); + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context. + * + * @param batchFirstLastNameIn A list of personal names (optional) + * @return ApiResponse<BatchFirstLastNameOriginedOut> + * @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 A list of genderized names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public ApiResponse originBatchWithHttpInfo(BatchFirstLastNameIn batchFirstLastNameIn) throws ApiException { + okhttp3.Call localVarCall = originBatchValidateBeforeCall(batchFirstLastNameIn, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context. (asynchronously) + * + * @param batchFirstLastNameIn A list of personal names (optional) + * @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 A list of genderized names. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public okhttp3.Call originBatchAsync(BatchFirstLastNameIn batchFirstLastNameIn, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = originBatchValidateBeforeCall(batchFirstLastNameIn, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for originFull + * @param personalNameFull (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 A origined name. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public okhttp3.Call originFullCall(String personalNameFull, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/api2/json/originFull/{personalNameFull}" + .replace("{" + "personalNameFull" + "}", localVarApiClient.escapeString(personalNameFull.toString())); + + 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 = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "api_key" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call originFullValidateBeforeCall(String personalNameFull, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'personalNameFull' is set + if (personalNameFull == null) { + throw new ApiException("Missing the required parameter 'personalNameFull' when calling originFull(Async)"); + } + + return originFullCall(personalNameFull, _callback); + + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead. + * + * @param personalNameFull (required) + * @return PersonalNameOriginedOut + * @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 A origined name. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public PersonalNameOriginedOut originFull(String personalNameFull) throws ApiException { + ApiResponse localVarResp = originFullWithHttpInfo(personalNameFull); + return localVarResp.getData(); + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead. + * + * @param personalNameFull (required) + * @return ApiResponse<PersonalNameOriginedOut> + * @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 A origined name. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public ApiResponse originFullWithHttpInfo(String personalNameFull) throws ApiException { + okhttp3.Call localVarCall = originFullValidateBeforeCall(personalNameFull, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead. (asynchronously) + * + * @param personalNameFull (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 A origined name. -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public okhttp3.Call originFullAsync(String personalNameFull, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = originFullValidateBeforeCall(personalNameFull, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for originFullBatch + * @param batchPersonalNameIn A list of personal names (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -2327,7 +3692,7 @@ public okhttp3.Call originAsync(String firstName, String lastName, final ApiCall 400 Bad request (ex. too many names) - */ - public okhttp3.Call originBatchCall(BatchFirstLastNameIn batchFirstLastNameIn, final ApiCallback _callback) throws ApiException { + public okhttp3.Call originFullBatchCall(BatchPersonalNameIn batchPersonalNameIn, final ApiCallback _callback) throws ApiException { String basePath = null; // Operation Servers String[] localBasePaths = new String[] { }; @@ -2341,10 +3706,10 @@ public okhttp3.Call originBatchCall(BatchFirstLastNameIn batchFirstLastNameIn, f basePath = null; } - Object localVarPostBody = batchFirstLastNameIn; + Object localVarPostBody = batchPersonalNameIn; // create path and map variables - String localVarPath = "/api2/json/originBatch"; + String localVarPath = "/api2/json/originFullBatch"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -2373,16 +3738,16 @@ public okhttp3.Call originBatchCall(BatchFirstLastNameIn batchFirstLastNameIn, f } @SuppressWarnings("rawtypes") - private okhttp3.Call originBatchValidateBeforeCall(BatchFirstLastNameIn batchFirstLastNameIn, final ApiCallback _callback) throws ApiException { - return originBatchCall(batchFirstLastNameIn, _callback); + private okhttp3.Call originFullBatchValidateBeforeCall(BatchPersonalNameIn batchPersonalNameIn, final ApiCallback _callback) throws ApiException { + return originFullBatchCall(batchPersonalNameIn, _callback); } /** * [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context. * - * @param batchFirstLastNameIn A list of personal names (optional) - * @return BatchFirstLastNameOriginedOut + * @param batchPersonalNameIn A list of personal names (optional) + * @return BatchPersonalNameOriginedOut * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2393,16 +3758,16 @@ private okhttp3.Call originBatchValidateBeforeCall(BatchFirstLastNameIn batchFir
400 Bad request (ex. too many names) -
*/ - public BatchFirstLastNameOriginedOut originBatch(BatchFirstLastNameIn batchFirstLastNameIn) throws ApiException { - ApiResponse localVarResp = originBatchWithHttpInfo(batchFirstLastNameIn); + public BatchPersonalNameOriginedOut originFullBatch(BatchPersonalNameIn batchPersonalNameIn) throws ApiException { + ApiResponse localVarResp = originFullBatchWithHttpInfo(batchPersonalNameIn); return localVarResp.getData(); } /** * [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context. * - * @param batchFirstLastNameIn A list of personal names (optional) - * @return ApiResponse<BatchFirstLastNameOriginedOut> + * @param batchPersonalNameIn A list of personal names (optional) + * @return ApiResponse<BatchPersonalNameOriginedOut> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2413,16 +3778,16 @@ public BatchFirstLastNameOriginedOut originBatch(BatchFirstLastNameIn batchFirst
400 Bad request (ex. too many names) -
*/ - public ApiResponse originBatchWithHttpInfo(BatchFirstLastNameIn batchFirstLastNameIn) throws ApiException { - okhttp3.Call localVarCall = originBatchValidateBeforeCall(batchFirstLastNameIn, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse originFullBatchWithHttpInfo(BatchPersonalNameIn batchPersonalNameIn) throws ApiException { + okhttp3.Call localVarCall = originFullBatchValidateBeforeCall(batchPersonalNameIn, null); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context. (asynchronously) * - * @param batchFirstLastNameIn A list of personal names (optional) + * @param batchPersonalNameIn A list of personal names (optional) * @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 @@ -2435,10 +3800,10 @@ public ApiResponse originBatchWithHttpInfo(BatchF 400 Bad request (ex. too many names) - */ - public okhttp3.Call originBatchAsync(BatchFirstLastNameIn batchFirstLastNameIn, final ApiCallback _callback) throws ApiException { + public okhttp3.Call originFullBatchAsync(BatchPersonalNameIn batchPersonalNameIn, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = originBatchValidateBeforeCall(batchFirstLastNameIn, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + okhttp3.Call localVarCall = originFullBatchValidateBeforeCall(batchPersonalNameIn, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -4369,6 +5734,267 @@ public okhttp3.Call usRaceEthnicityBatchAsync(BatchFirstLastNameGeoIn batchFirst localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } + /** + * Build call for usRaceEthnicityFull + * @param personalNameFull (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 a US resident's likely race/ethnicity : W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public okhttp3.Call usRaceEthnicityFullCall(String personalNameFull, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/api2/json/usRaceEthnicityFull/{personalNameFull}" + .replace("{" + "personalNameFull" + "}", localVarApiClient.escapeString(personalNameFull.toString())); + + 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 = { + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "api_key" }; + return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call usRaceEthnicityFullValidateBeforeCall(String personalNameFull, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'personalNameFull' is set + if (personalNameFull == null) { + throw new ApiException("Missing the required parameter 'personalNameFull' when calling usRaceEthnicityFull(Async)"); + } + + return usRaceEthnicityFullCall(personalNameFull, _callback); + + } + + /** + * [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). + * + * @param personalNameFull (required) + * @return PersonalNameUSRaceEthnicityOut + * @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 a US resident's likely race/ethnicity : W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public PersonalNameUSRaceEthnicityOut usRaceEthnicityFull(String personalNameFull) throws ApiException { + ApiResponse localVarResp = usRaceEthnicityFullWithHttpInfo(personalNameFull); + return localVarResp.getData(); + } + + /** + * [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). + * + * @param personalNameFull (required) + * @return ApiResponse<PersonalNameUSRaceEthnicityOut> + * @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 a US resident's likely race/ethnicity : W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public ApiResponse usRaceEthnicityFullWithHttpInfo(String personalNameFull) throws ApiException { + okhttp3.Call localVarCall = usRaceEthnicityFullValidateBeforeCall(personalNameFull, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). (asynchronously) + * + * @param personalNameFull (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 a US resident's likely race/ethnicity : W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
+ */ + public okhttp3.Call usRaceEthnicityFullAsync(String personalNameFull, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = usRaceEthnicityFullValidateBeforeCall(personalNameFull, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for usRaceEthnicityFullBatch + * @param batchPersonalNameGeoIn A list of personal names (optional) + * @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 A list of US resident's likely race/ethnicity. W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public okhttp3.Call usRaceEthnicityFullBatchCall(BatchPersonalNameGeoIn batchPersonalNameGeoIn, final ApiCallback _callback) throws ApiException { + String basePath = null; + // Operation Servers + String[] localBasePaths = new String[] { }; + + // Determine Base Path to Use + if (localCustomBaseUrl != null){ + basePath = localCustomBaseUrl; + } else if ( localBasePaths.length > 0 ) { + basePath = localBasePaths[localHostIndex]; + } else { + basePath = null; + } + + Object localVarPostBody = batchPersonalNameGeoIn; + + // create path and map variables + String localVarPath = "/api2/json/usRaceEthnicityFullBatch"; + + 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); + if (localVarContentType != null) { + localVarHeaderParams.put("Content-Type", localVarContentType); + } + + String[] localVarAuthNames = new String[] { "api_key" }; + return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call usRaceEthnicityFullBatchValidateBeforeCall(BatchPersonalNameGeoIn batchPersonalNameGeoIn, final ApiCallback _callback) throws ApiException { + return usRaceEthnicityFullBatchCall(batchPersonalNameGeoIn, _callback); + + } + + /** + * [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). + * + * @param batchPersonalNameGeoIn A list of personal names (optional) + * @return BatchPersonalNameUSRaceEthnicityOut + * @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 A list of US resident's likely race/ethnicity. W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public BatchPersonalNameUSRaceEthnicityOut usRaceEthnicityFullBatch(BatchPersonalNameGeoIn batchPersonalNameGeoIn) throws ApiException { + ApiResponse localVarResp = usRaceEthnicityFullBatchWithHttpInfo(batchPersonalNameGeoIn); + return localVarResp.getData(); + } + + /** + * [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). + * + * @param batchPersonalNameGeoIn A list of personal names (optional) + * @return ApiResponse<BatchPersonalNameUSRaceEthnicityOut> + * @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 A list of US resident's likely race/ethnicity. W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public ApiResponse usRaceEthnicityFullBatchWithHttpInfo(BatchPersonalNameGeoIn batchPersonalNameGeoIn) throws ApiException { + okhttp3.Call localVarCall = usRaceEthnicityFullBatchValidateBeforeCall(batchPersonalNameGeoIn, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). (asynchronously) + * + * @param batchPersonalNameGeoIn A list of personal names (optional) + * @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 A list of US resident's likely race/ethnicity. W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally -
401 Missing or incorrect API Key -
403 Email not Verified, or API Limit Reached, or API Key Disabled -
400 Bad request (ex. too many names) -
+ */ + public okhttp3.Call usRaceEthnicityFullBatchAsync(BatchPersonalNameGeoIn batchPersonalNameGeoIn, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = usRaceEthnicityFullBatchValidateBeforeCall(batchPersonalNameGeoIn, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } /** * Build call for usRaceEthnicityZIP5 * @param firstName (required) diff --git a/src/main/java/com/namsor/sdk2/api/SocialApi.java b/src/main/java/com/namsor/sdk2/api/SocialApi.java index a6e50d17..8e1b1059 100644 --- a/src/main/java/com/namsor/sdk2/api/SocialApi.java +++ b/src/main/java/com/namsor/sdk2/api/SocialApi.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/com/namsor/sdk2/invoke/ApiCallback.java b/src/main/java/com/namsor/sdk2/invoke/ApiCallback.java index 59d9f9e5..08b131e7 100644 --- a/src/main/java/com/namsor/sdk2/invoke/ApiCallback.java +++ b/src/main/java/com/namsor/sdk2/invoke/ApiCallback.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/com/namsor/sdk2/invoke/ApiClient.java b/src/main/java/com/namsor/sdk2/invoke/ApiClient.java index 0c471be1..d68f258e 100644 --- a/src/main/java/com/namsor/sdk2/invoke/ApiClient.java +++ b/src/main/java/com/namsor/sdk2/invoke/ApiClient.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -140,7 +140,7 @@ private void init() { json = new JSON(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/2.0.27/java"); + setUserAgent("OpenAPI-Generator/2.0.29/java"); authentications = new HashMap(); } diff --git a/src/main/java/com/namsor/sdk2/invoke/ApiException.java b/src/main/java/com/namsor/sdk2/invoke/ApiException.java index 45429a57..b6463da4 100644 --- a/src/main/java/com/namsor/sdk2/invoke/ApiException.java +++ b/src/main/java/com/namsor/sdk2/invoke/ApiException.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -22,7 +22,7 @@ *

ApiException class.

*/ @SuppressWarnings("serial") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class ApiException extends Exception { private int code = 0; private Map> responseHeaders = null; diff --git a/src/main/java/com/namsor/sdk2/invoke/ApiResponse.java b/src/main/java/com/namsor/sdk2/invoke/ApiResponse.java index f152d5f8..051374f2 100644 --- a/src/main/java/com/namsor/sdk2/invoke/ApiResponse.java +++ b/src/main/java/com/namsor/sdk2/invoke/ApiResponse.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/com/namsor/sdk2/invoke/Configuration.java b/src/main/java/com/namsor/sdk2/invoke/Configuration.java index 5a33a119..ccd1659e 100644 --- a/src/main/java/com/namsor/sdk2/invoke/Configuration.java +++ b/src/main/java/com/namsor/sdk2/invoke/Configuration.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -13,9 +13,9 @@ package com.namsor.sdk2.invoke; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class Configuration { - public static final String VERSION = "2.0.27"; + public static final String VERSION = "2.0.29"; private static ApiClient defaultApiClient = new ApiClient(); diff --git a/src/main/java/com/namsor/sdk2/invoke/GzipRequestInterceptor.java b/src/main/java/com/namsor/sdk2/invoke/GzipRequestInterceptor.java index 5babc962..748f37c5 100644 --- a/src/main/java/com/namsor/sdk2/invoke/GzipRequestInterceptor.java +++ b/src/main/java/com/namsor/sdk2/invoke/GzipRequestInterceptor.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/com/namsor/sdk2/invoke/JSON.java b/src/main/java/com/namsor/sdk2/invoke/JSON.java index 40412958..bdfefa33 100644 --- a/src/main/java/com/namsor/sdk2/invoke/JSON.java +++ b/src/main/java/com/namsor/sdk2/invoke/JSON.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -105,6 +105,8 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.APIServicesOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.APIUsageAggregatedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.APIUsageHistoryOut.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchCommunityEngageFullOut.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchCommunityEngageOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchCorridorIn.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchCorridorOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchFirstLastNameCasteOut.CustomTypeAdapterFactory()); @@ -113,6 +115,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchFirstLastNameGenderIn.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchFirstLastNameGenderedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchFirstLastNameGeoIn.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchFirstLastNameGeoOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchFirstLastNameGeoSubclassificationOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchFirstLastNameGeoSubdivisionIn.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchFirstLastNameGeoZippedIn.CustomTypeAdapterFactory()); @@ -130,16 +133,21 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchNameMatchCandidatesOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchNameMatchedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchPersonalNameCastegroupOut.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchPersonalNameDiasporaedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchPersonalNameGenderedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchPersonalNameGeoIn.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchPersonalNameGeoOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchPersonalNameGeoSubclassificationOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchPersonalNameGeoSubdivisionIn.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchPersonalNameIn.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchPersonalNameOriginedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchPersonalNameParsedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchPersonalNameReligionedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchPersonalNameSubdivisionIn.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchPersonalNameUSRaceEthnicityOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.BatchProperNounCategorizedOut.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.CommunityEngageOptionOut.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.CommunityEngageOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.CorridorIn.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.CorridorOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.FeedbackLoopOut.CustomTypeAdapterFactory()); @@ -149,6 +157,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.FirstLastNameGenderIn.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.FirstLastNameGenderedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.FirstLastNameGeoIn.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.FirstLastNameGeoOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.FirstLastNameGeoSubclassificationOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.FirstLastNameGeoSubdivisionIn.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.FirstLastNameGeoZippedIn.CustomTypeAdapterFactory()); @@ -168,15 +177,18 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.NameMatchCandidatesOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.NameMatchedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.PersonalNameCastegroupOut.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.PersonalNameDiasporaedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.PersonalNameGenderedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.PersonalNameGeoIn.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.PersonalNameGeoOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.PersonalNameGeoSubclassificationOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.PersonalNameGeoSubdivisionIn.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.PersonalNameIn.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.PersonalNameOriginedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.PersonalNameParsedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.PersonalNameReligionedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.PersonalNameSubdivisionIn.CustomTypeAdapterFactory()); + gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.PersonalNameUSRaceEthnicityOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.ProperNounCategorizedOut.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.RegionISO.CustomTypeAdapterFactory()); gsonBuilder.registerTypeAdapterFactory(new com.namsor.sdk2.model.RegionOut.CustomTypeAdapterFactory()); diff --git a/src/main/java/com/namsor/sdk2/invoke/Pair.java b/src/main/java/com/namsor/sdk2/invoke/Pair.java index 51228e17..1cfe3dca 100644 --- a/src/main/java/com/namsor/sdk2/invoke/Pair.java +++ b/src/main/java/com/namsor/sdk2/invoke/Pair.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -13,7 +13,7 @@ package com.namsor.sdk2.invoke; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class Pair { private String name = ""; private String value = ""; diff --git a/src/main/java/com/namsor/sdk2/invoke/ProgressRequestBody.java b/src/main/java/com/namsor/sdk2/invoke/ProgressRequestBody.java index 9b9509d5..89bb74f4 100644 --- a/src/main/java/com/namsor/sdk2/invoke/ProgressRequestBody.java +++ b/src/main/java/com/namsor/sdk2/invoke/ProgressRequestBody.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/com/namsor/sdk2/invoke/ProgressResponseBody.java b/src/main/java/com/namsor/sdk2/invoke/ProgressResponseBody.java index ed99aace..301f7afb 100644 --- a/src/main/java/com/namsor/sdk2/invoke/ProgressResponseBody.java +++ b/src/main/java/com/namsor/sdk2/invoke/ProgressResponseBody.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/com/namsor/sdk2/invoke/StringUtil.java b/src/main/java/com/namsor/sdk2/invoke/StringUtil.java index 0ccf9d1b..e963d310 100644 --- a/src/main/java/com/namsor/sdk2/invoke/StringUtil.java +++ b/src/main/java/com/namsor/sdk2/invoke/StringUtil.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -16,7 +16,7 @@ import java.util.Collection; import java.util.Iterator; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class StringUtil { /** * Check if the given array contains the given value (with case-insensitive comparison). diff --git a/src/main/java/com/namsor/sdk2/invoke/auth/ApiKeyAuth.java b/src/main/java/com/namsor/sdk2/invoke/auth/ApiKeyAuth.java index e975dc6f..f8d427c4 100644 --- a/src/main/java/com/namsor/sdk2/invoke/auth/ApiKeyAuth.java +++ b/src/main/java/com/namsor/sdk2/invoke/auth/ApiKeyAuth.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -20,7 +20,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class ApiKeyAuth implements Authentication { private final String location; private final String paramName; diff --git a/src/main/java/com/namsor/sdk2/invoke/auth/Authentication.java b/src/main/java/com/namsor/sdk2/invoke/auth/Authentication.java index 45bd5998..85713c5c 100644 --- a/src/main/java/com/namsor/sdk2/invoke/auth/Authentication.java +++ b/src/main/java/com/namsor/sdk2/invoke/auth/Authentication.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/com/namsor/sdk2/invoke/auth/HttpBasicAuth.java b/src/main/java/com/namsor/sdk2/invoke/auth/HttpBasicAuth.java index 65c8fc8e..9ff26b86 100644 --- a/src/main/java/com/namsor/sdk2/invoke/auth/HttpBasicAuth.java +++ b/src/main/java/com/namsor/sdk2/invoke/auth/HttpBasicAuth.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/main/java/com/namsor/sdk2/invoke/auth/HttpBearerAuth.java b/src/main/java/com/namsor/sdk2/invoke/auth/HttpBearerAuth.java index 9fe724b4..f0e2fdb6 100644 --- a/src/main/java/com/namsor/sdk2/invoke/auth/HttpBearerAuth.java +++ b/src/main/java/com/namsor/sdk2/invoke/auth/HttpBearerAuth.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -20,7 +20,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class HttpBearerAuth implements Authentication { private final String scheme; private String bearerToken; diff --git a/src/main/java/com/namsor/sdk2/model/APIBillingPeriodUsageOut.java b/src/main/java/com/namsor/sdk2/model/APIBillingPeriodUsageOut.java index 1d58f767..c0bbb6f8 100644 --- a/src/main/java/com/namsor/sdk2/model/APIBillingPeriodUsageOut.java +++ b/src/main/java/com/namsor/sdk2/model/APIBillingPeriodUsageOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * The current billing period. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class APIBillingPeriodUsageOut { public static final String SERIALIZED_NAME_API_KEY = "apiKey"; @SerializedName(SERIALIZED_NAME_API_KEY) diff --git a/src/main/java/com/namsor/sdk2/model/APIClassifierOut.java b/src/main/java/com/namsor/sdk2/model/APIClassifierOut.java index bb7187dd..3b7a8c30 100644 --- a/src/main/java/com/namsor/sdk2/model/APIClassifierOut.java +++ b/src/main/java/com/namsor/sdk2/model/APIClassifierOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * The list of classifiers and versions. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class APIClassifierOut { public static final String SERIALIZED_NAME_CLASSIFIER_NAME = "classifierName"; @SerializedName(SERIALIZED_NAME_CLASSIFIER_NAME) diff --git a/src/main/java/com/namsor/sdk2/model/APIClassifierTaxonomyOut.java b/src/main/java/com/namsor/sdk2/model/APIClassifierTaxonomyOut.java index dddf3cc5..17d20b46 100644 --- a/src/main/java/com/namsor/sdk2/model/APIClassifierTaxonomyOut.java +++ b/src/main/java/com/namsor/sdk2/model/APIClassifierTaxonomyOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -52,7 +52,7 @@ /** * APIClassifierTaxonomyOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class APIClassifierTaxonomyOut { public static final String SERIALIZED_NAME_CLASSIFIER_NAME = "classifierName"; @SerializedName(SERIALIZED_NAME_CLASSIFIER_NAME) diff --git a/src/main/java/com/namsor/sdk2/model/APIClassifiersStatusOut.java b/src/main/java/com/namsor/sdk2/model/APIClassifiersStatusOut.java index 3f47a7e5..8ec47bba 100644 --- a/src/main/java/com/namsor/sdk2/model/APIClassifiersStatusOut.java +++ b/src/main/java/com/namsor/sdk2/model/APIClassifiersStatusOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -54,7 +54,7 @@ /** * APIClassifiersStatusOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class APIClassifiersStatusOut { public static final String SERIALIZED_NAME_SOFTWARE_VERSION = "softwareVersion"; @SerializedName(SERIALIZED_NAME_SOFTWARE_VERSION) diff --git a/src/main/java/com/namsor/sdk2/model/APICounterV2Out.java b/src/main/java/com/namsor/sdk2/model/APICounterV2Out.java index 1acd9157..3bb10902 100644 --- a/src/main/java/com/namsor/sdk2/model/APICounterV2Out.java +++ b/src/main/java/com/namsor/sdk2/model/APICounterV2Out.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Detailed usage as reported by the deduplicating API counter. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class APICounterV2Out { public static final String SERIALIZED_NAME_API_KEY = "apiKey"; @SerializedName(SERIALIZED_NAME_API_KEY) diff --git a/src/main/java/com/namsor/sdk2/model/APIKeyOut.java b/src/main/java/com/namsor/sdk2/model/APIKeyOut.java index 01eeebc8..bd05ea60 100644 --- a/src/main/java/com/namsor/sdk2/model/APIKeyOut.java +++ b/src/main/java/com/namsor/sdk2/model/APIKeyOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -20,6 +20,7 @@ import com.google.gson.annotations.SerializedName; import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.CommunityEngageOptionOut; import java.io.IOException; import com.google.gson.Gson; @@ -50,7 +51,7 @@ /** * APIKeyOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class APIKeyOut { public static final String SERIALIZED_NAME_API_KEY = "apiKey"; @SerializedName(SERIALIZED_NAME_API_KEY) @@ -100,6 +101,10 @@ public class APIKeyOut { @SerializedName(SERIALIZED_NAME_IP_ADDRESS) private String ipAddress; + public static final String SERIALIZED_NAME_COMMUNITY_ENGAGE_OPTION = "communityEngageOption"; + @SerializedName(SERIALIZED_NAME_COMMUNITY_ENGAGE_OPTION) + private CommunityEngageOptionOut communityEngageOption; + public APIKeyOut() { } @@ -355,6 +360,27 @@ public void setIpAddress(String ipAddress) { } + public APIKeyOut communityEngageOption(CommunityEngageOptionOut communityEngageOption) { + + this.communityEngageOption = communityEngageOption; + return this; + } + + /** + * Get communityEngageOption + * @return communityEngageOption + **/ + @javax.annotation.Nullable + public CommunityEngageOptionOut getCommunityEngageOption() { + return communityEngageOption; + } + + + public void setCommunityEngageOption(CommunityEngageOptionOut communityEngageOption) { + this.communityEngageOption = communityEngageOption; + } + + @Override public boolean equals(Object o) { @@ -376,12 +402,13 @@ public boolean equals(Object o) { Objects.equals(this.corporate, apIKeyOut.corporate) && Objects.equals(this.disabled, apIKeyOut.disabled) && Objects.equals(this.explainable, apIKeyOut.explainable) && - Objects.equals(this.ipAddress, apIKeyOut.ipAddress); + Objects.equals(this.ipAddress, apIKeyOut.ipAddress) && + Objects.equals(this.communityEngageOption, apIKeyOut.communityEngageOption); } @Override public int hashCode() { - return Objects.hash(apiKey, userId, admin, vetted, learnable, anonymized, partner, striped, corporate, disabled, explainable, ipAddress); + return Objects.hash(apiKey, userId, admin, vetted, learnable, anonymized, partner, striped, corporate, disabled, explainable, ipAddress, communityEngageOption); } @Override @@ -400,6 +427,7 @@ public String toString() { sb.append(" disabled: ").append(toIndentedString(disabled)).append("\n"); sb.append(" explainable: ").append(toIndentedString(explainable)).append("\n"); sb.append(" ipAddress: ").append(toIndentedString(ipAddress)).append("\n"); + sb.append(" communityEngageOption: ").append(toIndentedString(communityEngageOption)).append("\n"); sb.append("}"); return sb.toString(); } @@ -434,6 +462,7 @@ private String toIndentedString(Object o) { openapiFields.add("disabled"); openapiFields.add("explainable"); openapiFields.add("ipAddress"); + openapiFields.add("communityEngageOption"); // a set of required properties/fields (JSON key names) openapiRequiredFields = new HashSet(); @@ -468,6 +497,10 @@ public static void validateJsonObject(JsonObject jsonObj) throws IOException { if ((jsonObj.get("ipAddress") != null && !jsonObj.get("ipAddress").isJsonNull()) && !jsonObj.get("ipAddress").isJsonPrimitive()) { throw new IllegalArgumentException(String.format("Expected the field `ipAddress` to be a primitive type in the JSON string but got `%s`", jsonObj.get("ipAddress").toString())); } + // validate the optional field `communityEngageOption` + if (jsonObj.get("communityEngageOption") != null && !jsonObj.get("communityEngageOption").isJsonNull()) { + CommunityEngageOptionOut.validateJsonObject(jsonObj.getAsJsonObject("communityEngageOption")); + } } public static class CustomTypeAdapterFactory implements TypeAdapterFactory { diff --git a/src/main/java/com/namsor/sdk2/model/APIPeriodUsageOut.java b/src/main/java/com/namsor/sdk2/model/APIPeriodUsageOut.java index 4fb46ddd..c9c47b26 100644 --- a/src/main/java/com/namsor/sdk2/model/APIPeriodUsageOut.java +++ b/src/main/java/com/namsor/sdk2/model/APIPeriodUsageOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -52,7 +52,7 @@ /** * APIPeriodUsageOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class APIPeriodUsageOut { public static final String SERIALIZED_NAME_SUBSCRIPTION = "subscription"; @SerializedName(SERIALIZED_NAME_SUBSCRIPTION) diff --git a/src/main/java/com/namsor/sdk2/model/APIPlanSubscriptionOut.java b/src/main/java/com/namsor/sdk2/model/APIPlanSubscriptionOut.java index b1e48acf..1c1349b0 100644 --- a/src/main/java/com/namsor/sdk2/model/APIPlanSubscriptionOut.java +++ b/src/main/java/com/namsor/sdk2/model/APIPlanSubscriptionOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * The API Plan governing the subscription. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class APIPlanSubscriptionOut { public static final String SERIALIZED_NAME_API_KEY = "apiKey"; @SerializedName(SERIALIZED_NAME_API_KEY) diff --git a/src/main/java/com/namsor/sdk2/model/APIServiceOut.java b/src/main/java/com/namsor/sdk2/model/APIServiceOut.java index 7e5ed334..04b51cd1 100644 --- a/src/main/java/com/namsor/sdk2/model/APIServiceOut.java +++ b/src/main/java/com/namsor/sdk2/model/APIServiceOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * List of API Services */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class APIServiceOut { public static final String SERIALIZED_NAME_SERVICE_NAME = "serviceName"; @SerializedName(SERIALIZED_NAME_SERVICE_NAME) diff --git a/src/main/java/com/namsor/sdk2/model/APIServicesOut.java b/src/main/java/com/namsor/sdk2/model/APIServicesOut.java index 8c79ba44..ef3065dc 100644 --- a/src/main/java/com/namsor/sdk2/model/APIServicesOut.java +++ b/src/main/java/com/namsor/sdk2/model/APIServicesOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * APIServicesOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class APIServicesOut { public static final String SERIALIZED_NAME_API_SERVICES = "apiServices"; @SerializedName(SERIALIZED_NAME_API_SERVICES) diff --git a/src/main/java/com/namsor/sdk2/model/APIUsageAggregatedOut.java b/src/main/java/com/namsor/sdk2/model/APIUsageAggregatedOut.java index 8a23ad56..30d3f7bc 100644 --- a/src/main/java/com/namsor/sdk2/model/APIUsageAggregatedOut.java +++ b/src/main/java/com/namsor/sdk2/model/APIUsageAggregatedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -52,7 +52,7 @@ /** * APIUsageAggregatedOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class APIUsageAggregatedOut { public static final String SERIALIZED_NAME_TIME_UNIT = "timeUnit"; @SerializedName(SERIALIZED_NAME_TIME_UNIT) diff --git a/src/main/java/com/namsor/sdk2/model/APIUsageHistoryOut.java b/src/main/java/com/namsor/sdk2/model/APIUsageHistoryOut.java index 9b4255f0..47b1a587 100644 --- a/src/main/java/com/namsor/sdk2/model/APIUsageHistoryOut.java +++ b/src/main/java/com/namsor/sdk2/model/APIUsageHistoryOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * APIUsageHistoryOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class APIUsageHistoryOut { public static final String SERIALIZED_NAME_DETAILED_USAGE = "detailedUsage"; @SerializedName(SERIALIZED_NAME_DETAILED_USAGE) diff --git a/src/main/java/com/namsor/sdk2/model/AbstractOpenApiSchema.java b/src/main/java/com/namsor/sdk2/model/AbstractOpenApiSchema.java index bd66dbb3..30df8635 100644 --- a/src/main/java/com/namsor/sdk2/model/AbstractOpenApiSchema.java +++ b/src/main/java/com/namsor/sdk2/model/AbstractOpenApiSchema.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -24,7 +24,7 @@ /** * Abstract class for oneOf,anyOf schemas defined in OpenAPI spec */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public abstract class AbstractOpenApiSchema { // store the actual instance of the schema/object diff --git a/src/main/java/com/namsor/sdk2/model/BatchCommunityEngageFullOut.java b/src/main/java/com/namsor/sdk2/model/BatchCommunityEngageFullOut.java new file mode 100644 index 00000000..444f2934 --- /dev/null +++ b/src/main/java/com/namsor/sdk2/model/BatchCommunityEngageFullOut.java @@ -0,0 +1,230 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.CommunityEngageOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonDeserializationContext; +import com.google.gson.JsonDeserializer; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.reflect.TypeToken; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +import java.lang.reflect.Type; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import com.namsor.sdk2.invoke.JSON; + +/** + * BatchCommunityEngageFullOut + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") +public class BatchCommunityEngageFullOut { + public static final String SERIALIZED_NAME_ENGAGEMENT_CANDIDATES = "engagementCandidates"; + @SerializedName(SERIALIZED_NAME_ENGAGEMENT_CANDIDATES) + private List engagementCandidates; + + public BatchCommunityEngageFullOut() { + } + + public BatchCommunityEngageFullOut engagementCandidates(List engagementCandidates) { + + this.engagementCandidates = engagementCandidates; + return this; + } + + public BatchCommunityEngageFullOut addEngagementCandidatesItem(CommunityEngageOut engagementCandidatesItem) { + if (this.engagementCandidates == null) { + this.engagementCandidates = new ArrayList<>(); + } + this.engagementCandidates.add(engagementCandidatesItem); + return this; + } + + /** + * Classified community engagement candidates + * @return engagementCandidates + **/ + @javax.annotation.Nullable + public List getEngagementCandidates() { + return engagementCandidates; + } + + + public void setEngagementCandidates(List engagementCandidates) { + this.engagementCandidates = engagementCandidates; + } + + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + BatchCommunityEngageFullOut batchCommunityEngageFullOut = (BatchCommunityEngageFullOut) o; + return Objects.equals(this.engagementCandidates, batchCommunityEngageFullOut.engagementCandidates); + } + + @Override + public int hashCode() { + return Objects.hash(engagementCandidates); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class BatchCommunityEngageFullOut {\n"); + sb.append(" engagementCandidates: ").append(toIndentedString(engagementCandidates)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + + public static HashSet openapiFields; + public static HashSet openapiRequiredFields; + + static { + // a set of all properties/fields (JSON key names) + openapiFields = new HashSet(); + openapiFields.add("engagementCandidates"); + + // a set of required properties/fields (JSON key names) + openapiRequiredFields = new HashSet(); + } + + /** + * Validates the JSON Object and throws an exception if issues found + * + * @param jsonObj JSON Object + * @throws IOException if the JSON Object is invalid with respect to BatchCommunityEngageFullOut + */ + public static void validateJsonObject(JsonObject jsonObj) throws IOException { + if (jsonObj == null) { + if (!BatchCommunityEngageFullOut.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null + throw new IllegalArgumentException(String.format("The required field(s) %s in BatchCommunityEngageFullOut is not found in the empty JSON string", BatchCommunityEngageFullOut.openapiRequiredFields.toString())); + } + } + + Set> entries = jsonObj.entrySet(); + // check to see if the JSON string contains additional fields + for (Entry entry : entries) { + if (!BatchCommunityEngageFullOut.openapiFields.contains(entry.getKey())) { + throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `BatchCommunityEngageFullOut` properties. JSON: %s", entry.getKey(), jsonObj.toString())); + } + } + if (jsonObj.get("engagementCandidates") != null && !jsonObj.get("engagementCandidates").isJsonNull()) { + JsonArray jsonArrayengagementCandidates = jsonObj.getAsJsonArray("engagementCandidates"); + if (jsonArrayengagementCandidates != null) { + // ensure the json data is an array + if (!jsonObj.get("engagementCandidates").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `engagementCandidates` to be an array in the JSON string but got `%s`", jsonObj.get("engagementCandidates").toString())); + } + + // validate the optional field `engagementCandidates` (array) + for (int i = 0; i < jsonArrayengagementCandidates.size(); i++) { + CommunityEngageOut.validateJsonObject(jsonArrayengagementCandidates.get(i).getAsJsonObject()); + }; + } + } + } + + public static class CustomTypeAdapterFactory implements TypeAdapterFactory { + @SuppressWarnings("unchecked") + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + if (!BatchCommunityEngageFullOut.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'BatchCommunityEngageFullOut' and its subtypes + } + final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(BatchCommunityEngageFullOut.class)); + + return (TypeAdapter) new TypeAdapter() { + @Override + public void write(JsonWriter out, BatchCommunityEngageFullOut value) throws IOException { + JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); + elementAdapter.write(out, obj); + } + + @Override + public BatchCommunityEngageFullOut read(JsonReader in) throws IOException { + JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject(); + validateJsonObject(jsonObj); + return thisAdapter.fromJsonTree(jsonObj); + } + + }.nullSafe(); + } + } + + /** + * Create an instance of BatchCommunityEngageFullOut given an JSON string + * + * @param jsonString JSON string + * @return An instance of BatchCommunityEngageFullOut + * @throws IOException if the JSON string is invalid with respect to BatchCommunityEngageFullOut + */ + public static BatchCommunityEngageFullOut fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, BatchCommunityEngageFullOut.class); + } + + /** + * Convert an instance of BatchCommunityEngageFullOut to an JSON string + * + * @return JSON string + */ + public String toJson() { + return JSON.getGson().toJson(this); + } +} + diff --git a/src/main/java/com/namsor/sdk2/model/BatchCommunityEngageOut.java b/src/main/java/com/namsor/sdk2/model/BatchCommunityEngageOut.java new file mode 100644 index 00000000..ac590782 --- /dev/null +++ b/src/main/java/com/namsor/sdk2/model/BatchCommunityEngageOut.java @@ -0,0 +1,230 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.CommunityEngageOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonDeserializationContext; +import com.google.gson.JsonDeserializer; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.reflect.TypeToken; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +import java.lang.reflect.Type; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import com.namsor.sdk2.invoke.JSON; + +/** + * BatchCommunityEngageOut + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") +public class BatchCommunityEngageOut { + public static final String SERIALIZED_NAME_ENGAGEMENT_CANDIDATES = "engagementCandidates"; + @SerializedName(SERIALIZED_NAME_ENGAGEMENT_CANDIDATES) + private List engagementCandidates; + + public BatchCommunityEngageOut() { + } + + public BatchCommunityEngageOut engagementCandidates(List engagementCandidates) { + + this.engagementCandidates = engagementCandidates; + return this; + } + + public BatchCommunityEngageOut addEngagementCandidatesItem(CommunityEngageOut engagementCandidatesItem) { + if (this.engagementCandidates == null) { + this.engagementCandidates = new ArrayList<>(); + } + this.engagementCandidates.add(engagementCandidatesItem); + return this; + } + + /** + * Classified community engagement candidates + * @return engagementCandidates + **/ + @javax.annotation.Nullable + public List getEngagementCandidates() { + return engagementCandidates; + } + + + public void setEngagementCandidates(List engagementCandidates) { + this.engagementCandidates = engagementCandidates; + } + + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + BatchCommunityEngageOut batchCommunityEngageOut = (BatchCommunityEngageOut) o; + return Objects.equals(this.engagementCandidates, batchCommunityEngageOut.engagementCandidates); + } + + @Override + public int hashCode() { + return Objects.hash(engagementCandidates); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class BatchCommunityEngageOut {\n"); + sb.append(" engagementCandidates: ").append(toIndentedString(engagementCandidates)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + + public static HashSet openapiFields; + public static HashSet openapiRequiredFields; + + static { + // a set of all properties/fields (JSON key names) + openapiFields = new HashSet(); + openapiFields.add("engagementCandidates"); + + // a set of required properties/fields (JSON key names) + openapiRequiredFields = new HashSet(); + } + + /** + * Validates the JSON Object and throws an exception if issues found + * + * @param jsonObj JSON Object + * @throws IOException if the JSON Object is invalid with respect to BatchCommunityEngageOut + */ + public static void validateJsonObject(JsonObject jsonObj) throws IOException { + if (jsonObj == null) { + if (!BatchCommunityEngageOut.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null + throw new IllegalArgumentException(String.format("The required field(s) %s in BatchCommunityEngageOut is not found in the empty JSON string", BatchCommunityEngageOut.openapiRequiredFields.toString())); + } + } + + Set> entries = jsonObj.entrySet(); + // check to see if the JSON string contains additional fields + for (Entry entry : entries) { + if (!BatchCommunityEngageOut.openapiFields.contains(entry.getKey())) { + throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `BatchCommunityEngageOut` properties. JSON: %s", entry.getKey(), jsonObj.toString())); + } + } + if (jsonObj.get("engagementCandidates") != null && !jsonObj.get("engagementCandidates").isJsonNull()) { + JsonArray jsonArrayengagementCandidates = jsonObj.getAsJsonArray("engagementCandidates"); + if (jsonArrayengagementCandidates != null) { + // ensure the json data is an array + if (!jsonObj.get("engagementCandidates").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `engagementCandidates` to be an array in the JSON string but got `%s`", jsonObj.get("engagementCandidates").toString())); + } + + // validate the optional field `engagementCandidates` (array) + for (int i = 0; i < jsonArrayengagementCandidates.size(); i++) { + CommunityEngageOut.validateJsonObject(jsonArrayengagementCandidates.get(i).getAsJsonObject()); + }; + } + } + } + + public static class CustomTypeAdapterFactory implements TypeAdapterFactory { + @SuppressWarnings("unchecked") + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + if (!BatchCommunityEngageOut.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'BatchCommunityEngageOut' and its subtypes + } + final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(BatchCommunityEngageOut.class)); + + return (TypeAdapter) new TypeAdapter() { + @Override + public void write(JsonWriter out, BatchCommunityEngageOut value) throws IOException { + JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); + elementAdapter.write(out, obj); + } + + @Override + public BatchCommunityEngageOut read(JsonReader in) throws IOException { + JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject(); + validateJsonObject(jsonObj); + return thisAdapter.fromJsonTree(jsonObj); + } + + }.nullSafe(); + } + } + + /** + * Create an instance of BatchCommunityEngageOut given an JSON string + * + * @param jsonString JSON string + * @return An instance of BatchCommunityEngageOut + * @throws IOException if the JSON string is invalid with respect to BatchCommunityEngageOut + */ + public static BatchCommunityEngageOut fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, BatchCommunityEngageOut.class); + } + + /** + * Convert an instance of BatchCommunityEngageOut to an JSON string + * + * @return JSON string + */ + public String toJson() { + return JSON.getGson().toJson(this); + } +} + diff --git a/src/main/java/com/namsor/sdk2/model/BatchCorridorIn.java b/src/main/java/com/namsor/sdk2/model/BatchCorridorIn.java index 3fa18ff0..a13b6d09 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchCorridorIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchCorridorIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchCorridorIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchCorridorIn { public static final String SERIALIZED_NAME_CORRIDOR_FROM_TO = "corridorFromTo"; @SerializedName(SERIALIZED_NAME_CORRIDOR_FROM_TO) diff --git a/src/main/java/com/namsor/sdk2/model/BatchCorridorOut.java b/src/main/java/com/namsor/sdk2/model/BatchCorridorOut.java index 9eca3656..4c71802e 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchCorridorOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchCorridorOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchCorridorOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchCorridorOut { public static final String SERIALIZED_NAME_CORRIDOR_FROM_TO = "corridorFromTo"; @SerializedName(SERIALIZED_NAME_CORRIDOR_FROM_TO) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameCasteOut.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameCasteOut.java index 21132b43..10498a30 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameCasteOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameCasteOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Represents the output of inferring the LIKELY origin from a list of personal names. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNameCasteOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameCastegroupOut.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameCastegroupOut.java index e37c1523..fc87a596 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameCastegroupOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameCastegroupOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Represents the output of inferring the LIKELY origin from a list of personal names. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNameCastegroupOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameDiasporaedOut.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameDiasporaedOut.java index 6f45c217..0b9467f4 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameDiasporaedOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameDiasporaedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Represents the output of inferring the LIKELY ethnicity from a personal name, given an country of residence. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNameDiasporaedOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGenderIn.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGenderIn.java index 6daffd90..e1e419d6 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGenderIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGenderIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchFirstLastNameGenderIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNameGenderIn { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGenderedOut.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGenderedOut.java index 93c5981c..e55de8b0 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGenderedOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGenderedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Represents the output of inferring the LIKELY gender from a list of personal names. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNameGenderedOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoIn.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoIn.java index d033dd76..f67b4f19 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchFirstLastNameGeoIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNameGeoIn { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoOut.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoOut.java new file mode 100644 index 00000000..6524e069 --- /dev/null +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoOut.java @@ -0,0 +1,230 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.FirstLastNameGeoOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonDeserializationContext; +import com.google.gson.JsonDeserializer; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.reflect.TypeToken; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +import java.lang.reflect.Type; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import com.namsor.sdk2.invoke.JSON; + +/** + * BatchFirstLastNameGeoOut + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") +public class BatchFirstLastNameGeoOut { + public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; + @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) + private List personalNames; + + public BatchFirstLastNameGeoOut() { + } + + public BatchFirstLastNameGeoOut personalNames(List personalNames) { + + this.personalNames = personalNames; + return this; + } + + public BatchFirstLastNameGeoOut addPersonalNamesItem(FirstLastNameGeoOut personalNamesItem) { + if (this.personalNames == null) { + this.personalNames = new ArrayList<>(); + } + this.personalNames.add(personalNamesItem); + return this; + } + + /** + * Classified names + * @return personalNames + **/ + @javax.annotation.Nullable + public List getPersonalNames() { + return personalNames; + } + + + public void setPersonalNames(List personalNames) { + this.personalNames = personalNames; + } + + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + BatchFirstLastNameGeoOut batchFirstLastNameGeoOut = (BatchFirstLastNameGeoOut) o; + return Objects.equals(this.personalNames, batchFirstLastNameGeoOut.personalNames); + } + + @Override + public int hashCode() { + return Objects.hash(personalNames); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class BatchFirstLastNameGeoOut {\n"); + sb.append(" personalNames: ").append(toIndentedString(personalNames)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + + public static HashSet openapiFields; + public static HashSet openapiRequiredFields; + + static { + // a set of all properties/fields (JSON key names) + openapiFields = new HashSet(); + openapiFields.add("personalNames"); + + // a set of required properties/fields (JSON key names) + openapiRequiredFields = new HashSet(); + } + + /** + * Validates the JSON Object and throws an exception if issues found + * + * @param jsonObj JSON Object + * @throws IOException if the JSON Object is invalid with respect to BatchFirstLastNameGeoOut + */ + public static void validateJsonObject(JsonObject jsonObj) throws IOException { + if (jsonObj == null) { + if (!BatchFirstLastNameGeoOut.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null + throw new IllegalArgumentException(String.format("The required field(s) %s in BatchFirstLastNameGeoOut is not found in the empty JSON string", BatchFirstLastNameGeoOut.openapiRequiredFields.toString())); + } + } + + Set> entries = jsonObj.entrySet(); + // check to see if the JSON string contains additional fields + for (Entry entry : entries) { + if (!BatchFirstLastNameGeoOut.openapiFields.contains(entry.getKey())) { + throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `BatchFirstLastNameGeoOut` properties. JSON: %s", entry.getKey(), jsonObj.toString())); + } + } + if (jsonObj.get("personalNames") != null && !jsonObj.get("personalNames").isJsonNull()) { + JsonArray jsonArraypersonalNames = jsonObj.getAsJsonArray("personalNames"); + if (jsonArraypersonalNames != null) { + // ensure the json data is an array + if (!jsonObj.get("personalNames").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `personalNames` to be an array in the JSON string but got `%s`", jsonObj.get("personalNames").toString())); + } + + // validate the optional field `personalNames` (array) + for (int i = 0; i < jsonArraypersonalNames.size(); i++) { + FirstLastNameGeoOut.validateJsonObject(jsonArraypersonalNames.get(i).getAsJsonObject()); + }; + } + } + } + + public static class CustomTypeAdapterFactory implements TypeAdapterFactory { + @SuppressWarnings("unchecked") + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + if (!BatchFirstLastNameGeoOut.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'BatchFirstLastNameGeoOut' and its subtypes + } + final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(BatchFirstLastNameGeoOut.class)); + + return (TypeAdapter) new TypeAdapter() { + @Override + public void write(JsonWriter out, BatchFirstLastNameGeoOut value) throws IOException { + JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); + elementAdapter.write(out, obj); + } + + @Override + public BatchFirstLastNameGeoOut read(JsonReader in) throws IOException { + JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject(); + validateJsonObject(jsonObj); + return thisAdapter.fromJsonTree(jsonObj); + } + + }.nullSafe(); + } + } + + /** + * Create an instance of BatchFirstLastNameGeoOut given an JSON string + * + * @param jsonString JSON string + * @return An instance of BatchFirstLastNameGeoOut + * @throws IOException if the JSON string is invalid with respect to BatchFirstLastNameGeoOut + */ + public static BatchFirstLastNameGeoOut fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, BatchFirstLastNameGeoOut.class); + } + + /** + * Convert an instance of BatchFirstLastNameGeoOut to an JSON string + * + * @return JSON string + */ + public String toJson() { + return JSON.getGson().toJson(this); + } +} + diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubclassificationOut.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubclassificationOut.java index 4c351d99..75ae99e9 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubclassificationOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubclassificationOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Represents the output of inferring the LIKELY country subclassification (regional names). */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNameGeoSubclassificationOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubdivisionIn.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubdivisionIn.java index feeec1fc..9797cfbb 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubdivisionIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubdivisionIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchFirstLastNameGeoSubdivisionIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNameGeoSubdivisionIn { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoZippedIn.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoZippedIn.java index 4e21a21a..ae82e42a 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoZippedIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameGeoZippedIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchFirstLastNameGeoZippedIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNameGeoZippedIn { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameIn.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameIn.java index 53a16b48..1e49b499 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchFirstLastNameIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNameIn { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameOriginedOut.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameOriginedOut.java index ff7d227c..faad2e67 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameOriginedOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameOriginedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Represents the output of inferring the LIKELY origin from a list of personal names. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNameOriginedOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneCodedOut.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneCodedOut.java index 334c576b..74aad0c5 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneCodedOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneCodedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Represents the output of inferring the LIKELY country and phone code of personal names+phones. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNamePhoneCodedOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES_WITH_PHONE_NUMBERS = "personalNamesWithPhoneNumbers"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES_WITH_PHONE_NUMBERS) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberGeoIn.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberGeoIn.java index 76701905..d4b20cae 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberGeoIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberGeoIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchFirstLastNamePhoneNumberGeoIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNamePhoneNumberGeoIn { public static final String SERIALIZED_NAME_PERSONAL_NAMES_WITH_PHONE_NUMBERS = "personalNamesWithPhoneNumbers"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES_WITH_PHONE_NUMBERS) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberIn.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberIn.java index 80c8acca..03d49de2 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchFirstLastNamePhoneNumberIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNamePhoneNumberIn { public static final String SERIALIZED_NAME_PERSONAL_NAMES_WITH_PHONE_NUMBERS = "personalNamesWithPhoneNumbers"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES_WITH_PHONE_NUMBERS) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameReligionedOut.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameReligionedOut.java index 834756cc..30d99889 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameReligionedOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameReligionedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Represents the output of inferring the LIKELY religion from a list of personal names. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNameReligionedOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameSubdivisionIn.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameSubdivisionIn.java index 7ac13b18..98c89fe3 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameSubdivisionIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameSubdivisionIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchFirstLastNameSubdivisionIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNameSubdivisionIn { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameUSRaceEthnicityOut.java b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameUSRaceEthnicityOut.java index c4cbbb98..1021712b 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameUSRaceEthnicityOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchFirstLastNameUSRaceEthnicityOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Represents the output of inferring the LIKELY US 'race/ethnicity' from a personal name, given US country of residence and (optionally) a ZIP5 code. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchFirstLastNameUSRaceEthnicityOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchMatchPersonalFirstLastNameIn.java b/src/main/java/com/namsor/sdk2/model/BatchMatchPersonalFirstLastNameIn.java index 13394c11..0b5a89ca 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchMatchPersonalFirstLastNameIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchMatchPersonalFirstLastNameIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchMatchPersonalFirstLastNameIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchMatchPersonalFirstLastNameIn { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchNameGeoIn.java b/src/main/java/com/namsor/sdk2/model/BatchNameGeoIn.java index 4078fa22..3bf6898e 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchNameGeoIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchNameGeoIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchNameGeoIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchNameGeoIn { public static final String SERIALIZED_NAME_PROPER_NOUNS = "properNouns"; @SerializedName(SERIALIZED_NAME_PROPER_NOUNS) diff --git a/src/main/java/com/namsor/sdk2/model/BatchNameIn.java b/src/main/java/com/namsor/sdk2/model/BatchNameIn.java index 9f4fcf2f..b0de02ae 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchNameIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchNameIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchNameIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchNameIn { public static final String SERIALIZED_NAME_PROPER_NOUNS = "properNouns"; @SerializedName(SERIALIZED_NAME_PROPER_NOUNS) diff --git a/src/main/java/com/namsor/sdk2/model/BatchNameMatchCandidatesOut.java b/src/main/java/com/namsor/sdk2/model/BatchNameMatchCandidatesOut.java index f299f3ba..f0985794 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchNameMatchCandidatesOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchNameMatchCandidatesOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchNameMatchCandidatesOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchNameMatchCandidatesOut { public static final String SERIALIZED_NAME_NAMES_AND_MATCH_CANDIDATES = "namesAndMatchCandidates"; @SerializedName(SERIALIZED_NAME_NAMES_AND_MATCH_CANDIDATES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchNameMatchedOut.java b/src/main/java/com/namsor/sdk2/model/BatchNameMatchedOut.java index 55a36c6d..a847dd5d 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchNameMatchedOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchNameMatchedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchNameMatchedOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchNameMatchedOut { public static final String SERIALIZED_NAME_MATCHED_NAMES = "matchedNames"; @SerializedName(SERIALIZED_NAME_MATCHED_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameCastegroupOut.java b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameCastegroupOut.java index e17b7093..8c5328af 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameCastegroupOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameCastegroupOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchPersonalNameCastegroupOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchPersonalNameCastegroupOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameDiasporaedOut.java b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameDiasporaedOut.java new file mode 100644 index 00000000..52abb686 --- /dev/null +++ b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameDiasporaedOut.java @@ -0,0 +1,230 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.PersonalNameDiasporaedOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonDeserializationContext; +import com.google.gson.JsonDeserializer; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.reflect.TypeToken; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +import java.lang.reflect.Type; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import com.namsor.sdk2.invoke.JSON; + +/** + * Represents the output of inferring the LIKELY ethnicity from a personal name, given an country of residence. + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") +public class BatchPersonalNameDiasporaedOut { + public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; + @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) + private List personalNames; + + public BatchPersonalNameDiasporaedOut() { + } + + public BatchPersonalNameDiasporaedOut personalNames(List personalNames) { + + this.personalNames = personalNames; + return this; + } + + public BatchPersonalNameDiasporaedOut addPersonalNamesItem(PersonalNameDiasporaedOut personalNamesItem) { + if (this.personalNames == null) { + this.personalNames = new ArrayList<>(); + } + this.personalNames.add(personalNamesItem); + return this; + } + + /** + * Classified diaspora names + * @return personalNames + **/ + @javax.annotation.Nullable + public List getPersonalNames() { + return personalNames; + } + + + public void setPersonalNames(List personalNames) { + this.personalNames = personalNames; + } + + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + BatchPersonalNameDiasporaedOut batchPersonalNameDiasporaedOut = (BatchPersonalNameDiasporaedOut) o; + return Objects.equals(this.personalNames, batchPersonalNameDiasporaedOut.personalNames); + } + + @Override + public int hashCode() { + return Objects.hash(personalNames); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class BatchPersonalNameDiasporaedOut {\n"); + sb.append(" personalNames: ").append(toIndentedString(personalNames)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + + public static HashSet openapiFields; + public static HashSet openapiRequiredFields; + + static { + // a set of all properties/fields (JSON key names) + openapiFields = new HashSet(); + openapiFields.add("personalNames"); + + // a set of required properties/fields (JSON key names) + openapiRequiredFields = new HashSet(); + } + + /** + * Validates the JSON Object and throws an exception if issues found + * + * @param jsonObj JSON Object + * @throws IOException if the JSON Object is invalid with respect to BatchPersonalNameDiasporaedOut + */ + public static void validateJsonObject(JsonObject jsonObj) throws IOException { + if (jsonObj == null) { + if (!BatchPersonalNameDiasporaedOut.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null + throw new IllegalArgumentException(String.format("The required field(s) %s in BatchPersonalNameDiasporaedOut is not found in the empty JSON string", BatchPersonalNameDiasporaedOut.openapiRequiredFields.toString())); + } + } + + Set> entries = jsonObj.entrySet(); + // check to see if the JSON string contains additional fields + for (Entry entry : entries) { + if (!BatchPersonalNameDiasporaedOut.openapiFields.contains(entry.getKey())) { + throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `BatchPersonalNameDiasporaedOut` properties. JSON: %s", entry.getKey(), jsonObj.toString())); + } + } + if (jsonObj.get("personalNames") != null && !jsonObj.get("personalNames").isJsonNull()) { + JsonArray jsonArraypersonalNames = jsonObj.getAsJsonArray("personalNames"); + if (jsonArraypersonalNames != null) { + // ensure the json data is an array + if (!jsonObj.get("personalNames").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `personalNames` to be an array in the JSON string but got `%s`", jsonObj.get("personalNames").toString())); + } + + // validate the optional field `personalNames` (array) + for (int i = 0; i < jsonArraypersonalNames.size(); i++) { + PersonalNameDiasporaedOut.validateJsonObject(jsonArraypersonalNames.get(i).getAsJsonObject()); + }; + } + } + } + + public static class CustomTypeAdapterFactory implements TypeAdapterFactory { + @SuppressWarnings("unchecked") + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + if (!BatchPersonalNameDiasporaedOut.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'BatchPersonalNameDiasporaedOut' and its subtypes + } + final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(BatchPersonalNameDiasporaedOut.class)); + + return (TypeAdapter) new TypeAdapter() { + @Override + public void write(JsonWriter out, BatchPersonalNameDiasporaedOut value) throws IOException { + JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); + elementAdapter.write(out, obj); + } + + @Override + public BatchPersonalNameDiasporaedOut read(JsonReader in) throws IOException { + JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject(); + validateJsonObject(jsonObj); + return thisAdapter.fromJsonTree(jsonObj); + } + + }.nullSafe(); + } + } + + /** + * Create an instance of BatchPersonalNameDiasporaedOut given an JSON string + * + * @param jsonString JSON string + * @return An instance of BatchPersonalNameDiasporaedOut + * @throws IOException if the JSON string is invalid with respect to BatchPersonalNameDiasporaedOut + */ + public static BatchPersonalNameDiasporaedOut fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, BatchPersonalNameDiasporaedOut.class); + } + + /** + * Convert an instance of BatchPersonalNameDiasporaedOut to an JSON string + * + * @return JSON string + */ + public String toJson() { + return JSON.getGson().toJson(this); + } +} + diff --git a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGenderedOut.java b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGenderedOut.java index f811b78b..44eb0884 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGenderedOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGenderedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchPersonalNameGenderedOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchPersonalNameGenderedOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoIn.java b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoIn.java index a727445c..cfd8721f 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchPersonalNameGeoIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchPersonalNameGeoIn { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoOut.java b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoOut.java index 75665acd..0ac296ef 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchPersonalNameGeoOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchPersonalNameGeoOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubclassificationOut.java b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubclassificationOut.java index 073ca2c6..a6bf1da8 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubclassificationOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubclassificationOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Represents the output of inferring the LIKELY country subclassification (regional names). */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchPersonalNameGeoSubclassificationOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubdivisionIn.java b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubdivisionIn.java index cbc85230..5f12270e 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubdivisionIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubdivisionIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchPersonalNameGeoSubdivisionIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchPersonalNameGeoSubdivisionIn { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameIn.java b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameIn.java index 1ffd0052..eac45264 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchPersonalNameIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchPersonalNameIn { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameOriginedOut.java b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameOriginedOut.java new file mode 100644 index 00000000..c9540efd --- /dev/null +++ b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameOriginedOut.java @@ -0,0 +1,230 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.PersonalNameOriginedOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonDeserializationContext; +import com.google.gson.JsonDeserializer; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.reflect.TypeToken; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +import java.lang.reflect.Type; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import com.namsor.sdk2.invoke.JSON; + +/** + * Represents the output of inferring the LIKELY origin from a list of personal names. + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") +public class BatchPersonalNameOriginedOut { + public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; + @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) + private List personalNames; + + public BatchPersonalNameOriginedOut() { + } + + public BatchPersonalNameOriginedOut personalNames(List personalNames) { + + this.personalNames = personalNames; + return this; + } + + public BatchPersonalNameOriginedOut addPersonalNamesItem(PersonalNameOriginedOut personalNamesItem) { + if (this.personalNames == null) { + this.personalNames = new ArrayList<>(); + } + this.personalNames.add(personalNamesItem); + return this; + } + + /** + * Classified origined names + * @return personalNames + **/ + @javax.annotation.Nullable + public List getPersonalNames() { + return personalNames; + } + + + public void setPersonalNames(List personalNames) { + this.personalNames = personalNames; + } + + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + BatchPersonalNameOriginedOut batchPersonalNameOriginedOut = (BatchPersonalNameOriginedOut) o; + return Objects.equals(this.personalNames, batchPersonalNameOriginedOut.personalNames); + } + + @Override + public int hashCode() { + return Objects.hash(personalNames); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class BatchPersonalNameOriginedOut {\n"); + sb.append(" personalNames: ").append(toIndentedString(personalNames)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + + public static HashSet openapiFields; + public static HashSet openapiRequiredFields; + + static { + // a set of all properties/fields (JSON key names) + openapiFields = new HashSet(); + openapiFields.add("personalNames"); + + // a set of required properties/fields (JSON key names) + openapiRequiredFields = new HashSet(); + } + + /** + * Validates the JSON Object and throws an exception if issues found + * + * @param jsonObj JSON Object + * @throws IOException if the JSON Object is invalid with respect to BatchPersonalNameOriginedOut + */ + public static void validateJsonObject(JsonObject jsonObj) throws IOException { + if (jsonObj == null) { + if (!BatchPersonalNameOriginedOut.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null + throw new IllegalArgumentException(String.format("The required field(s) %s in BatchPersonalNameOriginedOut is not found in the empty JSON string", BatchPersonalNameOriginedOut.openapiRequiredFields.toString())); + } + } + + Set> entries = jsonObj.entrySet(); + // check to see if the JSON string contains additional fields + for (Entry entry : entries) { + if (!BatchPersonalNameOriginedOut.openapiFields.contains(entry.getKey())) { + throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `BatchPersonalNameOriginedOut` properties. JSON: %s", entry.getKey(), jsonObj.toString())); + } + } + if (jsonObj.get("personalNames") != null && !jsonObj.get("personalNames").isJsonNull()) { + JsonArray jsonArraypersonalNames = jsonObj.getAsJsonArray("personalNames"); + if (jsonArraypersonalNames != null) { + // ensure the json data is an array + if (!jsonObj.get("personalNames").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `personalNames` to be an array in the JSON string but got `%s`", jsonObj.get("personalNames").toString())); + } + + // validate the optional field `personalNames` (array) + for (int i = 0; i < jsonArraypersonalNames.size(); i++) { + PersonalNameOriginedOut.validateJsonObject(jsonArraypersonalNames.get(i).getAsJsonObject()); + }; + } + } + } + + public static class CustomTypeAdapterFactory implements TypeAdapterFactory { + @SuppressWarnings("unchecked") + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + if (!BatchPersonalNameOriginedOut.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'BatchPersonalNameOriginedOut' and its subtypes + } + final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(BatchPersonalNameOriginedOut.class)); + + return (TypeAdapter) new TypeAdapter() { + @Override + public void write(JsonWriter out, BatchPersonalNameOriginedOut value) throws IOException { + JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); + elementAdapter.write(out, obj); + } + + @Override + public BatchPersonalNameOriginedOut read(JsonReader in) throws IOException { + JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject(); + validateJsonObject(jsonObj); + return thisAdapter.fromJsonTree(jsonObj); + } + + }.nullSafe(); + } + } + + /** + * Create an instance of BatchPersonalNameOriginedOut given an JSON string + * + * @param jsonString JSON string + * @return An instance of BatchPersonalNameOriginedOut + * @throws IOException if the JSON string is invalid with respect to BatchPersonalNameOriginedOut + */ + public static BatchPersonalNameOriginedOut fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, BatchPersonalNameOriginedOut.class); + } + + /** + * Convert an instance of BatchPersonalNameOriginedOut to an JSON string + * + * @return JSON string + */ + public String toJson() { + return JSON.getGson().toJson(this); + } +} + diff --git a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameParsedOut.java b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameParsedOut.java index f40650e4..03d2e8d3 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameParsedOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameParsedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchPersonalNameParsedOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchPersonalNameParsedOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameReligionedOut.java b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameReligionedOut.java index 6cce0d3a..8bf8c8ce 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameReligionedOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameReligionedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchPersonalNameReligionedOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchPersonalNameReligionedOut { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameSubdivisionIn.java b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameSubdivisionIn.java index c6b900cb..bf9ff52a 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameSubdivisionIn.java +++ b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameSubdivisionIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * BatchPersonalNameSubdivisionIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchPersonalNameSubdivisionIn { public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) diff --git a/src/main/java/com/namsor/sdk2/model/BatchPersonalNameUSRaceEthnicityOut.java b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameUSRaceEthnicityOut.java new file mode 100644 index 00000000..8b1b3d19 --- /dev/null +++ b/src/main/java/com/namsor/sdk2/model/BatchPersonalNameUSRaceEthnicityOut.java @@ -0,0 +1,230 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.PersonalNameUSRaceEthnicityOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonDeserializationContext; +import com.google.gson.JsonDeserializer; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.reflect.TypeToken; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +import java.lang.reflect.Type; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import com.namsor.sdk2.invoke.JSON; + +/** + * Represents the output of inferring the LIKELY US race/ethnicity from a list of personal names. + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") +public class BatchPersonalNameUSRaceEthnicityOut { + public static final String SERIALIZED_NAME_PERSONAL_NAMES = "personalNames"; + @SerializedName(SERIALIZED_NAME_PERSONAL_NAMES) + private List personalNames; + + public BatchPersonalNameUSRaceEthnicityOut() { + } + + public BatchPersonalNameUSRaceEthnicityOut personalNames(List personalNames) { + + this.personalNames = personalNames; + return this; + } + + public BatchPersonalNameUSRaceEthnicityOut addPersonalNamesItem(PersonalNameUSRaceEthnicityOut personalNamesItem) { + if (this.personalNames == null) { + this.personalNames = new ArrayList<>(); + } + this.personalNames.add(personalNamesItem); + return this; + } + + /** + * Classified origined names + * @return personalNames + **/ + @javax.annotation.Nullable + public List getPersonalNames() { + return personalNames; + } + + + public void setPersonalNames(List personalNames) { + this.personalNames = personalNames; + } + + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + BatchPersonalNameUSRaceEthnicityOut batchPersonalNameUSRaceEthnicityOut = (BatchPersonalNameUSRaceEthnicityOut) o; + return Objects.equals(this.personalNames, batchPersonalNameUSRaceEthnicityOut.personalNames); + } + + @Override + public int hashCode() { + return Objects.hash(personalNames); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class BatchPersonalNameUSRaceEthnicityOut {\n"); + sb.append(" personalNames: ").append(toIndentedString(personalNames)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + + public static HashSet openapiFields; + public static HashSet openapiRequiredFields; + + static { + // a set of all properties/fields (JSON key names) + openapiFields = new HashSet(); + openapiFields.add("personalNames"); + + // a set of required properties/fields (JSON key names) + openapiRequiredFields = new HashSet(); + } + + /** + * Validates the JSON Object and throws an exception if issues found + * + * @param jsonObj JSON Object + * @throws IOException if the JSON Object is invalid with respect to BatchPersonalNameUSRaceEthnicityOut + */ + public static void validateJsonObject(JsonObject jsonObj) throws IOException { + if (jsonObj == null) { + if (!BatchPersonalNameUSRaceEthnicityOut.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null + throw new IllegalArgumentException(String.format("The required field(s) %s in BatchPersonalNameUSRaceEthnicityOut is not found in the empty JSON string", BatchPersonalNameUSRaceEthnicityOut.openapiRequiredFields.toString())); + } + } + + Set> entries = jsonObj.entrySet(); + // check to see if the JSON string contains additional fields + for (Entry entry : entries) { + if (!BatchPersonalNameUSRaceEthnicityOut.openapiFields.contains(entry.getKey())) { + throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `BatchPersonalNameUSRaceEthnicityOut` properties. JSON: %s", entry.getKey(), jsonObj.toString())); + } + } + if (jsonObj.get("personalNames") != null && !jsonObj.get("personalNames").isJsonNull()) { + JsonArray jsonArraypersonalNames = jsonObj.getAsJsonArray("personalNames"); + if (jsonArraypersonalNames != null) { + // ensure the json data is an array + if (!jsonObj.get("personalNames").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `personalNames` to be an array in the JSON string but got `%s`", jsonObj.get("personalNames").toString())); + } + + // validate the optional field `personalNames` (array) + for (int i = 0; i < jsonArraypersonalNames.size(); i++) { + PersonalNameUSRaceEthnicityOut.validateJsonObject(jsonArraypersonalNames.get(i).getAsJsonObject()); + }; + } + } + } + + public static class CustomTypeAdapterFactory implements TypeAdapterFactory { + @SuppressWarnings("unchecked") + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + if (!BatchPersonalNameUSRaceEthnicityOut.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'BatchPersonalNameUSRaceEthnicityOut' and its subtypes + } + final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(BatchPersonalNameUSRaceEthnicityOut.class)); + + return (TypeAdapter) new TypeAdapter() { + @Override + public void write(JsonWriter out, BatchPersonalNameUSRaceEthnicityOut value) throws IOException { + JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); + elementAdapter.write(out, obj); + } + + @Override + public BatchPersonalNameUSRaceEthnicityOut read(JsonReader in) throws IOException { + JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject(); + validateJsonObject(jsonObj); + return thisAdapter.fromJsonTree(jsonObj); + } + + }.nullSafe(); + } + } + + /** + * Create an instance of BatchPersonalNameUSRaceEthnicityOut given an JSON string + * + * @param jsonString JSON string + * @return An instance of BatchPersonalNameUSRaceEthnicityOut + * @throws IOException if the JSON string is invalid with respect to BatchPersonalNameUSRaceEthnicityOut + */ + public static BatchPersonalNameUSRaceEthnicityOut fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, BatchPersonalNameUSRaceEthnicityOut.class); + } + + /** + * Convert an instance of BatchPersonalNameUSRaceEthnicityOut to an JSON string + * + * @return JSON string + */ + public String toJson() { + return JSON.getGson().toJson(this); + } +} + diff --git a/src/main/java/com/namsor/sdk2/model/BatchProperNounCategorizedOut.java b/src/main/java/com/namsor/sdk2/model/BatchProperNounCategorizedOut.java index 443ef547..b5443e4a 100644 --- a/src/main/java/com/namsor/sdk2/model/BatchProperNounCategorizedOut.java +++ b/src/main/java/com/namsor/sdk2/model/BatchProperNounCategorizedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Represents the output of inferring the common type (anthroponym, toponym, brand, etc.) from a list of proper names. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class BatchProperNounCategorizedOut { public static final String SERIALIZED_NAME_PROPER_NOUNS = "properNouns"; @SerializedName(SERIALIZED_NAME_PROPER_NOUNS) diff --git a/src/main/java/com/namsor/sdk2/model/CommunityEngageOptionOut.java b/src/main/java/com/namsor/sdk2/model/CommunityEngageOptionOut.java new file mode 100644 index 00000000..4576e0ae --- /dev/null +++ b/src/main/java/com/namsor/sdk2/model/CommunityEngageOptionOut.java @@ -0,0 +1,339 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonDeserializationContext; +import com.google.gson.JsonDeserializer; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.reflect.TypeToken; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +import java.lang.reflect.Type; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import com.namsor.sdk2.invoke.JSON; + +/** + * CommunityEngageOptionOut + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") +public class CommunityEngageOptionOut { + public static final String SERIALIZED_NAME_GENDER_FILTER = "genderFilter"; + @SerializedName(SERIALIZED_NAME_GENDER_FILTER) + private List genderFilter; + + public static final String SERIALIZED_NAME_ETHNICITY_FILTER = "ethnicityFilter"; + @SerializedName(SERIALIZED_NAME_ETHNICITY_FILTER) + private List ethnicityFilter; + + public static final String SERIALIZED_NAME_COUNTRY_OUT_FILTER = "countryOutFilter"; + @SerializedName(SERIALIZED_NAME_COUNTRY_OUT_FILTER) + private List countryOutFilter; + + public static final String SERIALIZED_NAME_US_RACE_ETHNICITY_FILTER = "usRaceEthnicityFilter"; + @SerializedName(SERIALIZED_NAME_US_RACE_ETHNICITY_FILTER) + private List usRaceEthnicityFilter; + + public CommunityEngageOptionOut() { + } + + public CommunityEngageOptionOut genderFilter(List genderFilter) { + + this.genderFilter = genderFilter; + return this; + } + + public CommunityEngageOptionOut addGenderFilterItem(String genderFilterItem) { + if (this.genderFilter == null) { + this.genderFilter = new ArrayList<>(); + } + this.genderFilter.add(genderFilterItem); + return this; + } + + /** + * The gender filter (null to allow all) + * @return genderFilter + **/ + @javax.annotation.Nullable + public List getGenderFilter() { + return genderFilter; + } + + + public void setGenderFilter(List genderFilter) { + this.genderFilter = genderFilter; + } + + + public CommunityEngageOptionOut ethnicityFilter(List ethnicityFilter) { + + this.ethnicityFilter = ethnicityFilter; + return this; + } + + public CommunityEngageOptionOut addEthnicityFilterItem(String ethnicityFilterItem) { + if (this.ethnicityFilter == null) { + this.ethnicityFilter = new ArrayList<>(); + } + this.ethnicityFilter.add(ethnicityFilterItem); + return this; + } + + /** + * The ethnicity filter (null to allow all) + * @return ethnicityFilter + **/ + @javax.annotation.Nullable + public List getEthnicityFilter() { + return ethnicityFilter; + } + + + public void setEthnicityFilter(List ethnicityFilter) { + this.ethnicityFilter = ethnicityFilter; + } + + + public CommunityEngageOptionOut countryOutFilter(List countryOutFilter) { + + this.countryOutFilter = countryOutFilter; + return this; + } + + public CommunityEngageOptionOut addCountryOutFilterItem(String countryOutFilterItem) { + if (this.countryOutFilter == null) { + this.countryOutFilter = new ArrayList<>(); + } + this.countryOutFilter.add(countryOutFilterItem); + return this; + } + + /** + * The output country filter (null to allow all) + * @return countryOutFilter + **/ + @javax.annotation.Nullable + public List getCountryOutFilter() { + return countryOutFilter; + } + + + public void setCountryOutFilter(List countryOutFilter) { + this.countryOutFilter = countryOutFilter; + } + + + public CommunityEngageOptionOut usRaceEthnicityFilter(List usRaceEthnicityFilter) { + + this.usRaceEthnicityFilter = usRaceEthnicityFilter; + return this; + } + + public CommunityEngageOptionOut addUsRaceEthnicityFilterItem(String usRaceEthnicityFilterItem) { + if (this.usRaceEthnicityFilter == null) { + this.usRaceEthnicityFilter = new ArrayList<>(); + } + this.usRaceEthnicityFilter.add(usRaceEthnicityFilterItem); + return this; + } + + /** + * The output US race/ethnicity filter (null to allow all) + * @return usRaceEthnicityFilter + **/ + @javax.annotation.Nullable + public List getUsRaceEthnicityFilter() { + return usRaceEthnicityFilter; + } + + + public void setUsRaceEthnicityFilter(List usRaceEthnicityFilter) { + this.usRaceEthnicityFilter = usRaceEthnicityFilter; + } + + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CommunityEngageOptionOut communityEngageOptionOut = (CommunityEngageOptionOut) o; + return Objects.equals(this.genderFilter, communityEngageOptionOut.genderFilter) && + Objects.equals(this.ethnicityFilter, communityEngageOptionOut.ethnicityFilter) && + Objects.equals(this.countryOutFilter, communityEngageOptionOut.countryOutFilter) && + Objects.equals(this.usRaceEthnicityFilter, communityEngageOptionOut.usRaceEthnicityFilter); + } + + @Override + public int hashCode() { + return Objects.hash(genderFilter, ethnicityFilter, countryOutFilter, usRaceEthnicityFilter); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CommunityEngageOptionOut {\n"); + sb.append(" genderFilter: ").append(toIndentedString(genderFilter)).append("\n"); + sb.append(" ethnicityFilter: ").append(toIndentedString(ethnicityFilter)).append("\n"); + sb.append(" countryOutFilter: ").append(toIndentedString(countryOutFilter)).append("\n"); + sb.append(" usRaceEthnicityFilter: ").append(toIndentedString(usRaceEthnicityFilter)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + + public static HashSet openapiFields; + public static HashSet openapiRequiredFields; + + static { + // a set of all properties/fields (JSON key names) + openapiFields = new HashSet(); + openapiFields.add("genderFilter"); + openapiFields.add("ethnicityFilter"); + openapiFields.add("countryOutFilter"); + openapiFields.add("usRaceEthnicityFilter"); + + // a set of required properties/fields (JSON key names) + openapiRequiredFields = new HashSet(); + } + + /** + * Validates the JSON Object and throws an exception if issues found + * + * @param jsonObj JSON Object + * @throws IOException if the JSON Object is invalid with respect to CommunityEngageOptionOut + */ + public static void validateJsonObject(JsonObject jsonObj) throws IOException { + if (jsonObj == null) { + if (!CommunityEngageOptionOut.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null + throw new IllegalArgumentException(String.format("The required field(s) %s in CommunityEngageOptionOut is not found in the empty JSON string", CommunityEngageOptionOut.openapiRequiredFields.toString())); + } + } + + Set> entries = jsonObj.entrySet(); + // check to see if the JSON string contains additional fields + for (Entry entry : entries) { + if (!CommunityEngageOptionOut.openapiFields.contains(entry.getKey())) { + throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `CommunityEngageOptionOut` properties. JSON: %s", entry.getKey(), jsonObj.toString())); + } + } + // ensure the optional json data is an array if present + if (jsonObj.get("genderFilter") != null && !jsonObj.get("genderFilter").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `genderFilter` to be an array in the JSON string but got `%s`", jsonObj.get("genderFilter").toString())); + } + // ensure the optional json data is an array if present + if (jsonObj.get("ethnicityFilter") != null && !jsonObj.get("ethnicityFilter").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `ethnicityFilter` to be an array in the JSON string but got `%s`", jsonObj.get("ethnicityFilter").toString())); + } + // ensure the optional json data is an array if present + if (jsonObj.get("countryOutFilter") != null && !jsonObj.get("countryOutFilter").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `countryOutFilter` to be an array in the JSON string but got `%s`", jsonObj.get("countryOutFilter").toString())); + } + // ensure the optional json data is an array if present + if (jsonObj.get("usRaceEthnicityFilter") != null && !jsonObj.get("usRaceEthnicityFilter").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `usRaceEthnicityFilter` to be an array in the JSON string but got `%s`", jsonObj.get("usRaceEthnicityFilter").toString())); + } + } + + public static class CustomTypeAdapterFactory implements TypeAdapterFactory { + @SuppressWarnings("unchecked") + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + if (!CommunityEngageOptionOut.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'CommunityEngageOptionOut' and its subtypes + } + final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(CommunityEngageOptionOut.class)); + + return (TypeAdapter) new TypeAdapter() { + @Override + public void write(JsonWriter out, CommunityEngageOptionOut value) throws IOException { + JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); + elementAdapter.write(out, obj); + } + + @Override + public CommunityEngageOptionOut read(JsonReader in) throws IOException { + JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject(); + validateJsonObject(jsonObj); + return thisAdapter.fromJsonTree(jsonObj); + } + + }.nullSafe(); + } + } + + /** + * Create an instance of CommunityEngageOptionOut given an JSON string + * + * @param jsonString JSON string + * @return An instance of CommunityEngageOptionOut + * @throws IOException if the JSON string is invalid with respect to CommunityEngageOptionOut + */ + public static CommunityEngageOptionOut fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, CommunityEngageOptionOut.class); + } + + /** + * Convert an instance of CommunityEngageOptionOut to an JSON string + * + * @return JSON string + */ + public String toJson() { + return JSON.getGson().toJson(this); + } +} + diff --git a/src/main/java/com/namsor/sdk2/model/CommunityEngageOut.java b/src/main/java/com/namsor/sdk2/model/CommunityEngageOut.java new file mode 100644 index 00000000..70f2c549 --- /dev/null +++ b/src/main/java/com/namsor/sdk2/model/CommunityEngageOut.java @@ -0,0 +1,460 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.PersonalNameDiasporaedOut; +import com.namsor.sdk2.model.PersonalNameGenderedOut; +import com.namsor.sdk2.model.PersonalNameGeoOut; +import com.namsor.sdk2.model.PersonalNameOriginedOut; +import com.namsor.sdk2.model.PersonalNameUSRaceEthnicityOut; +import java.io.IOException; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonDeserializationContext; +import com.google.gson.JsonDeserializer; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.reflect.TypeToken; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +import java.lang.reflect.Type; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import com.namsor.sdk2.invoke.JSON; + +/** + * Represent multiple classifications for community engagement (gender, country, origin, diaspora) + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") +public class CommunityEngageOut { + public static final String SERIALIZED_NAME_ID = "id"; + @SerializedName(SERIALIZED_NAME_ID) + private String id; + + public static final String SERIALIZED_NAME_PERSONAL_NAME_DIASPORAED_OUT = "PersonalNameDiasporaedOut"; + @SerializedName(SERIALIZED_NAME_PERSONAL_NAME_DIASPORAED_OUT) + private PersonalNameDiasporaedOut personalNameDiasporaedOut; + + public static final String SERIALIZED_NAME_PERSONAL_NAME_ORIGINED_OUT = "PersonalNameOriginedOut"; + @SerializedName(SERIALIZED_NAME_PERSONAL_NAME_ORIGINED_OUT) + private PersonalNameOriginedOut personalNameOriginedOut; + + public static final String SERIALIZED_NAME_COUNTRY = "country"; + @SerializedName(SERIALIZED_NAME_COUNTRY) + private PersonalNameGeoOut country; + + public static final String SERIALIZED_NAME_GENDER = "gender"; + @SerializedName(SERIALIZED_NAME_GENDER) + private PersonalNameGenderedOut gender; + + public static final String SERIALIZED_NAME_PERSONAL_NAME_U_S_RACE_ETHNICITY_OUT = "PersonalNameUSRaceEthnicityOut"; + @SerializedName(SERIALIZED_NAME_PERSONAL_NAME_U_S_RACE_ETHNICITY_OUT) + private PersonalNameUSRaceEthnicityOut personalNameUSRaceEthnicityOut; + + public static final String SERIALIZED_NAME_PRIME = "prime"; + @SerializedName(SERIALIZED_NAME_PRIME) + private Boolean prime; + + public static final String SERIALIZED_NAME_SCOPED = "scoped"; + @SerializedName(SERIALIZED_NAME_SCOPED) + private Boolean scoped; + + public static final String SERIALIZED_NAME_SCRIPT = "script"; + @SerializedName(SERIALIZED_NAME_SCRIPT) + private String script; + + public CommunityEngageOut() { + } + + public CommunityEngageOut id(String id) { + + this.id = id; + return this; + } + + /** + * Get id + * @return id + **/ + @javax.annotation.Nullable + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public CommunityEngageOut personalNameDiasporaedOut(PersonalNameDiasporaedOut personalNameDiasporaedOut) { + + this.personalNameDiasporaedOut = personalNameDiasporaedOut; + return this; + } + + /** + * Get personalNameDiasporaedOut + * @return personalNameDiasporaedOut + **/ + @javax.annotation.Nullable + public PersonalNameDiasporaedOut getPersonalNameDiasporaedOut() { + return personalNameDiasporaedOut; + } + + + public void setPersonalNameDiasporaedOut(PersonalNameDiasporaedOut personalNameDiasporaedOut) { + this.personalNameDiasporaedOut = personalNameDiasporaedOut; + } + + + public CommunityEngageOut personalNameOriginedOut(PersonalNameOriginedOut personalNameOriginedOut) { + + this.personalNameOriginedOut = personalNameOriginedOut; + return this; + } + + /** + * Get personalNameOriginedOut + * @return personalNameOriginedOut + **/ + @javax.annotation.Nullable + public PersonalNameOriginedOut getPersonalNameOriginedOut() { + return personalNameOriginedOut; + } + + + public void setPersonalNameOriginedOut(PersonalNameOriginedOut personalNameOriginedOut) { + this.personalNameOriginedOut = personalNameOriginedOut; + } + + + public CommunityEngageOut country(PersonalNameGeoOut country) { + + this.country = country; + return this; + } + + /** + * Get country + * @return country + **/ + @javax.annotation.Nullable + public PersonalNameGeoOut getCountry() { + return country; + } + + + public void setCountry(PersonalNameGeoOut country) { + this.country = country; + } + + + public CommunityEngageOut gender(PersonalNameGenderedOut gender) { + + this.gender = gender; + return this; + } + + /** + * Get gender + * @return gender + **/ + @javax.annotation.Nullable + public PersonalNameGenderedOut getGender() { + return gender; + } + + + public void setGender(PersonalNameGenderedOut gender) { + this.gender = gender; + } + + + public CommunityEngageOut personalNameUSRaceEthnicityOut(PersonalNameUSRaceEthnicityOut personalNameUSRaceEthnicityOut) { + + this.personalNameUSRaceEthnicityOut = personalNameUSRaceEthnicityOut; + return this; + } + + /** + * Get personalNameUSRaceEthnicityOut + * @return personalNameUSRaceEthnicityOut + **/ + @javax.annotation.Nullable + public PersonalNameUSRaceEthnicityOut getPersonalNameUSRaceEthnicityOut() { + return personalNameUSRaceEthnicityOut; + } + + + public void setPersonalNameUSRaceEthnicityOut(PersonalNameUSRaceEthnicityOut personalNameUSRaceEthnicityOut) { + this.personalNameUSRaceEthnicityOut = personalNameUSRaceEthnicityOut; + } + + + public CommunityEngageOut prime(Boolean prime) { + + this.prime = prime; + return this; + } + + /** + * Get prime + * @return prime + **/ + @javax.annotation.Nullable + public Boolean getPrime() { + return prime; + } + + + public void setPrime(Boolean prime) { + this.prime = prime; + } + + + public CommunityEngageOut scoped(Boolean scoped) { + + this.scoped = scoped; + return this; + } + + /** + * Get scoped + * @return scoped + **/ + @javax.annotation.Nullable + public Boolean getScoped() { + return scoped; + } + + + public void setScoped(Boolean scoped) { + this.scoped = scoped; + } + + + public CommunityEngageOut script(String script) { + + this.script = script; + return this; + } + + /** + * Get script + * @return script + **/ + @javax.annotation.Nullable + public String getScript() { + return script; + } + + + public void setScript(String script) { + this.script = script; + } + + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CommunityEngageOut communityEngageOut = (CommunityEngageOut) o; + return Objects.equals(this.id, communityEngageOut.id) && + Objects.equals(this.personalNameDiasporaedOut, communityEngageOut.personalNameDiasporaedOut) && + Objects.equals(this.personalNameOriginedOut, communityEngageOut.personalNameOriginedOut) && + Objects.equals(this.country, communityEngageOut.country) && + Objects.equals(this.gender, communityEngageOut.gender) && + Objects.equals(this.personalNameUSRaceEthnicityOut, communityEngageOut.personalNameUSRaceEthnicityOut) && + Objects.equals(this.prime, communityEngageOut.prime) && + Objects.equals(this.scoped, communityEngageOut.scoped) && + Objects.equals(this.script, communityEngageOut.script); + } + + @Override + public int hashCode() { + return Objects.hash(id, personalNameDiasporaedOut, personalNameOriginedOut, country, gender, personalNameUSRaceEthnicityOut, prime, scoped, script); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CommunityEngageOut {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" personalNameDiasporaedOut: ").append(toIndentedString(personalNameDiasporaedOut)).append("\n"); + sb.append(" personalNameOriginedOut: ").append(toIndentedString(personalNameOriginedOut)).append("\n"); + sb.append(" country: ").append(toIndentedString(country)).append("\n"); + sb.append(" gender: ").append(toIndentedString(gender)).append("\n"); + sb.append(" personalNameUSRaceEthnicityOut: ").append(toIndentedString(personalNameUSRaceEthnicityOut)).append("\n"); + sb.append(" prime: ").append(toIndentedString(prime)).append("\n"); + sb.append(" scoped: ").append(toIndentedString(scoped)).append("\n"); + sb.append(" script: ").append(toIndentedString(script)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + + public static HashSet openapiFields; + public static HashSet openapiRequiredFields; + + static { + // a set of all properties/fields (JSON key names) + openapiFields = new HashSet(); + openapiFields.add("id"); + openapiFields.add("PersonalNameDiasporaedOut"); + openapiFields.add("PersonalNameOriginedOut"); + openapiFields.add("country"); + openapiFields.add("gender"); + openapiFields.add("PersonalNameUSRaceEthnicityOut"); + openapiFields.add("prime"); + openapiFields.add("scoped"); + openapiFields.add("script"); + + // a set of required properties/fields (JSON key names) + openapiRequiredFields = new HashSet(); + } + + /** + * Validates the JSON Object and throws an exception if issues found + * + * @param jsonObj JSON Object + * @throws IOException if the JSON Object is invalid with respect to CommunityEngageOut + */ + public static void validateJsonObject(JsonObject jsonObj) throws IOException { + if (jsonObj == null) { + if (!CommunityEngageOut.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null + throw new IllegalArgumentException(String.format("The required field(s) %s in CommunityEngageOut is not found in the empty JSON string", CommunityEngageOut.openapiRequiredFields.toString())); + } + } + + Set> entries = jsonObj.entrySet(); + // check to see if the JSON string contains additional fields + for (Entry entry : entries) { + if (!CommunityEngageOut.openapiFields.contains(entry.getKey())) { + throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `CommunityEngageOut` properties. JSON: %s", entry.getKey(), jsonObj.toString())); + } + } + if ((jsonObj.get("id") != null && !jsonObj.get("id").isJsonNull()) && !jsonObj.get("id").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("id").toString())); + } + // validate the optional field `PersonalNameDiasporaedOut` + if (jsonObj.get("PersonalNameDiasporaedOut") != null && !jsonObj.get("PersonalNameDiasporaedOut").isJsonNull()) { + PersonalNameDiasporaedOut.validateJsonObject(jsonObj.getAsJsonObject("PersonalNameDiasporaedOut")); + } + // validate the optional field `PersonalNameOriginedOut` + if (jsonObj.get("PersonalNameOriginedOut") != null && !jsonObj.get("PersonalNameOriginedOut").isJsonNull()) { + PersonalNameOriginedOut.validateJsonObject(jsonObj.getAsJsonObject("PersonalNameOriginedOut")); + } + // validate the optional field `country` + if (jsonObj.get("country") != null && !jsonObj.get("country").isJsonNull()) { + PersonalNameGeoOut.validateJsonObject(jsonObj.getAsJsonObject("country")); + } + // validate the optional field `gender` + if (jsonObj.get("gender") != null && !jsonObj.get("gender").isJsonNull()) { + PersonalNameGenderedOut.validateJsonObject(jsonObj.getAsJsonObject("gender")); + } + // validate the optional field `PersonalNameUSRaceEthnicityOut` + if (jsonObj.get("PersonalNameUSRaceEthnicityOut") != null && !jsonObj.get("PersonalNameUSRaceEthnicityOut").isJsonNull()) { + PersonalNameUSRaceEthnicityOut.validateJsonObject(jsonObj.getAsJsonObject("PersonalNameUSRaceEthnicityOut")); + } + if ((jsonObj.get("script") != null && !jsonObj.get("script").isJsonNull()) && !jsonObj.get("script").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `script` to be a primitive type in the JSON string but got `%s`", jsonObj.get("script").toString())); + } + } + + public static class CustomTypeAdapterFactory implements TypeAdapterFactory { + @SuppressWarnings("unchecked") + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + if (!CommunityEngageOut.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'CommunityEngageOut' and its subtypes + } + final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(CommunityEngageOut.class)); + + return (TypeAdapter) new TypeAdapter() { + @Override + public void write(JsonWriter out, CommunityEngageOut value) throws IOException { + JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); + elementAdapter.write(out, obj); + } + + @Override + public CommunityEngageOut read(JsonReader in) throws IOException { + JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject(); + validateJsonObject(jsonObj); + return thisAdapter.fromJsonTree(jsonObj); + } + + }.nullSafe(); + } + } + + /** + * Create an instance of CommunityEngageOut given an JSON string + * + * @param jsonString JSON string + * @return An instance of CommunityEngageOut + * @throws IOException if the JSON string is invalid with respect to CommunityEngageOut + */ + public static CommunityEngageOut fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, CommunityEngageOut.class); + } + + /** + * Convert an instance of CommunityEngageOut to an JSON string + * + * @return JSON string + */ + public String toJson() { + return JSON.getGson().toJson(this); + } +} + diff --git a/src/main/java/com/namsor/sdk2/model/CorridorIn.java b/src/main/java/com/namsor/sdk2/model/CorridorIn.java index 0a3bd2a7..50700340 100644 --- a/src/main/java/com/namsor/sdk2/model/CorridorIn.java +++ b/src/main/java/com/namsor/sdk2/model/CorridorIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -51,7 +51,7 @@ /** * Represent any transnational interaction between names (ex. remittance, communication, cross-border investment, airline travel */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class CorridorIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/CorridorOut.java b/src/main/java/com/namsor/sdk2/model/CorridorOut.java index caacd2dd..40939804 100644 --- a/src/main/java/com/namsor/sdk2/model/CorridorOut.java +++ b/src/main/java/com/namsor/sdk2/model/CorridorOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Represent multiple classifications for corridor sender and receiver (gender, country, origin, diaspora) */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class CorridorOut { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/FeedbackLoopOut.java b/src/main/java/com/namsor/sdk2/model/FeedbackLoopOut.java index c7ac08a2..d2868d36 100644 --- a/src/main/java/com/namsor/sdk2/model/FeedbackLoopOut.java +++ b/src/main/java/com/namsor/sdk2/model/FeedbackLoopOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * FeedbackLoopOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FeedbackLoopOut { public static final String SERIALIZED_NAME_FEEDBACK_CREDITS = "feedbackCredits"; @SerializedName(SERIALIZED_NAME_FEEDBACK_CREDITS) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameCasteOut.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameCasteOut.java index 9f91da6c..c0acb508 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameCasteOut.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameCasteOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -52,7 +52,7 @@ /** * Represents the output of inferring the LIKELY caste from a personal Hindu/Indian name. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameCasteOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameCastegroupOut.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameCastegroupOut.java index 5871c755..2c128f07 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameCastegroupOut.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameCastegroupOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -52,7 +52,7 @@ /** * Represents the output of inferring the LIKELY caste group from a personal Hindu/Indian name. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameCastegroupOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameDiasporaedOut.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameDiasporaedOut.java index f0f07406..6d1f7aa8 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameDiasporaedOut.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameDiasporaedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Represents the output of inferring the LIKELY ethnicity from a personal name, given an country of residence. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameDiasporaedOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) @@ -449,7 +449,7 @@ public FirstLastNameDiasporaedOut addReligionStatsAltItem(ReligionStatOut religi } /** - * Geographic religious statistics, assuming ethnicity OR best alternative is correctly predicted. + * Geographic religious statistics, for country best alternative. * @return religionStatsAlt **/ @javax.annotation.Nullable diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameGenderIn.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameGenderIn.java index f85e3b32..015744f2 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameGenderIn.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameGenderIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * FirstLastNameGenderIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameGenderIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameGenderedOut.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameGenderedOut.java index 2c85e605..87b17cf6 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameGenderedOut.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameGenderedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * Represents the output of inferring the LIKELY gender from a personal name. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameGenderedOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoIn.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoIn.java index 3c9dc15a..6849b569 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoIn.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * FirstLastNameGeoIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameGeoIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoOut.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoOut.java new file mode 100644 index 00000000..ed00bac9 --- /dev/null +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoOut.java @@ -0,0 +1,720 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.ReligionStatOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonDeserializationContext; +import com.google.gson.JsonDeserializer; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.reflect.TypeToken; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +import java.lang.reflect.Type; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import com.namsor.sdk2.invoke.JSON; + +/** + * Represents the output of inferring the LIKELY country of Origin from a personal name. + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") +public class FirstLastNameGeoOut { + public static final String SERIALIZED_NAME_SCRIPT = "script"; + @SerializedName(SERIALIZED_NAME_SCRIPT) + private String script; + + public static final String SERIALIZED_NAME_ID = "id"; + @SerializedName(SERIALIZED_NAME_ID) + private String id; + + public static final String SERIALIZED_NAME_EXPLANATION = "explanation"; + @SerializedName(SERIALIZED_NAME_EXPLANATION) + private String explanation; + + public static final String SERIALIZED_NAME_FIRST_NAME = "firstName"; + @SerializedName(SERIALIZED_NAME_FIRST_NAME) + private String firstName; + + public static final String SERIALIZED_NAME_LAST_NAME = "lastName"; + @SerializedName(SERIALIZED_NAME_LAST_NAME) + private String lastName; + + public static final String SERIALIZED_NAME_SCORE = "score"; + @SerializedName(SERIALIZED_NAME_SCORE) + private Double score; + + public static final String SERIALIZED_NAME_COUNTRY = "country"; + @SerializedName(SERIALIZED_NAME_COUNTRY) + private String country; + + public static final String SERIALIZED_NAME_COUNTRY_ALT = "countryAlt"; + @SerializedName(SERIALIZED_NAME_COUNTRY_ALT) + private String countryAlt; + + public static final String SERIALIZED_NAME_REGION = "region"; + @SerializedName(SERIALIZED_NAME_REGION) + private String region; + + public static final String SERIALIZED_NAME_TOP_REGION = "topRegion"; + @SerializedName(SERIALIZED_NAME_TOP_REGION) + private String topRegion; + + public static final String SERIALIZED_NAME_SUB_REGION = "subRegion"; + @SerializedName(SERIALIZED_NAME_SUB_REGION) + private String subRegion; + + public static final String SERIALIZED_NAME_COUNTRIES_TOP = "countriesTop"; + @SerializedName(SERIALIZED_NAME_COUNTRIES_TOP) + private List countriesTop; + + public static final String SERIALIZED_NAME_PROBABILITY_CALIBRATED = "probabilityCalibrated"; + @SerializedName(SERIALIZED_NAME_PROBABILITY_CALIBRATED) + private Double probabilityCalibrated; + + public static final String SERIALIZED_NAME_PROBABILITY_ALT_CALIBRATED = "probabilityAltCalibrated"; + @SerializedName(SERIALIZED_NAME_PROBABILITY_ALT_CALIBRATED) + private Double probabilityAltCalibrated; + + public static final String SERIALIZED_NAME_RELIGION_STATS = "religionStats"; + @SerializedName(SERIALIZED_NAME_RELIGION_STATS) + private List religionStats; + + public static final String SERIALIZED_NAME_RELIGION_STATS_ALT = "religionStatsAlt"; + @SerializedName(SERIALIZED_NAME_RELIGION_STATS_ALT) + private List religionStatsAlt; + + public FirstLastNameGeoOut() { + } + + public FirstLastNameGeoOut script(String script) { + + this.script = script; + return this; + } + + /** + * Get script + * @return script + **/ + @javax.annotation.Nullable + public String getScript() { + return script; + } + + + public void setScript(String script) { + this.script = script; + } + + + public FirstLastNameGeoOut id(String id) { + + this.id = id; + return this; + } + + /** + * Get id + * @return id + **/ + @javax.annotation.Nullable + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public FirstLastNameGeoOut explanation(String explanation) { + + this.explanation = explanation; + return this; + } + + /** + * Get explanation + * @return explanation + **/ + @javax.annotation.Nullable + public String getExplanation() { + return explanation; + } + + + public void setExplanation(String explanation) { + this.explanation = explanation; + } + + + public FirstLastNameGeoOut firstName(String firstName) { + + this.firstName = firstName; + return this; + } + + /** + * The first name (also known as given name) + * @return firstName + **/ + @javax.annotation.Nullable + public String getFirstName() { + return firstName; + } + + + public void setFirstName(String firstName) { + this.firstName = firstName; + } + + + public FirstLastNameGeoOut lastName(String lastName) { + + this.lastName = lastName; + return this; + } + + /** + * The last name (also known as family name, or surname) + * @return lastName + **/ + @javax.annotation.Nullable + public String getLastName() { + return lastName; + } + + + public void setLastName(String lastName) { + this.lastName = lastName; + } + + + public FirstLastNameGeoOut score(Double score) { + + this.score = score; + return this; + } + + /** + * Higher score is better, but score is not normalized. Use calibratedProbability if available. + * minimum: 0 + * maximum: 100 + * @return score + **/ + @javax.annotation.Nullable + public Double getScore() { + return score; + } + + + public void setScore(Double score) { + this.score = score; + } + + + public FirstLastNameGeoOut country(String country) { + + this.country = country; + return this; + } + + /** + * Most likely country + * @return country + **/ + @javax.annotation.Nullable + public String getCountry() { + return country; + } + + + public void setCountry(String country) { + this.country = country; + } + + + public FirstLastNameGeoOut countryAlt(String countryAlt) { + + this.countryAlt = countryAlt; + return this; + } + + /** + * Second best alternative : country + * @return countryAlt + **/ + @javax.annotation.Nullable + public String getCountryAlt() { + return countryAlt; + } + + + public void setCountryAlt(String countryAlt) { + this.countryAlt = countryAlt; + } + + + public FirstLastNameGeoOut region(String region) { + + this.region = region; + return this; + } + + /** + * Most likely region (based on country ISO2 code) + * @return region + **/ + @javax.annotation.Nullable + public String getRegion() { + return region; + } + + + public void setRegion(String region) { + this.region = region; + } + + + public FirstLastNameGeoOut topRegion(String topRegion) { + + this.topRegion = topRegion; + return this; + } + + /** + * Most likely top region (based on country ISO2 code) + * @return topRegion + **/ + @javax.annotation.Nullable + public String getTopRegion() { + return topRegion; + } + + + public void setTopRegion(String topRegion) { + this.topRegion = topRegion; + } + + + public FirstLastNameGeoOut subRegion(String subRegion) { + + this.subRegion = subRegion; + return this; + } + + /** + * Most likely sub region (based on country ISO2 code) + * @return subRegion + **/ + @javax.annotation.Nullable + public String getSubRegion() { + return subRegion; + } + + + public void setSubRegion(String subRegion) { + this.subRegion = subRegion; + } + + + public FirstLastNameGeoOut countriesTop(List countriesTop) { + + this.countriesTop = countriesTop; + return this; + } + + public FirstLastNameGeoOut addCountriesTopItem(String countriesTopItem) { + if (this.countriesTop == null) { + this.countriesTop = new ArrayList<>(); + } + this.countriesTop.add(countriesTopItem); + return this; + } + + /** + * List countries (top 10) + * @return countriesTop + **/ + @javax.annotation.Nullable + public List getCountriesTop() { + return countriesTop; + } + + + public void setCountriesTop(List countriesTop) { + this.countriesTop = countriesTop; + } + + + public FirstLastNameGeoOut probabilityCalibrated(Double probabilityCalibrated) { + + this.probabilityCalibrated = probabilityCalibrated; + return this; + } + + /** + * The calibrated probability for country to have been guessed correctly. -1 = still calibrating. + * minimum: -1 + * maximum: 1 + * @return probabilityCalibrated + **/ + @javax.annotation.Nullable + public Double getProbabilityCalibrated() { + return probabilityCalibrated; + } + + + public void setProbabilityCalibrated(Double probabilityCalibrated) { + this.probabilityCalibrated = probabilityCalibrated; + } + + + public FirstLastNameGeoOut probabilityAltCalibrated(Double probabilityAltCalibrated) { + + this.probabilityAltCalibrated = probabilityAltCalibrated; + return this; + } + + /** + * The calibrated probability for country OR countryAlt to have been guessed correctly. -1 = still calibrating. + * minimum: -1 + * maximum: 1 + * @return probabilityAltCalibrated + **/ + @javax.annotation.Nullable + public Double getProbabilityAltCalibrated() { + return probabilityAltCalibrated; + } + + + public void setProbabilityAltCalibrated(Double probabilityAltCalibrated) { + this.probabilityAltCalibrated = probabilityAltCalibrated; + } + + + public FirstLastNameGeoOut religionStats(List religionStats) { + + this.religionStats = religionStats; + return this; + } + + public FirstLastNameGeoOut addReligionStatsItem(ReligionStatOut religionStatsItem) { + if (this.religionStats == null) { + this.religionStats = new ArrayList<>(); + } + this.religionStats.add(religionStatsItem); + return this; + } + + /** + * Geographic religious statistics, assuming country is correctly predicted. + * @return religionStats + **/ + @javax.annotation.Nullable + public List getReligionStats() { + return religionStats; + } + + + public void setReligionStats(List religionStats) { + this.religionStats = religionStats; + } + + + public FirstLastNameGeoOut religionStatsAlt(List religionStatsAlt) { + + this.religionStatsAlt = religionStatsAlt; + return this; + } + + public FirstLastNameGeoOut addReligionStatsAltItem(ReligionStatOut religionStatsAltItem) { + if (this.religionStatsAlt == null) { + this.religionStatsAlt = new ArrayList<>(); + } + this.religionStatsAlt.add(religionStatsAltItem); + return this; + } + + /** + * Geographic religious statistics, for country best alternative. + * @return religionStatsAlt + **/ + @javax.annotation.Nullable + public List getReligionStatsAlt() { + return religionStatsAlt; + } + + + public void setReligionStatsAlt(List religionStatsAlt) { + this.religionStatsAlt = religionStatsAlt; + } + + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FirstLastNameGeoOut firstLastNameGeoOut = (FirstLastNameGeoOut) o; + return Objects.equals(this.script, firstLastNameGeoOut.script) && + Objects.equals(this.id, firstLastNameGeoOut.id) && + Objects.equals(this.explanation, firstLastNameGeoOut.explanation) && + Objects.equals(this.firstName, firstLastNameGeoOut.firstName) && + Objects.equals(this.lastName, firstLastNameGeoOut.lastName) && + Objects.equals(this.score, firstLastNameGeoOut.score) && + Objects.equals(this.country, firstLastNameGeoOut.country) && + Objects.equals(this.countryAlt, firstLastNameGeoOut.countryAlt) && + Objects.equals(this.region, firstLastNameGeoOut.region) && + Objects.equals(this.topRegion, firstLastNameGeoOut.topRegion) && + Objects.equals(this.subRegion, firstLastNameGeoOut.subRegion) && + Objects.equals(this.countriesTop, firstLastNameGeoOut.countriesTop) && + Objects.equals(this.probabilityCalibrated, firstLastNameGeoOut.probabilityCalibrated) && + Objects.equals(this.probabilityAltCalibrated, firstLastNameGeoOut.probabilityAltCalibrated) && + Objects.equals(this.religionStats, firstLastNameGeoOut.religionStats) && + Objects.equals(this.religionStatsAlt, firstLastNameGeoOut.religionStatsAlt); + } + + @Override + public int hashCode() { + return Objects.hash(script, id, explanation, firstName, lastName, score, country, countryAlt, region, topRegion, subRegion, countriesTop, probabilityCalibrated, probabilityAltCalibrated, religionStats, religionStatsAlt); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FirstLastNameGeoOut {\n"); + sb.append(" script: ").append(toIndentedString(script)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" explanation: ").append(toIndentedString(explanation)).append("\n"); + sb.append(" firstName: ").append(toIndentedString(firstName)).append("\n"); + sb.append(" lastName: ").append(toIndentedString(lastName)).append("\n"); + sb.append(" score: ").append(toIndentedString(score)).append("\n"); + sb.append(" country: ").append(toIndentedString(country)).append("\n"); + sb.append(" countryAlt: ").append(toIndentedString(countryAlt)).append("\n"); + sb.append(" region: ").append(toIndentedString(region)).append("\n"); + sb.append(" topRegion: ").append(toIndentedString(topRegion)).append("\n"); + sb.append(" subRegion: ").append(toIndentedString(subRegion)).append("\n"); + sb.append(" countriesTop: ").append(toIndentedString(countriesTop)).append("\n"); + sb.append(" probabilityCalibrated: ").append(toIndentedString(probabilityCalibrated)).append("\n"); + sb.append(" probabilityAltCalibrated: ").append(toIndentedString(probabilityAltCalibrated)).append("\n"); + sb.append(" religionStats: ").append(toIndentedString(religionStats)).append("\n"); + sb.append(" religionStatsAlt: ").append(toIndentedString(religionStatsAlt)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + + public static HashSet openapiFields; + public static HashSet openapiRequiredFields; + + static { + // a set of all properties/fields (JSON key names) + openapiFields = new HashSet(); + openapiFields.add("script"); + openapiFields.add("id"); + openapiFields.add("explanation"); + openapiFields.add("firstName"); + openapiFields.add("lastName"); + openapiFields.add("score"); + openapiFields.add("country"); + openapiFields.add("countryAlt"); + openapiFields.add("region"); + openapiFields.add("topRegion"); + openapiFields.add("subRegion"); + openapiFields.add("countriesTop"); + openapiFields.add("probabilityCalibrated"); + openapiFields.add("probabilityAltCalibrated"); + openapiFields.add("religionStats"); + openapiFields.add("religionStatsAlt"); + + // a set of required properties/fields (JSON key names) + openapiRequiredFields = new HashSet(); + } + + /** + * Validates the JSON Object and throws an exception if issues found + * + * @param jsonObj JSON Object + * @throws IOException if the JSON Object is invalid with respect to FirstLastNameGeoOut + */ + public static void validateJsonObject(JsonObject jsonObj) throws IOException { + if (jsonObj == null) { + if (!FirstLastNameGeoOut.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null + throw new IllegalArgumentException(String.format("The required field(s) %s in FirstLastNameGeoOut is not found in the empty JSON string", FirstLastNameGeoOut.openapiRequiredFields.toString())); + } + } + + Set> entries = jsonObj.entrySet(); + // check to see if the JSON string contains additional fields + for (Entry entry : entries) { + if (!FirstLastNameGeoOut.openapiFields.contains(entry.getKey())) { + throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `FirstLastNameGeoOut` properties. JSON: %s", entry.getKey(), jsonObj.toString())); + } + } + if ((jsonObj.get("script") != null && !jsonObj.get("script").isJsonNull()) && !jsonObj.get("script").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `script` to be a primitive type in the JSON string but got `%s`", jsonObj.get("script").toString())); + } + if ((jsonObj.get("id") != null && !jsonObj.get("id").isJsonNull()) && !jsonObj.get("id").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("id").toString())); + } + if ((jsonObj.get("explanation") != null && !jsonObj.get("explanation").isJsonNull()) && !jsonObj.get("explanation").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `explanation` to be a primitive type in the JSON string but got `%s`", jsonObj.get("explanation").toString())); + } + if ((jsonObj.get("firstName") != null && !jsonObj.get("firstName").isJsonNull()) && !jsonObj.get("firstName").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `firstName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("firstName").toString())); + } + if ((jsonObj.get("lastName") != null && !jsonObj.get("lastName").isJsonNull()) && !jsonObj.get("lastName").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `lastName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("lastName").toString())); + } + if ((jsonObj.get("country") != null && !jsonObj.get("country").isJsonNull()) && !jsonObj.get("country").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `country` to be a primitive type in the JSON string but got `%s`", jsonObj.get("country").toString())); + } + if ((jsonObj.get("countryAlt") != null && !jsonObj.get("countryAlt").isJsonNull()) && !jsonObj.get("countryAlt").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `countryAlt` to be a primitive type in the JSON string but got `%s`", jsonObj.get("countryAlt").toString())); + } + if ((jsonObj.get("region") != null && !jsonObj.get("region").isJsonNull()) && !jsonObj.get("region").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `region` to be a primitive type in the JSON string but got `%s`", jsonObj.get("region").toString())); + } + if ((jsonObj.get("topRegion") != null && !jsonObj.get("topRegion").isJsonNull()) && !jsonObj.get("topRegion").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `topRegion` to be a primitive type in the JSON string but got `%s`", jsonObj.get("topRegion").toString())); + } + if ((jsonObj.get("subRegion") != null && !jsonObj.get("subRegion").isJsonNull()) && !jsonObj.get("subRegion").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `subRegion` to be a primitive type in the JSON string but got `%s`", jsonObj.get("subRegion").toString())); + } + // ensure the optional json data is an array if present + if (jsonObj.get("countriesTop") != null && !jsonObj.get("countriesTop").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `countriesTop` to be an array in the JSON string but got `%s`", jsonObj.get("countriesTop").toString())); + } + if (jsonObj.get("religionStats") != null && !jsonObj.get("religionStats").isJsonNull()) { + JsonArray jsonArrayreligionStats = jsonObj.getAsJsonArray("religionStats"); + if (jsonArrayreligionStats != null) { + // ensure the json data is an array + if (!jsonObj.get("religionStats").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `religionStats` to be an array in the JSON string but got `%s`", jsonObj.get("religionStats").toString())); + } + + // validate the optional field `religionStats` (array) + for (int i = 0; i < jsonArrayreligionStats.size(); i++) { + ReligionStatOut.validateJsonObject(jsonArrayreligionStats.get(i).getAsJsonObject()); + }; + } + } + if (jsonObj.get("religionStatsAlt") != null && !jsonObj.get("religionStatsAlt").isJsonNull()) { + JsonArray jsonArrayreligionStatsAlt = jsonObj.getAsJsonArray("religionStatsAlt"); + if (jsonArrayreligionStatsAlt != null) { + // ensure the json data is an array + if (!jsonObj.get("religionStatsAlt").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `religionStatsAlt` to be an array in the JSON string but got `%s`", jsonObj.get("religionStatsAlt").toString())); + } + + // validate the optional field `religionStatsAlt` (array) + for (int i = 0; i < jsonArrayreligionStatsAlt.size(); i++) { + ReligionStatOut.validateJsonObject(jsonArrayreligionStatsAlt.get(i).getAsJsonObject()); + }; + } + } + } + + public static class CustomTypeAdapterFactory implements TypeAdapterFactory { + @SuppressWarnings("unchecked") + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + if (!FirstLastNameGeoOut.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'FirstLastNameGeoOut' and its subtypes + } + final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(FirstLastNameGeoOut.class)); + + return (TypeAdapter) new TypeAdapter() { + @Override + public void write(JsonWriter out, FirstLastNameGeoOut value) throws IOException { + JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); + elementAdapter.write(out, obj); + } + + @Override + public FirstLastNameGeoOut read(JsonReader in) throws IOException { + JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject(); + validateJsonObject(jsonObj); + return thisAdapter.fromJsonTree(jsonObj); + } + + }.nullSafe(); + } + } + + /** + * Create an instance of FirstLastNameGeoOut given an JSON string + * + * @param jsonString JSON string + * @return An instance of FirstLastNameGeoOut + * @throws IOException if the JSON string is invalid with respect to FirstLastNameGeoOut + */ + public static FirstLastNameGeoOut fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, FirstLastNameGeoOut.class); + } + + /** + * Convert an instance of FirstLastNameGeoOut to an JSON string + * + * @return JSON string + */ + public String toJson() { + return JSON.getGson().toJson(this); + } +} + diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoSubclassificationOut.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoSubclassificationOut.java index ca827921..c7a5cd7f 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoSubclassificationOut.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoSubclassificationOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -52,7 +52,7 @@ /** * Represents the geographic name origin at a country subclassification level (usually regional or state level). */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameGeoSubclassificationOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoSubdivisionIn.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoSubdivisionIn.java index 985ee9eb..c6bfb290 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoSubdivisionIn.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoSubdivisionIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * FirstLastNameGeoSubdivisionIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameGeoSubdivisionIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoZippedIn.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoZippedIn.java index 97fd0da1..1bbfd5d5 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoZippedIn.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameGeoZippedIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * FirstLastNameGeoZippedIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameGeoZippedIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameIn.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameIn.java index 17549f12..82b11a25 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameIn.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * FirstLastNameIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameOriginedOut.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameOriginedOut.java index 79589c87..01304e35 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameOriginedOut.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameOriginedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Represents the output of inferring the LIKELY country of Origin from a personal name. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameOriginedOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) @@ -474,7 +474,7 @@ public FirstLastNameOriginedOut addReligionStatsAltItem(ReligionStatOut religion } /** - * Geographic religious statistics, assuming country of origin OR best alternative is correctly predicted. + * Geographic religious statistics, for origin best alternative. * @return religionStatsAlt **/ @javax.annotation.Nullable diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameOut.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameOut.java index 03a305c5..ffec31cc 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameOut.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * First / last name structure corresponding to the most likely parsing. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNamePhoneCodedOut.java b/src/main/java/com/namsor/sdk2/model/FirstLastNamePhoneCodedOut.java index 2bca1370..4972bbf3 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNamePhoneCodedOut.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNamePhoneCodedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * Represents the output of inferring the LIKELY country and phone code from a personal name and phone number. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNamePhoneCodedOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberGeoIn.java b/src/main/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberGeoIn.java index c8268d02..3842198d 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberGeoIn.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberGeoIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * FirstLastNamePhoneNumberGeoIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNamePhoneNumberGeoIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberIn.java b/src/main/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberIn.java index c471e71d..69e72db9 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberIn.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * FirstLastNamePhoneNumberIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNamePhoneNumberIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameReligionedOut.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameReligionedOut.java index 79de4d48..b7709ffa 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameReligionedOut.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameReligionedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -52,7 +52,7 @@ /** * Represents the output of inferring the LIKELY religion from a personal Indian first/last name. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameReligionedOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameSubdivisionIn.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameSubdivisionIn.java index 183b407a..a4234fc3 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameSubdivisionIn.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameSubdivisionIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * FirstLastNameSubdivisionIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameSubdivisionIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/FirstLastNameUSRaceEthnicityOut.java b/src/main/java/com/namsor/sdk2/model/FirstLastNameUSRaceEthnicityOut.java index 4da56050..3fc54744 100644 --- a/src/main/java/com/namsor/sdk2/model/FirstLastNameUSRaceEthnicityOut.java +++ b/src/main/java/com/namsor/sdk2/model/FirstLastNameUSRaceEthnicityOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -52,7 +52,7 @@ /** * Represents the output of inferring the LIKELY US 'race/ethnicity' from a personal name, given US country of residence and (optionally) a ZIP5 code. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class FirstLastNameUSRaceEthnicityOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) diff --git a/src/main/java/com/namsor/sdk2/model/MatchPersonalFirstLastNameIn.java b/src/main/java/com/namsor/sdk2/model/MatchPersonalFirstLastNameIn.java index 0c834eda..a9d30996 100644 --- a/src/main/java/com/namsor/sdk2/model/MatchPersonalFirstLastNameIn.java +++ b/src/main/java/com/namsor/sdk2/model/MatchPersonalFirstLastNameIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -52,7 +52,7 @@ /** * MatchPersonalFirstLastNameIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class MatchPersonalFirstLastNameIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/NameGeoIn.java b/src/main/java/com/namsor/sdk2/model/NameGeoIn.java index 4b047c97..80b64317 100644 --- a/src/main/java/com/namsor/sdk2/model/NameGeoIn.java +++ b/src/main/java/com/namsor/sdk2/model/NameGeoIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * NameGeoIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class NameGeoIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/NameIn.java b/src/main/java/com/namsor/sdk2/model/NameIn.java index aa5e5d1d..761f0426 100644 --- a/src/main/java/com/namsor/sdk2/model/NameIn.java +++ b/src/main/java/com/namsor/sdk2/model/NameIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * NameIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class NameIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/NameMatchCandidateOut.java b/src/main/java/com/namsor/sdk2/model/NameMatchCandidateOut.java index 0a9ae627..29658f64 100644 --- a/src/main/java/com/namsor/sdk2/model/NameMatchCandidateOut.java +++ b/src/main/java/com/namsor/sdk2/model/NameMatchCandidateOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * The ordered list of name matching candidates */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class NameMatchCandidateOut { public static final String SERIALIZED_NAME_CANDIDATE_NAME = "candidateName"; @SerializedName(SERIALIZED_NAME_CANDIDATE_NAME) diff --git a/src/main/java/com/namsor/sdk2/model/NameMatchCandidatesOut.java b/src/main/java/com/namsor/sdk2/model/NameMatchCandidatesOut.java index 2e5f0009..061fd21c 100644 --- a/src/main/java/com/namsor/sdk2/model/NameMatchCandidatesOut.java +++ b/src/main/java/com/namsor/sdk2/model/NameMatchCandidatesOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * Classified matched names */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class NameMatchCandidatesOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) diff --git a/src/main/java/com/namsor/sdk2/model/NameMatchedOut.java b/src/main/java/com/namsor/sdk2/model/NameMatchedOut.java index 1b8de1a8..d509710b 100644 --- a/src/main/java/com/namsor/sdk2/model/NameMatchedOut.java +++ b/src/main/java/com/namsor/sdk2/model/NameMatchedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * Classified matched names */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class NameMatchedOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) diff --git a/src/main/java/com/namsor/sdk2/model/PersonalNameCastegroupOut.java b/src/main/java/com/namsor/sdk2/model/PersonalNameCastegroupOut.java index 9e8d458e..9f84c12d 100644 --- a/src/main/java/com/namsor/sdk2/model/PersonalNameCastegroupOut.java +++ b/src/main/java/com/namsor/sdk2/model/PersonalNameCastegroupOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -52,7 +52,7 @@ /** * Caste group-coded names */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class PersonalNameCastegroupOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) diff --git a/src/main/java/com/namsor/sdk2/model/PersonalNameDiasporaedOut.java b/src/main/java/com/namsor/sdk2/model/PersonalNameDiasporaedOut.java new file mode 100644 index 00000000..99e2e740 --- /dev/null +++ b/src/main/java/com/namsor/sdk2/model/PersonalNameDiasporaedOut.java @@ -0,0 +1,655 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.ReligionStatOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonDeserializationContext; +import com.google.gson.JsonDeserializer; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.reflect.TypeToken; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +import java.lang.reflect.Type; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import com.namsor.sdk2.invoke.JSON; + +/** + * Represents the output of inferring the LIKELY ethnicity from a personal name, given an country of residence. + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") +public class PersonalNameDiasporaedOut { + public static final String SERIALIZED_NAME_SCRIPT = "script"; + @SerializedName(SERIALIZED_NAME_SCRIPT) + private String script; + + public static final String SERIALIZED_NAME_ID = "id"; + @SerializedName(SERIALIZED_NAME_ID) + private String id; + + public static final String SERIALIZED_NAME_EXPLANATION = "explanation"; + @SerializedName(SERIALIZED_NAME_EXPLANATION) + private String explanation; + + public static final String SERIALIZED_NAME_NAME = "name"; + @SerializedName(SERIALIZED_NAME_NAME) + private String name; + + public static final String SERIALIZED_NAME_SCORE = "score"; + @SerializedName(SERIALIZED_NAME_SCORE) + private Double score; + + public static final String SERIALIZED_NAME_ETHNICITY_ALT = "ethnicityAlt"; + @SerializedName(SERIALIZED_NAME_ETHNICITY_ALT) + private String ethnicityAlt; + + public static final String SERIALIZED_NAME_ETHNICITY = "ethnicity"; + @SerializedName(SERIALIZED_NAME_ETHNICITY) + private String ethnicity; + + public static final String SERIALIZED_NAME_LIFTED = "lifted"; + @SerializedName(SERIALIZED_NAME_LIFTED) + private Boolean lifted; + + public static final String SERIALIZED_NAME_COUNTRY_ISO2 = "countryIso2"; + @SerializedName(SERIALIZED_NAME_COUNTRY_ISO2) + private String countryIso2; + + public static final String SERIALIZED_NAME_ETHNICITIES_TOP = "ethnicitiesTop"; + @SerializedName(SERIALIZED_NAME_ETHNICITIES_TOP) + private List ethnicitiesTop; + + public static final String SERIALIZED_NAME_PROBABILITY_CALIBRATED = "probabilityCalibrated"; + @SerializedName(SERIALIZED_NAME_PROBABILITY_CALIBRATED) + private Double probabilityCalibrated; + + public static final String SERIALIZED_NAME_PROBABILITY_ALT_CALIBRATED = "probabilityAltCalibrated"; + @SerializedName(SERIALIZED_NAME_PROBABILITY_ALT_CALIBRATED) + private Double probabilityAltCalibrated; + + public static final String SERIALIZED_NAME_RELIGION_STATS = "religionStats"; + @SerializedName(SERIALIZED_NAME_RELIGION_STATS) + private List religionStats; + + public static final String SERIALIZED_NAME_RELIGION_STATS_ALT = "religionStatsAlt"; + @SerializedName(SERIALIZED_NAME_RELIGION_STATS_ALT) + private List religionStatsAlt; + + public PersonalNameDiasporaedOut() { + } + + public PersonalNameDiasporaedOut script(String script) { + + this.script = script; + return this; + } + + /** + * Get script + * @return script + **/ + @javax.annotation.Nullable + public String getScript() { + return script; + } + + + public void setScript(String script) { + this.script = script; + } + + + public PersonalNameDiasporaedOut id(String id) { + + this.id = id; + return this; + } + + /** + * Get id + * @return id + **/ + @javax.annotation.Nullable + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public PersonalNameDiasporaedOut explanation(String explanation) { + + this.explanation = explanation; + return this; + } + + /** + * Get explanation + * @return explanation + **/ + @javax.annotation.Nullable + public String getExplanation() { + return explanation; + } + + + public void setExplanation(String explanation) { + this.explanation = explanation; + } + + + public PersonalNameDiasporaedOut name(String name) { + + this.name = name; + return this; + } + + /** + * The input name. + * @return name + **/ + @javax.annotation.Nullable + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public PersonalNameDiasporaedOut score(Double score) { + + this.score = score; + return this; + } + + /** + * Compatibility to NamSor_v1 Diaspora score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. + * minimum: 0 + * maximum: 100 + * @return score + **/ + @javax.annotation.Nullable + public Double getScore() { + return score; + } + + + public void setScore(Double score) { + this.score = score; + } + + + public PersonalNameDiasporaedOut ethnicityAlt(String ethnicityAlt) { + + this.ethnicityAlt = ethnicityAlt; + return this; + } + + /** + * The second best alternative ethnicity + * @return ethnicityAlt + **/ + @javax.annotation.Nullable + public String getEthnicityAlt() { + return ethnicityAlt; + } + + + public void setEthnicityAlt(String ethnicityAlt) { + this.ethnicityAlt = ethnicityAlt; + } + + + public PersonalNameDiasporaedOut ethnicity(String ethnicity) { + + this.ethnicity = ethnicity; + return this; + } + + /** + * The most likely ethnicity + * @return ethnicity + **/ + @javax.annotation.Nullable + public String getEthnicity() { + return ethnicity; + } + + + public void setEthnicity(String ethnicity) { + this.ethnicity = ethnicity; + } + + + public PersonalNameDiasporaedOut lifted(Boolean lifted) { + + this.lifted = lifted; + return this; + } + + /** + * 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. + * @return lifted + **/ + @javax.annotation.Nullable + public Boolean getLifted() { + return lifted; + } + + + public void setLifted(Boolean lifted) { + this.lifted = lifted; + } + + + public PersonalNameDiasporaedOut countryIso2(String countryIso2) { + + this.countryIso2 = countryIso2; + return this; + } + + /** + * From input data, the countryIso2 of geographic context (US,CA etc.) + * @return countryIso2 + **/ + @javax.annotation.Nullable + public String getCountryIso2() { + return countryIso2; + } + + + public void setCountryIso2(String countryIso2) { + this.countryIso2 = countryIso2; + } + + + public PersonalNameDiasporaedOut ethnicitiesTop(List ethnicitiesTop) { + + this.ethnicitiesTop = ethnicitiesTop; + return this; + } + + public PersonalNameDiasporaedOut addEthnicitiesTopItem(String ethnicitiesTopItem) { + if (this.ethnicitiesTop == null) { + this.ethnicitiesTop = new ArrayList<>(); + } + this.ethnicitiesTop.add(ethnicitiesTopItem); + return this; + } + + /** + * List most likely ethnicities (top 10) + * @return ethnicitiesTop + **/ + @javax.annotation.Nullable + public List getEthnicitiesTop() { + return ethnicitiesTop; + } + + + public void setEthnicitiesTop(List ethnicitiesTop) { + this.ethnicitiesTop = ethnicitiesTop; + } + + + public PersonalNameDiasporaedOut probabilityCalibrated(Double probabilityCalibrated) { + + this.probabilityCalibrated = probabilityCalibrated; + return this; + } + + /** + * The calibrated probability for ethnicity to have been guessed correctly. -1 = still calibrating. + * minimum: -1 + * maximum: 1 + * @return probabilityCalibrated + **/ + @javax.annotation.Nullable + public Double getProbabilityCalibrated() { + return probabilityCalibrated; + } + + + public void setProbabilityCalibrated(Double probabilityCalibrated) { + this.probabilityCalibrated = probabilityCalibrated; + } + + + public PersonalNameDiasporaedOut probabilityAltCalibrated(Double probabilityAltCalibrated) { + + this.probabilityAltCalibrated = probabilityAltCalibrated; + return this; + } + + /** + * The calibrated probability for ethnicity OR ethnicityAlt to have been guessed correctly. -1 = still calibrating. + * minimum: -1 + * maximum: 1 + * @return probabilityAltCalibrated + **/ + @javax.annotation.Nullable + public Double getProbabilityAltCalibrated() { + return probabilityAltCalibrated; + } + + + public void setProbabilityAltCalibrated(Double probabilityAltCalibrated) { + this.probabilityAltCalibrated = probabilityAltCalibrated; + } + + + public PersonalNameDiasporaedOut religionStats(List religionStats) { + + this.religionStats = religionStats; + return this; + } + + public PersonalNameDiasporaedOut addReligionStatsItem(ReligionStatOut religionStatsItem) { + if (this.religionStats == null) { + this.religionStats = new ArrayList<>(); + } + this.religionStats.add(religionStatsItem); + return this; + } + + /** + * Geographic religious statistics, assuming ethnicity is correctly predicted. + * @return religionStats + **/ + @javax.annotation.Nullable + public List getReligionStats() { + return religionStats; + } + + + public void setReligionStats(List religionStats) { + this.religionStats = religionStats; + } + + + public PersonalNameDiasporaedOut religionStatsAlt(List religionStatsAlt) { + + this.religionStatsAlt = religionStatsAlt; + return this; + } + + public PersonalNameDiasporaedOut addReligionStatsAltItem(ReligionStatOut religionStatsAltItem) { + if (this.religionStatsAlt == null) { + this.religionStatsAlt = new ArrayList<>(); + } + this.religionStatsAlt.add(religionStatsAltItem); + return this; + } + + /** + * Geographic religious statistics, for country best alternative. + * @return religionStatsAlt + **/ + @javax.annotation.Nullable + public List getReligionStatsAlt() { + return religionStatsAlt; + } + + + public void setReligionStatsAlt(List religionStatsAlt) { + this.religionStatsAlt = religionStatsAlt; + } + + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PersonalNameDiasporaedOut personalNameDiasporaedOut = (PersonalNameDiasporaedOut) o; + return Objects.equals(this.script, personalNameDiasporaedOut.script) && + Objects.equals(this.id, personalNameDiasporaedOut.id) && + Objects.equals(this.explanation, personalNameDiasporaedOut.explanation) && + Objects.equals(this.name, personalNameDiasporaedOut.name) && + Objects.equals(this.score, personalNameDiasporaedOut.score) && + Objects.equals(this.ethnicityAlt, personalNameDiasporaedOut.ethnicityAlt) && + Objects.equals(this.ethnicity, personalNameDiasporaedOut.ethnicity) && + Objects.equals(this.lifted, personalNameDiasporaedOut.lifted) && + Objects.equals(this.countryIso2, personalNameDiasporaedOut.countryIso2) && + Objects.equals(this.ethnicitiesTop, personalNameDiasporaedOut.ethnicitiesTop) && + Objects.equals(this.probabilityCalibrated, personalNameDiasporaedOut.probabilityCalibrated) && + Objects.equals(this.probabilityAltCalibrated, personalNameDiasporaedOut.probabilityAltCalibrated) && + Objects.equals(this.religionStats, personalNameDiasporaedOut.religionStats) && + Objects.equals(this.religionStatsAlt, personalNameDiasporaedOut.religionStatsAlt); + } + + @Override + public int hashCode() { + return Objects.hash(script, id, explanation, name, score, ethnicityAlt, ethnicity, lifted, countryIso2, ethnicitiesTop, probabilityCalibrated, probabilityAltCalibrated, religionStats, religionStatsAlt); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PersonalNameDiasporaedOut {\n"); + sb.append(" script: ").append(toIndentedString(script)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" explanation: ").append(toIndentedString(explanation)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" score: ").append(toIndentedString(score)).append("\n"); + sb.append(" ethnicityAlt: ").append(toIndentedString(ethnicityAlt)).append("\n"); + sb.append(" ethnicity: ").append(toIndentedString(ethnicity)).append("\n"); + sb.append(" lifted: ").append(toIndentedString(lifted)).append("\n"); + sb.append(" countryIso2: ").append(toIndentedString(countryIso2)).append("\n"); + sb.append(" ethnicitiesTop: ").append(toIndentedString(ethnicitiesTop)).append("\n"); + sb.append(" probabilityCalibrated: ").append(toIndentedString(probabilityCalibrated)).append("\n"); + sb.append(" probabilityAltCalibrated: ").append(toIndentedString(probabilityAltCalibrated)).append("\n"); + sb.append(" religionStats: ").append(toIndentedString(religionStats)).append("\n"); + sb.append(" religionStatsAlt: ").append(toIndentedString(religionStatsAlt)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + + public static HashSet openapiFields; + public static HashSet openapiRequiredFields; + + static { + // a set of all properties/fields (JSON key names) + openapiFields = new HashSet(); + openapiFields.add("script"); + openapiFields.add("id"); + openapiFields.add("explanation"); + openapiFields.add("name"); + openapiFields.add("score"); + openapiFields.add("ethnicityAlt"); + openapiFields.add("ethnicity"); + openapiFields.add("lifted"); + openapiFields.add("countryIso2"); + openapiFields.add("ethnicitiesTop"); + openapiFields.add("probabilityCalibrated"); + openapiFields.add("probabilityAltCalibrated"); + openapiFields.add("religionStats"); + openapiFields.add("religionStatsAlt"); + + // a set of required properties/fields (JSON key names) + openapiRequiredFields = new HashSet(); + } + + /** + * Validates the JSON Object and throws an exception if issues found + * + * @param jsonObj JSON Object + * @throws IOException if the JSON Object is invalid with respect to PersonalNameDiasporaedOut + */ + public static void validateJsonObject(JsonObject jsonObj) throws IOException { + if (jsonObj == null) { + if (!PersonalNameDiasporaedOut.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null + throw new IllegalArgumentException(String.format("The required field(s) %s in PersonalNameDiasporaedOut is not found in the empty JSON string", PersonalNameDiasporaedOut.openapiRequiredFields.toString())); + } + } + + Set> entries = jsonObj.entrySet(); + // check to see if the JSON string contains additional fields + for (Entry entry : entries) { + if (!PersonalNameDiasporaedOut.openapiFields.contains(entry.getKey())) { + throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `PersonalNameDiasporaedOut` properties. JSON: %s", entry.getKey(), jsonObj.toString())); + } + } + if ((jsonObj.get("script") != null && !jsonObj.get("script").isJsonNull()) && !jsonObj.get("script").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `script` to be a primitive type in the JSON string but got `%s`", jsonObj.get("script").toString())); + } + if ((jsonObj.get("id") != null && !jsonObj.get("id").isJsonNull()) && !jsonObj.get("id").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("id").toString())); + } + if ((jsonObj.get("explanation") != null && !jsonObj.get("explanation").isJsonNull()) && !jsonObj.get("explanation").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `explanation` to be a primitive type in the JSON string but got `%s`", jsonObj.get("explanation").toString())); + } + if ((jsonObj.get("name") != null && !jsonObj.get("name").isJsonNull()) && !jsonObj.get("name").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `name` to be a primitive type in the JSON string but got `%s`", jsonObj.get("name").toString())); + } + if ((jsonObj.get("ethnicityAlt") != null && !jsonObj.get("ethnicityAlt").isJsonNull()) && !jsonObj.get("ethnicityAlt").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `ethnicityAlt` to be a primitive type in the JSON string but got `%s`", jsonObj.get("ethnicityAlt").toString())); + } + if ((jsonObj.get("ethnicity") != null && !jsonObj.get("ethnicity").isJsonNull()) && !jsonObj.get("ethnicity").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `ethnicity` to be a primitive type in the JSON string but got `%s`", jsonObj.get("ethnicity").toString())); + } + if ((jsonObj.get("countryIso2") != null && !jsonObj.get("countryIso2").isJsonNull()) && !jsonObj.get("countryIso2").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `countryIso2` to be a primitive type in the JSON string but got `%s`", jsonObj.get("countryIso2").toString())); + } + // ensure the optional json data is an array if present + if (jsonObj.get("ethnicitiesTop") != null && !jsonObj.get("ethnicitiesTop").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `ethnicitiesTop` to be an array in the JSON string but got `%s`", jsonObj.get("ethnicitiesTop").toString())); + } + if (jsonObj.get("religionStats") != null && !jsonObj.get("religionStats").isJsonNull()) { + JsonArray jsonArrayreligionStats = jsonObj.getAsJsonArray("religionStats"); + if (jsonArrayreligionStats != null) { + // ensure the json data is an array + if (!jsonObj.get("religionStats").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `religionStats` to be an array in the JSON string but got `%s`", jsonObj.get("religionStats").toString())); + } + + // validate the optional field `religionStats` (array) + for (int i = 0; i < jsonArrayreligionStats.size(); i++) { + ReligionStatOut.validateJsonObject(jsonArrayreligionStats.get(i).getAsJsonObject()); + }; + } + } + if (jsonObj.get("religionStatsAlt") != null && !jsonObj.get("religionStatsAlt").isJsonNull()) { + JsonArray jsonArrayreligionStatsAlt = jsonObj.getAsJsonArray("religionStatsAlt"); + if (jsonArrayreligionStatsAlt != null) { + // ensure the json data is an array + if (!jsonObj.get("religionStatsAlt").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `religionStatsAlt` to be an array in the JSON string but got `%s`", jsonObj.get("religionStatsAlt").toString())); + } + + // validate the optional field `religionStatsAlt` (array) + for (int i = 0; i < jsonArrayreligionStatsAlt.size(); i++) { + ReligionStatOut.validateJsonObject(jsonArrayreligionStatsAlt.get(i).getAsJsonObject()); + }; + } + } + } + + public static class CustomTypeAdapterFactory implements TypeAdapterFactory { + @SuppressWarnings("unchecked") + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + if (!PersonalNameDiasporaedOut.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'PersonalNameDiasporaedOut' and its subtypes + } + final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(PersonalNameDiasporaedOut.class)); + + return (TypeAdapter) new TypeAdapter() { + @Override + public void write(JsonWriter out, PersonalNameDiasporaedOut value) throws IOException { + JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); + elementAdapter.write(out, obj); + } + + @Override + public PersonalNameDiasporaedOut read(JsonReader in) throws IOException { + JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject(); + validateJsonObject(jsonObj); + return thisAdapter.fromJsonTree(jsonObj); + } + + }.nullSafe(); + } + } + + /** + * Create an instance of PersonalNameDiasporaedOut given an JSON string + * + * @param jsonString JSON string + * @return An instance of PersonalNameDiasporaedOut + * @throws IOException if the JSON string is invalid with respect to PersonalNameDiasporaedOut + */ + public static PersonalNameDiasporaedOut fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, PersonalNameDiasporaedOut.class); + } + + /** + * Convert an instance of PersonalNameDiasporaedOut to an JSON string + * + * @return JSON string + */ + public String toJson() { + return JSON.getGson().toJson(this); + } +} + diff --git a/src/main/java/com/namsor/sdk2/model/PersonalNameGenderedOut.java b/src/main/java/com/namsor/sdk2/model/PersonalNameGenderedOut.java index fd8e3708..a1ce209e 100644 --- a/src/main/java/com/namsor/sdk2/model/PersonalNameGenderedOut.java +++ b/src/main/java/com/namsor/sdk2/model/PersonalNameGenderedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * Classified genderized names */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class PersonalNameGenderedOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) @@ -206,7 +206,7 @@ public PersonalNameGenderedOut name(String name) { } /** - * The input name + * The input name. * @return name **/ @javax.annotation.Nullable diff --git a/src/main/java/com/namsor/sdk2/model/PersonalNameGeoIn.java b/src/main/java/com/namsor/sdk2/model/PersonalNameGeoIn.java index 80274b71..034e210f 100644 --- a/src/main/java/com/namsor/sdk2/model/PersonalNameGeoIn.java +++ b/src/main/java/com/namsor/sdk2/model/PersonalNameGeoIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * PersonalNameGeoIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class PersonalNameGeoIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/PersonalNameGeoOut.java b/src/main/java/com/namsor/sdk2/model/PersonalNameGeoOut.java index e6cb062e..ff510089 100644 --- a/src/main/java/com/namsor/sdk2/model/PersonalNameGeoOut.java +++ b/src/main/java/com/namsor/sdk2/model/PersonalNameGeoOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -51,9 +51,9 @@ import com.namsor.sdk2.invoke.JSON; /** - * Classified geo names + * PersonalNameGeoOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class PersonalNameGeoOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) @@ -449,7 +449,7 @@ public PersonalNameGeoOut addReligionStatsAltItem(ReligionStatOut religionStatsA } /** - * Geographic religious statistics, assuming country OR best alternative is correctly predicted. + * Geographic religious statistics, for country best alternative. * @return religionStatsAlt **/ @javax.annotation.Nullable diff --git a/src/main/java/com/namsor/sdk2/model/PersonalNameGeoSubclassificationOut.java b/src/main/java/com/namsor/sdk2/model/PersonalNameGeoSubclassificationOut.java index 86d86ae2..61d9b99a 100644 --- a/src/main/java/com/namsor/sdk2/model/PersonalNameGeoSubclassificationOut.java +++ b/src/main/java/com/namsor/sdk2/model/PersonalNameGeoSubclassificationOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -52,7 +52,7 @@ /** * Classified names at sub country level (region or state) */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class PersonalNameGeoSubclassificationOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) @@ -171,7 +171,7 @@ public PersonalNameGeoSubclassificationOut name(String name) { } /** - * The input name + * The input name. * @return name **/ @javax.annotation.Nullable diff --git a/src/main/java/com/namsor/sdk2/model/PersonalNameGeoSubdivisionIn.java b/src/main/java/com/namsor/sdk2/model/PersonalNameGeoSubdivisionIn.java index 977d3050..21eed7dd 100644 --- a/src/main/java/com/namsor/sdk2/model/PersonalNameGeoSubdivisionIn.java +++ b/src/main/java/com/namsor/sdk2/model/PersonalNameGeoSubdivisionIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * PersonalNameGeoSubdivisionIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class PersonalNameGeoSubdivisionIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/PersonalNameIn.java b/src/main/java/com/namsor/sdk2/model/PersonalNameIn.java index 2f6c2ede..27a3158e 100644 --- a/src/main/java/com/namsor/sdk2/model/PersonalNameIn.java +++ b/src/main/java/com/namsor/sdk2/model/PersonalNameIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * PersonalNameIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class PersonalNameIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/PersonalNameOriginedOut.java b/src/main/java/com/namsor/sdk2/model/PersonalNameOriginedOut.java new file mode 100644 index 00000000..de089bff --- /dev/null +++ b/src/main/java/com/namsor/sdk2/model/PersonalNameOriginedOut.java @@ -0,0 +1,739 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.ReligionStatOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonDeserializationContext; +import com.google.gson.JsonDeserializer; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.reflect.TypeToken; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +import java.lang.reflect.Type; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import com.namsor.sdk2.invoke.JSON; + +/** + * Represents the output of inferring the LIKELY country of Origin from a personal name. + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") +public class PersonalNameOriginedOut { + public static final String SERIALIZED_NAME_SCRIPT = "script"; + @SerializedName(SERIALIZED_NAME_SCRIPT) + private String script; + + public static final String SERIALIZED_NAME_ID = "id"; + @SerializedName(SERIALIZED_NAME_ID) + private String id; + + public static final String SERIALIZED_NAME_EXPLANATION = "explanation"; + @SerializedName(SERIALIZED_NAME_EXPLANATION) + private String explanation; + + public static final String SERIALIZED_NAME_NAME = "name"; + @SerializedName(SERIALIZED_NAME_NAME) + private String name; + + public static final String SERIALIZED_NAME_COUNTRY_ORIGIN = "countryOrigin"; + @SerializedName(SERIALIZED_NAME_COUNTRY_ORIGIN) + private String countryOrigin; + + public static final String SERIALIZED_NAME_COUNTRY_ORIGIN_ALT = "countryOriginAlt"; + @SerializedName(SERIALIZED_NAME_COUNTRY_ORIGIN_ALT) + private String countryOriginAlt; + + public static final String SERIALIZED_NAME_COUNTRIES_ORIGIN_TOP = "countriesOriginTop"; + @SerializedName(SERIALIZED_NAME_COUNTRIES_ORIGIN_TOP) + private List countriesOriginTop; + + public static final String SERIALIZED_NAME_SCORE = "score"; + @SerializedName(SERIALIZED_NAME_SCORE) + private Double score; + + public static final String SERIALIZED_NAME_REGION_ORIGIN = "regionOrigin"; + @SerializedName(SERIALIZED_NAME_REGION_ORIGIN) + private String regionOrigin; + + public static final String SERIALIZED_NAME_TOP_REGION_ORIGIN = "topRegionOrigin"; + @SerializedName(SERIALIZED_NAME_TOP_REGION_ORIGIN) + private String topRegionOrigin; + + public static final String SERIALIZED_NAME_SUB_REGION_ORIGIN = "subRegionOrigin"; + @SerializedName(SERIALIZED_NAME_SUB_REGION_ORIGIN) + private String subRegionOrigin; + + public static final String SERIALIZED_NAME_PROBABILITY_CALIBRATED = "probabilityCalibrated"; + @SerializedName(SERIALIZED_NAME_PROBABILITY_CALIBRATED) + private Double probabilityCalibrated; + + public static final String SERIALIZED_NAME_PROBABILITY_ALT_CALIBRATED = "probabilityAltCalibrated"; + @SerializedName(SERIALIZED_NAME_PROBABILITY_ALT_CALIBRATED) + private Double probabilityAltCalibrated; + + public static final String SERIALIZED_NAME_RELIGION_STATS = "religionStats"; + @SerializedName(SERIALIZED_NAME_RELIGION_STATS) + private List religionStats; + + public static final String SERIALIZED_NAME_RELIGION_STATS_ALT = "religionStatsAlt"; + @SerializedName(SERIALIZED_NAME_RELIGION_STATS_ALT) + private List religionStatsAlt; + + public static final String SERIALIZED_NAME_RELIGION_STATS_SYNTHETIC = "religionStatsSynthetic"; + @SerializedName(SERIALIZED_NAME_RELIGION_STATS_SYNTHETIC) + private List religionStatsSynthetic; + + public PersonalNameOriginedOut() { + } + + public PersonalNameOriginedOut script(String script) { + + this.script = script; + return this; + } + + /** + * Get script + * @return script + **/ + @javax.annotation.Nullable + public String getScript() { + return script; + } + + + public void setScript(String script) { + this.script = script; + } + + + public PersonalNameOriginedOut id(String id) { + + this.id = id; + return this; + } + + /** + * Get id + * @return id + **/ + @javax.annotation.Nullable + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public PersonalNameOriginedOut explanation(String explanation) { + + this.explanation = explanation; + return this; + } + + /** + * Get explanation + * @return explanation + **/ + @javax.annotation.Nullable + public String getExplanation() { + return explanation; + } + + + public void setExplanation(String explanation) { + this.explanation = explanation; + } + + + public PersonalNameOriginedOut name(String name) { + + this.name = name; + return this; + } + + /** + * The input name. + * @return name + **/ + @javax.annotation.Nullable + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public PersonalNameOriginedOut countryOrigin(String countryOrigin) { + + this.countryOrigin = countryOrigin; + return this; + } + + /** + * Most likely country of Origin + * @return countryOrigin + **/ + @javax.annotation.Nullable + public String getCountryOrigin() { + return countryOrigin; + } + + + public void setCountryOrigin(String countryOrigin) { + this.countryOrigin = countryOrigin; + } + + + public PersonalNameOriginedOut countryOriginAlt(String countryOriginAlt) { + + this.countryOriginAlt = countryOriginAlt; + return this; + } + + /** + * Second best alternative : country of Origin + * @return countryOriginAlt + **/ + @javax.annotation.Nullable + public String getCountryOriginAlt() { + return countryOriginAlt; + } + + + public void setCountryOriginAlt(String countryOriginAlt) { + this.countryOriginAlt = countryOriginAlt; + } + + + public PersonalNameOriginedOut countriesOriginTop(List countriesOriginTop) { + + this.countriesOriginTop = countriesOriginTop; + return this; + } + + public PersonalNameOriginedOut addCountriesOriginTopItem(String countriesOriginTopItem) { + if (this.countriesOriginTop == null) { + this.countriesOriginTop = new ArrayList<>(); + } + this.countriesOriginTop.add(countriesOriginTopItem); + return this; + } + + /** + * List countries of Origin (top 10) + * @return countriesOriginTop + **/ + @javax.annotation.Nullable + public List getCountriesOriginTop() { + return countriesOriginTop; + } + + + public void setCountriesOriginTop(List countriesOriginTop) { + this.countriesOriginTop = countriesOriginTop; + } + + + public PersonalNameOriginedOut score(Double score) { + + this.score = score; + return this; + } + + /** + * Compatibility to NamSor_v1 Origin score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. + * minimum: 0 + * maximum: 100 + * @return score + **/ + @javax.annotation.Nullable + public Double getScore() { + return score; + } + + + public void setScore(Double score) { + this.score = score; + } + + + public PersonalNameOriginedOut regionOrigin(String regionOrigin) { + + this.regionOrigin = regionOrigin; + return this; + } + + /** + * Most likely region of Origin (based on countryOrigin ISO2 code) + * @return regionOrigin + **/ + @javax.annotation.Nullable + public String getRegionOrigin() { + return regionOrigin; + } + + + public void setRegionOrigin(String regionOrigin) { + this.regionOrigin = regionOrigin; + } + + + public PersonalNameOriginedOut topRegionOrigin(String topRegionOrigin) { + + this.topRegionOrigin = topRegionOrigin; + return this; + } + + /** + * Most likely top region of Origin (based on countryOrigin ISO2 code) + * @return topRegionOrigin + **/ + @javax.annotation.Nullable + public String getTopRegionOrigin() { + return topRegionOrigin; + } + + + public void setTopRegionOrigin(String topRegionOrigin) { + this.topRegionOrigin = topRegionOrigin; + } + + + public PersonalNameOriginedOut subRegionOrigin(String subRegionOrigin) { + + this.subRegionOrigin = subRegionOrigin; + return this; + } + + /** + * Most likely sub region of Origin (based on countryOrigin ISO2 code) + * @return subRegionOrigin + **/ + @javax.annotation.Nullable + public String getSubRegionOrigin() { + return subRegionOrigin; + } + + + public void setSubRegionOrigin(String subRegionOrigin) { + this.subRegionOrigin = subRegionOrigin; + } + + + public PersonalNameOriginedOut probabilityCalibrated(Double probabilityCalibrated) { + + this.probabilityCalibrated = probabilityCalibrated; + return this; + } + + /** + * The calibrated probability for countryOrigin to have been guessed correctly. -1 = still calibrating. + * minimum: -1 + * maximum: 1 + * @return probabilityCalibrated + **/ + @javax.annotation.Nullable + public Double getProbabilityCalibrated() { + return probabilityCalibrated; + } + + + public void setProbabilityCalibrated(Double probabilityCalibrated) { + this.probabilityCalibrated = probabilityCalibrated; + } + + + public PersonalNameOriginedOut probabilityAltCalibrated(Double probabilityAltCalibrated) { + + this.probabilityAltCalibrated = probabilityAltCalibrated; + return this; + } + + /** + * The calibrated probability for countryOrigin OR countryOriginAlt to have been guessed correctly. -1 = still calibrating. + * minimum: -1 + * maximum: 1 + * @return probabilityAltCalibrated + **/ + @javax.annotation.Nullable + public Double getProbabilityAltCalibrated() { + return probabilityAltCalibrated; + } + + + public void setProbabilityAltCalibrated(Double probabilityAltCalibrated) { + this.probabilityAltCalibrated = probabilityAltCalibrated; + } + + + public PersonalNameOriginedOut religionStats(List religionStats) { + + this.religionStats = religionStats; + return this; + } + + public PersonalNameOriginedOut addReligionStatsItem(ReligionStatOut religionStatsItem) { + if (this.religionStats == null) { + this.religionStats = new ArrayList<>(); + } + this.religionStats.add(religionStatsItem); + return this; + } + + /** + * Geographic religious statistics, assuming country of origin is correctly predicted. + * @return religionStats + **/ + @javax.annotation.Nullable + public List getReligionStats() { + return religionStats; + } + + + public void setReligionStats(List religionStats) { + this.religionStats = religionStats; + } + + + public PersonalNameOriginedOut religionStatsAlt(List religionStatsAlt) { + + this.religionStatsAlt = religionStatsAlt; + return this; + } + + public PersonalNameOriginedOut addReligionStatsAltItem(ReligionStatOut religionStatsAltItem) { + if (this.religionStatsAlt == null) { + this.religionStatsAlt = new ArrayList<>(); + } + this.religionStatsAlt.add(religionStatsAltItem); + return this; + } + + /** + * Geographic religious statistics, for country best alternative. + * @return religionStatsAlt + **/ + @javax.annotation.Nullable + public List getReligionStatsAlt() { + return religionStatsAlt; + } + + + public void setReligionStatsAlt(List religionStatsAlt) { + this.religionStatsAlt = religionStatsAlt; + } + + + public PersonalNameOriginedOut religionStatsSynthetic(List religionStatsSynthetic) { + + this.religionStatsSynthetic = religionStatsSynthetic; + return this; + } + + public PersonalNameOriginedOut addReligionStatsSyntheticItem(ReligionStatOut religionStatsSyntheticItem) { + if (this.religionStatsSynthetic == null) { + this.religionStatsSynthetic = new ArrayList<>(); + } + this.religionStatsSynthetic.add(religionStatsSyntheticItem); + return this; + } + + /** + * Geographic religious statistics, assuming country of origin OR best alternative is correctly predicted. + * @return religionStatsSynthetic + **/ + @javax.annotation.Nullable + public List getReligionStatsSynthetic() { + return religionStatsSynthetic; + } + + + public void setReligionStatsSynthetic(List religionStatsSynthetic) { + this.religionStatsSynthetic = religionStatsSynthetic; + } + + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PersonalNameOriginedOut personalNameOriginedOut = (PersonalNameOriginedOut) o; + return Objects.equals(this.script, personalNameOriginedOut.script) && + Objects.equals(this.id, personalNameOriginedOut.id) && + Objects.equals(this.explanation, personalNameOriginedOut.explanation) && + Objects.equals(this.name, personalNameOriginedOut.name) && + Objects.equals(this.countryOrigin, personalNameOriginedOut.countryOrigin) && + Objects.equals(this.countryOriginAlt, personalNameOriginedOut.countryOriginAlt) && + Objects.equals(this.countriesOriginTop, personalNameOriginedOut.countriesOriginTop) && + Objects.equals(this.score, personalNameOriginedOut.score) && + Objects.equals(this.regionOrigin, personalNameOriginedOut.regionOrigin) && + Objects.equals(this.topRegionOrigin, personalNameOriginedOut.topRegionOrigin) && + Objects.equals(this.subRegionOrigin, personalNameOriginedOut.subRegionOrigin) && + Objects.equals(this.probabilityCalibrated, personalNameOriginedOut.probabilityCalibrated) && + Objects.equals(this.probabilityAltCalibrated, personalNameOriginedOut.probabilityAltCalibrated) && + Objects.equals(this.religionStats, personalNameOriginedOut.religionStats) && + Objects.equals(this.religionStatsAlt, personalNameOriginedOut.religionStatsAlt) && + Objects.equals(this.religionStatsSynthetic, personalNameOriginedOut.religionStatsSynthetic); + } + + @Override + public int hashCode() { + return Objects.hash(script, id, explanation, name, countryOrigin, countryOriginAlt, countriesOriginTop, score, regionOrigin, topRegionOrigin, subRegionOrigin, probabilityCalibrated, probabilityAltCalibrated, religionStats, religionStatsAlt, religionStatsSynthetic); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PersonalNameOriginedOut {\n"); + sb.append(" script: ").append(toIndentedString(script)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" explanation: ").append(toIndentedString(explanation)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" countryOrigin: ").append(toIndentedString(countryOrigin)).append("\n"); + sb.append(" countryOriginAlt: ").append(toIndentedString(countryOriginAlt)).append("\n"); + sb.append(" countriesOriginTop: ").append(toIndentedString(countriesOriginTop)).append("\n"); + sb.append(" score: ").append(toIndentedString(score)).append("\n"); + sb.append(" regionOrigin: ").append(toIndentedString(regionOrigin)).append("\n"); + sb.append(" topRegionOrigin: ").append(toIndentedString(topRegionOrigin)).append("\n"); + sb.append(" subRegionOrigin: ").append(toIndentedString(subRegionOrigin)).append("\n"); + sb.append(" probabilityCalibrated: ").append(toIndentedString(probabilityCalibrated)).append("\n"); + sb.append(" probabilityAltCalibrated: ").append(toIndentedString(probabilityAltCalibrated)).append("\n"); + sb.append(" religionStats: ").append(toIndentedString(religionStats)).append("\n"); + sb.append(" religionStatsAlt: ").append(toIndentedString(religionStatsAlt)).append("\n"); + sb.append(" religionStatsSynthetic: ").append(toIndentedString(religionStatsSynthetic)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + + public static HashSet openapiFields; + public static HashSet openapiRequiredFields; + + static { + // a set of all properties/fields (JSON key names) + openapiFields = new HashSet(); + openapiFields.add("script"); + openapiFields.add("id"); + openapiFields.add("explanation"); + openapiFields.add("name"); + openapiFields.add("countryOrigin"); + openapiFields.add("countryOriginAlt"); + openapiFields.add("countriesOriginTop"); + openapiFields.add("score"); + openapiFields.add("regionOrigin"); + openapiFields.add("topRegionOrigin"); + openapiFields.add("subRegionOrigin"); + openapiFields.add("probabilityCalibrated"); + openapiFields.add("probabilityAltCalibrated"); + openapiFields.add("religionStats"); + openapiFields.add("religionStatsAlt"); + openapiFields.add("religionStatsSynthetic"); + + // a set of required properties/fields (JSON key names) + openapiRequiredFields = new HashSet(); + } + + /** + * Validates the JSON Object and throws an exception if issues found + * + * @param jsonObj JSON Object + * @throws IOException if the JSON Object is invalid with respect to PersonalNameOriginedOut + */ + public static void validateJsonObject(JsonObject jsonObj) throws IOException { + if (jsonObj == null) { + if (!PersonalNameOriginedOut.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null + throw new IllegalArgumentException(String.format("The required field(s) %s in PersonalNameOriginedOut is not found in the empty JSON string", PersonalNameOriginedOut.openapiRequiredFields.toString())); + } + } + + Set> entries = jsonObj.entrySet(); + // check to see if the JSON string contains additional fields + for (Entry entry : entries) { + if (!PersonalNameOriginedOut.openapiFields.contains(entry.getKey())) { + throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `PersonalNameOriginedOut` properties. JSON: %s", entry.getKey(), jsonObj.toString())); + } + } + if ((jsonObj.get("script") != null && !jsonObj.get("script").isJsonNull()) && !jsonObj.get("script").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `script` to be a primitive type in the JSON string but got `%s`", jsonObj.get("script").toString())); + } + if ((jsonObj.get("id") != null && !jsonObj.get("id").isJsonNull()) && !jsonObj.get("id").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("id").toString())); + } + if ((jsonObj.get("explanation") != null && !jsonObj.get("explanation").isJsonNull()) && !jsonObj.get("explanation").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `explanation` to be a primitive type in the JSON string but got `%s`", jsonObj.get("explanation").toString())); + } + if ((jsonObj.get("name") != null && !jsonObj.get("name").isJsonNull()) && !jsonObj.get("name").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `name` to be a primitive type in the JSON string but got `%s`", jsonObj.get("name").toString())); + } + if ((jsonObj.get("countryOrigin") != null && !jsonObj.get("countryOrigin").isJsonNull()) && !jsonObj.get("countryOrigin").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `countryOrigin` to be a primitive type in the JSON string but got `%s`", jsonObj.get("countryOrigin").toString())); + } + if ((jsonObj.get("countryOriginAlt") != null && !jsonObj.get("countryOriginAlt").isJsonNull()) && !jsonObj.get("countryOriginAlt").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `countryOriginAlt` to be a primitive type in the JSON string but got `%s`", jsonObj.get("countryOriginAlt").toString())); + } + // ensure the optional json data is an array if present + if (jsonObj.get("countriesOriginTop") != null && !jsonObj.get("countriesOriginTop").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `countriesOriginTop` to be an array in the JSON string but got `%s`", jsonObj.get("countriesOriginTop").toString())); + } + if ((jsonObj.get("regionOrigin") != null && !jsonObj.get("regionOrigin").isJsonNull()) && !jsonObj.get("regionOrigin").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `regionOrigin` to be a primitive type in the JSON string but got `%s`", jsonObj.get("regionOrigin").toString())); + } + if ((jsonObj.get("topRegionOrigin") != null && !jsonObj.get("topRegionOrigin").isJsonNull()) && !jsonObj.get("topRegionOrigin").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `topRegionOrigin` to be a primitive type in the JSON string but got `%s`", jsonObj.get("topRegionOrigin").toString())); + } + if ((jsonObj.get("subRegionOrigin") != null && !jsonObj.get("subRegionOrigin").isJsonNull()) && !jsonObj.get("subRegionOrigin").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `subRegionOrigin` to be a primitive type in the JSON string but got `%s`", jsonObj.get("subRegionOrigin").toString())); + } + if (jsonObj.get("religionStats") != null && !jsonObj.get("religionStats").isJsonNull()) { + JsonArray jsonArrayreligionStats = jsonObj.getAsJsonArray("religionStats"); + if (jsonArrayreligionStats != null) { + // ensure the json data is an array + if (!jsonObj.get("religionStats").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `religionStats` to be an array in the JSON string but got `%s`", jsonObj.get("religionStats").toString())); + } + + // validate the optional field `religionStats` (array) + for (int i = 0; i < jsonArrayreligionStats.size(); i++) { + ReligionStatOut.validateJsonObject(jsonArrayreligionStats.get(i).getAsJsonObject()); + }; + } + } + if (jsonObj.get("religionStatsAlt") != null && !jsonObj.get("religionStatsAlt").isJsonNull()) { + JsonArray jsonArrayreligionStatsAlt = jsonObj.getAsJsonArray("religionStatsAlt"); + if (jsonArrayreligionStatsAlt != null) { + // ensure the json data is an array + if (!jsonObj.get("religionStatsAlt").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `religionStatsAlt` to be an array in the JSON string but got `%s`", jsonObj.get("religionStatsAlt").toString())); + } + + // validate the optional field `religionStatsAlt` (array) + for (int i = 0; i < jsonArrayreligionStatsAlt.size(); i++) { + ReligionStatOut.validateJsonObject(jsonArrayreligionStatsAlt.get(i).getAsJsonObject()); + }; + } + } + if (jsonObj.get("religionStatsSynthetic") != null && !jsonObj.get("religionStatsSynthetic").isJsonNull()) { + JsonArray jsonArrayreligionStatsSynthetic = jsonObj.getAsJsonArray("religionStatsSynthetic"); + if (jsonArrayreligionStatsSynthetic != null) { + // ensure the json data is an array + if (!jsonObj.get("religionStatsSynthetic").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `religionStatsSynthetic` to be an array in the JSON string but got `%s`", jsonObj.get("religionStatsSynthetic").toString())); + } + + // validate the optional field `religionStatsSynthetic` (array) + for (int i = 0; i < jsonArrayreligionStatsSynthetic.size(); i++) { + ReligionStatOut.validateJsonObject(jsonArrayreligionStatsSynthetic.get(i).getAsJsonObject()); + }; + } + } + } + + public static class CustomTypeAdapterFactory implements TypeAdapterFactory { + @SuppressWarnings("unchecked") + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + if (!PersonalNameOriginedOut.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'PersonalNameOriginedOut' and its subtypes + } + final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(PersonalNameOriginedOut.class)); + + return (TypeAdapter) new TypeAdapter() { + @Override + public void write(JsonWriter out, PersonalNameOriginedOut value) throws IOException { + JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); + elementAdapter.write(out, obj); + } + + @Override + public PersonalNameOriginedOut read(JsonReader in) throws IOException { + JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject(); + validateJsonObject(jsonObj); + return thisAdapter.fromJsonTree(jsonObj); + } + + }.nullSafe(); + } + } + + /** + * Create an instance of PersonalNameOriginedOut given an JSON string + * + * @param jsonString JSON string + * @return An instance of PersonalNameOriginedOut + * @throws IOException if the JSON string is invalid with respect to PersonalNameOriginedOut + */ + public static PersonalNameOriginedOut fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, PersonalNameOriginedOut.class); + } + + /** + * Convert an instance of PersonalNameOriginedOut to an JSON string + * + * @return JSON string + */ + public String toJson() { + return JSON.getGson().toJson(this); + } +} + diff --git a/src/main/java/com/namsor/sdk2/model/PersonalNameParsedOut.java b/src/main/java/com/namsor/sdk2/model/PersonalNameParsedOut.java index a2cd8dca..a7139e53 100644 --- a/src/main/java/com/namsor/sdk2/model/PersonalNameParsedOut.java +++ b/src/main/java/com/namsor/sdk2/model/PersonalNameParsedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -51,7 +51,7 @@ /** * PersonalNameParsedOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class PersonalNameParsedOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) @@ -316,7 +316,7 @@ public PersonalNameParsedOut name(String name) { } /** - * The input name + * The input name. * @return name **/ @javax.annotation.Nullable diff --git a/src/main/java/com/namsor/sdk2/model/PersonalNameReligionedOut.java b/src/main/java/com/namsor/sdk2/model/PersonalNameReligionedOut.java index c1917df9..c714ba5d 100644 --- a/src/main/java/com/namsor/sdk2/model/PersonalNameReligionedOut.java +++ b/src/main/java/com/namsor/sdk2/model/PersonalNameReligionedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -52,7 +52,7 @@ /** * religious-coded names */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class PersonalNameReligionedOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) @@ -261,7 +261,7 @@ public PersonalNameReligionedOut addReligionsTopItem(String religionsTopItem) { } /** - * List countries (top 10) + * List religions (top 10) * @return religionsTop **/ @javax.annotation.Nullable diff --git a/src/main/java/com/namsor/sdk2/model/PersonalNameSubdivisionIn.java b/src/main/java/com/namsor/sdk2/model/PersonalNameSubdivisionIn.java index 45ded678..e5c37dba 100644 --- a/src/main/java/com/namsor/sdk2/model/PersonalNameSubdivisionIn.java +++ b/src/main/java/com/namsor/sdk2/model/PersonalNameSubdivisionIn.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * PersonalNameSubdivisionIn */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class PersonalNameSubdivisionIn { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/namsor/sdk2/model/PersonalNameUSRaceEthnicityOut.java b/src/main/java/com/namsor/sdk2/model/PersonalNameUSRaceEthnicityOut.java new file mode 100644 index 00000000..b5728117 --- /dev/null +++ b/src/main/java/com/namsor/sdk2/model/PersonalNameUSRaceEthnicityOut.java @@ -0,0 +1,605 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonDeserializationContext; +import com.google.gson.JsonDeserializer; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; +import com.google.gson.TypeAdapterFactory; +import com.google.gson.reflect.TypeToken; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +import java.lang.reflect.Type; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import com.namsor.sdk2.invoke.JSON; + +/** + * Represents the output of inferring the LIKELY US 'race/ethnicity' from a personal name, given US country of residence and (optionally) a ZIP5 code. + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") +public class PersonalNameUSRaceEthnicityOut { + public static final String SERIALIZED_NAME_SCRIPT = "script"; + @SerializedName(SERIALIZED_NAME_SCRIPT) + private String script; + + public static final String SERIALIZED_NAME_ID = "id"; + @SerializedName(SERIALIZED_NAME_ID) + private String id; + + public static final String SERIALIZED_NAME_EXPLANATION = "explanation"; + @SerializedName(SERIALIZED_NAME_EXPLANATION) + private String explanation; + + public static final String SERIALIZED_NAME_NAME = "name"; + @SerializedName(SERIALIZED_NAME_NAME) + private String name; + + /** + * Second most likely US 'race'/ethnicity + */ + @JsonAdapter(RaceEthnicityAltEnum.Adapter.class) + public enum RaceEthnicityAltEnum { + W_NL("W_NL"), + + HL("HL"), + + A("A"), + + B_NL("B_NL"), + + AI_AN("AI_AN"), + + PI("PI"); + + private String value; + + RaceEthnicityAltEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static RaceEthnicityAltEnum fromValue(String value) { + for (RaceEthnicityAltEnum b : RaceEthnicityAltEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final RaceEthnicityAltEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public RaceEthnicityAltEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return RaceEthnicityAltEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_RACE_ETHNICITY_ALT = "raceEthnicityAlt"; + @SerializedName(SERIALIZED_NAME_RACE_ETHNICITY_ALT) + private RaceEthnicityAltEnum raceEthnicityAlt; + + /** + * Most likely US 'race'/ethnicity + */ + @JsonAdapter(RaceEthnicityEnum.Adapter.class) + public enum RaceEthnicityEnum { + W_NL("W_NL"), + + HL("HL"), + + A("A"), + + B_NL("B_NL"), + + AI_AN("AI_AN"), + + PI("PI"); + + private String value; + + RaceEthnicityEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static RaceEthnicityEnum fromValue(String value) { + for (RaceEthnicityEnum b : RaceEthnicityEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final RaceEthnicityEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public RaceEthnicityEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return RaceEthnicityEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_RACE_ETHNICITY = "raceEthnicity"; + @SerializedName(SERIALIZED_NAME_RACE_ETHNICITY) + private RaceEthnicityEnum raceEthnicity; + + public static final String SERIALIZED_NAME_SCORE = "score"; + @SerializedName(SERIALIZED_NAME_SCORE) + private Double score; + + public static final String SERIALIZED_NAME_RACE_ETHNICITIES_TOP = "raceEthnicitiesTop"; + @SerializedName(SERIALIZED_NAME_RACE_ETHNICITIES_TOP) + private List raceEthnicitiesTop; + + public static final String SERIALIZED_NAME_PROBABILITY_CALIBRATED = "probabilityCalibrated"; + @SerializedName(SERIALIZED_NAME_PROBABILITY_CALIBRATED) + private Double probabilityCalibrated; + + public static final String SERIALIZED_NAME_PROBABILITY_ALT_CALIBRATED = "probabilityAltCalibrated"; + @SerializedName(SERIALIZED_NAME_PROBABILITY_ALT_CALIBRATED) + private Double probabilityAltCalibrated; + + public PersonalNameUSRaceEthnicityOut() { + } + + public PersonalNameUSRaceEthnicityOut script(String script) { + + this.script = script; + return this; + } + + /** + * Get script + * @return script + **/ + @javax.annotation.Nullable + public String getScript() { + return script; + } + + + public void setScript(String script) { + this.script = script; + } + + + public PersonalNameUSRaceEthnicityOut id(String id) { + + this.id = id; + return this; + } + + /** + * Get id + * @return id + **/ + @javax.annotation.Nullable + public String getId() { + return id; + } + + + public void setId(String id) { + this.id = id; + } + + + public PersonalNameUSRaceEthnicityOut explanation(String explanation) { + + this.explanation = explanation; + return this; + } + + /** + * Get explanation + * @return explanation + **/ + @javax.annotation.Nullable + public String getExplanation() { + return explanation; + } + + + public void setExplanation(String explanation) { + this.explanation = explanation; + } + + + public PersonalNameUSRaceEthnicityOut name(String name) { + + this.name = name; + return this; + } + + /** + * The input name. + * @return name + **/ + @javax.annotation.Nullable + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public PersonalNameUSRaceEthnicityOut raceEthnicityAlt(RaceEthnicityAltEnum raceEthnicityAlt) { + + this.raceEthnicityAlt = raceEthnicityAlt; + return this; + } + + /** + * Second most likely US 'race'/ethnicity + * @return raceEthnicityAlt + **/ + @javax.annotation.Nullable + public RaceEthnicityAltEnum getRaceEthnicityAlt() { + return raceEthnicityAlt; + } + + + public void setRaceEthnicityAlt(RaceEthnicityAltEnum raceEthnicityAlt) { + this.raceEthnicityAlt = raceEthnicityAlt; + } + + + public PersonalNameUSRaceEthnicityOut raceEthnicity(RaceEthnicityEnum raceEthnicity) { + + this.raceEthnicity = raceEthnicity; + return this; + } + + /** + * Most likely US 'race'/ethnicity + * @return raceEthnicity + **/ + @javax.annotation.Nullable + public RaceEthnicityEnum getRaceEthnicity() { + return raceEthnicity; + } + + + public void setRaceEthnicity(RaceEthnicityEnum raceEthnicity) { + this.raceEthnicity = raceEthnicity; + } + + + public PersonalNameUSRaceEthnicityOut score(Double score) { + + this.score = score; + return this; + } + + /** + * Higher score is better, but score is not normalized. Use calibratedProbability if available. + * minimum: 0 + * maximum: 100 + * @return score + **/ + @javax.annotation.Nullable + public Double getScore() { + return score; + } + + + public void setScore(Double score) { + this.score = score; + } + + + public PersonalNameUSRaceEthnicityOut raceEthnicitiesTop(List raceEthnicitiesTop) { + + this.raceEthnicitiesTop = raceEthnicitiesTop; + return this; + } + + public PersonalNameUSRaceEthnicityOut addRaceEthnicitiesTopItem(String raceEthnicitiesTopItem) { + if (this.raceEthnicitiesTop == null) { + this.raceEthnicitiesTop = new ArrayList<>(); + } + this.raceEthnicitiesTop.add(raceEthnicitiesTopItem); + return this; + } + + /** + * List 'race'/ethnicities + * @return raceEthnicitiesTop + **/ + @javax.annotation.Nullable + public List getRaceEthnicitiesTop() { + return raceEthnicitiesTop; + } + + + public void setRaceEthnicitiesTop(List raceEthnicitiesTop) { + this.raceEthnicitiesTop = raceEthnicitiesTop; + } + + + public PersonalNameUSRaceEthnicityOut probabilityCalibrated(Double probabilityCalibrated) { + + this.probabilityCalibrated = probabilityCalibrated; + return this; + } + + /** + * The calibrated probability for raceEthnicity to have been guessed correctly. -1 = still calibrating. + * minimum: -1 + * maximum: 1 + * @return probabilityCalibrated + **/ + @javax.annotation.Nullable + public Double getProbabilityCalibrated() { + return probabilityCalibrated; + } + + + public void setProbabilityCalibrated(Double probabilityCalibrated) { + this.probabilityCalibrated = probabilityCalibrated; + } + + + public PersonalNameUSRaceEthnicityOut probabilityAltCalibrated(Double probabilityAltCalibrated) { + + this.probabilityAltCalibrated = probabilityAltCalibrated; + return this; + } + + /** + * The calibrated probability for raceEthnicity OR raceEthnicityAlt to have been guessed correctly. -1 = still calibrating. + * minimum: -1 + * maximum: 1 + * @return probabilityAltCalibrated + **/ + @javax.annotation.Nullable + public Double getProbabilityAltCalibrated() { + return probabilityAltCalibrated; + } + + + public void setProbabilityAltCalibrated(Double probabilityAltCalibrated) { + this.probabilityAltCalibrated = probabilityAltCalibrated; + } + + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PersonalNameUSRaceEthnicityOut personalNameUSRaceEthnicityOut = (PersonalNameUSRaceEthnicityOut) o; + return Objects.equals(this.script, personalNameUSRaceEthnicityOut.script) && + Objects.equals(this.id, personalNameUSRaceEthnicityOut.id) && + Objects.equals(this.explanation, personalNameUSRaceEthnicityOut.explanation) && + Objects.equals(this.name, personalNameUSRaceEthnicityOut.name) && + Objects.equals(this.raceEthnicityAlt, personalNameUSRaceEthnicityOut.raceEthnicityAlt) && + Objects.equals(this.raceEthnicity, personalNameUSRaceEthnicityOut.raceEthnicity) && + Objects.equals(this.score, personalNameUSRaceEthnicityOut.score) && + Objects.equals(this.raceEthnicitiesTop, personalNameUSRaceEthnicityOut.raceEthnicitiesTop) && + Objects.equals(this.probabilityCalibrated, personalNameUSRaceEthnicityOut.probabilityCalibrated) && + Objects.equals(this.probabilityAltCalibrated, personalNameUSRaceEthnicityOut.probabilityAltCalibrated); + } + + @Override + public int hashCode() { + return Objects.hash(script, id, explanation, name, raceEthnicityAlt, raceEthnicity, score, raceEthnicitiesTop, probabilityCalibrated, probabilityAltCalibrated); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PersonalNameUSRaceEthnicityOut {\n"); + sb.append(" script: ").append(toIndentedString(script)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" explanation: ").append(toIndentedString(explanation)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" raceEthnicityAlt: ").append(toIndentedString(raceEthnicityAlt)).append("\n"); + sb.append(" raceEthnicity: ").append(toIndentedString(raceEthnicity)).append("\n"); + sb.append(" score: ").append(toIndentedString(score)).append("\n"); + sb.append(" raceEthnicitiesTop: ").append(toIndentedString(raceEthnicitiesTop)).append("\n"); + sb.append(" probabilityCalibrated: ").append(toIndentedString(probabilityCalibrated)).append("\n"); + sb.append(" probabilityAltCalibrated: ").append(toIndentedString(probabilityAltCalibrated)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + + public static HashSet openapiFields; + public static HashSet openapiRequiredFields; + + static { + // a set of all properties/fields (JSON key names) + openapiFields = new HashSet(); + openapiFields.add("script"); + openapiFields.add("id"); + openapiFields.add("explanation"); + openapiFields.add("name"); + openapiFields.add("raceEthnicityAlt"); + openapiFields.add("raceEthnicity"); + openapiFields.add("score"); + openapiFields.add("raceEthnicitiesTop"); + openapiFields.add("probabilityCalibrated"); + openapiFields.add("probabilityAltCalibrated"); + + // a set of required properties/fields (JSON key names) + openapiRequiredFields = new HashSet(); + } + + /** + * Validates the JSON Object and throws an exception if issues found + * + * @param jsonObj JSON Object + * @throws IOException if the JSON Object is invalid with respect to PersonalNameUSRaceEthnicityOut + */ + public static void validateJsonObject(JsonObject jsonObj) throws IOException { + if (jsonObj == null) { + if (!PersonalNameUSRaceEthnicityOut.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null + throw new IllegalArgumentException(String.format("The required field(s) %s in PersonalNameUSRaceEthnicityOut is not found in the empty JSON string", PersonalNameUSRaceEthnicityOut.openapiRequiredFields.toString())); + } + } + + Set> entries = jsonObj.entrySet(); + // check to see if the JSON string contains additional fields + for (Entry entry : entries) { + if (!PersonalNameUSRaceEthnicityOut.openapiFields.contains(entry.getKey())) { + throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `PersonalNameUSRaceEthnicityOut` properties. JSON: %s", entry.getKey(), jsonObj.toString())); + } + } + if ((jsonObj.get("script") != null && !jsonObj.get("script").isJsonNull()) && !jsonObj.get("script").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `script` to be a primitive type in the JSON string but got `%s`", jsonObj.get("script").toString())); + } + if ((jsonObj.get("id") != null && !jsonObj.get("id").isJsonNull()) && !jsonObj.get("id").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("id").toString())); + } + if ((jsonObj.get("explanation") != null && !jsonObj.get("explanation").isJsonNull()) && !jsonObj.get("explanation").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `explanation` to be a primitive type in the JSON string but got `%s`", jsonObj.get("explanation").toString())); + } + if ((jsonObj.get("name") != null && !jsonObj.get("name").isJsonNull()) && !jsonObj.get("name").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `name` to be a primitive type in the JSON string but got `%s`", jsonObj.get("name").toString())); + } + if ((jsonObj.get("raceEthnicityAlt") != null && !jsonObj.get("raceEthnicityAlt").isJsonNull()) && !jsonObj.get("raceEthnicityAlt").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `raceEthnicityAlt` to be a primitive type in the JSON string but got `%s`", jsonObj.get("raceEthnicityAlt").toString())); + } + if ((jsonObj.get("raceEthnicity") != null && !jsonObj.get("raceEthnicity").isJsonNull()) && !jsonObj.get("raceEthnicity").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `raceEthnicity` to be a primitive type in the JSON string but got `%s`", jsonObj.get("raceEthnicity").toString())); + } + // ensure the optional json data is an array if present + if (jsonObj.get("raceEthnicitiesTop") != null && !jsonObj.get("raceEthnicitiesTop").isJsonArray()) { + throw new IllegalArgumentException(String.format("Expected the field `raceEthnicitiesTop` to be an array in the JSON string but got `%s`", jsonObj.get("raceEthnicitiesTop").toString())); + } + } + + public static class CustomTypeAdapterFactory implements TypeAdapterFactory { + @SuppressWarnings("unchecked") + @Override + public TypeAdapter create(Gson gson, TypeToken type) { + if (!PersonalNameUSRaceEthnicityOut.class.isAssignableFrom(type.getRawType())) { + return null; // this class only serializes 'PersonalNameUSRaceEthnicityOut' and its subtypes + } + final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class); + final TypeAdapter thisAdapter + = gson.getDelegateAdapter(this, TypeToken.get(PersonalNameUSRaceEthnicityOut.class)); + + return (TypeAdapter) new TypeAdapter() { + @Override + public void write(JsonWriter out, PersonalNameUSRaceEthnicityOut value) throws IOException { + JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject(); + elementAdapter.write(out, obj); + } + + @Override + public PersonalNameUSRaceEthnicityOut read(JsonReader in) throws IOException { + JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject(); + validateJsonObject(jsonObj); + return thisAdapter.fromJsonTree(jsonObj); + } + + }.nullSafe(); + } + } + + /** + * Create an instance of PersonalNameUSRaceEthnicityOut given an JSON string + * + * @param jsonString JSON string + * @return An instance of PersonalNameUSRaceEthnicityOut + * @throws IOException if the JSON string is invalid with respect to PersonalNameUSRaceEthnicityOut + */ + public static PersonalNameUSRaceEthnicityOut fromJson(String jsonString) throws IOException { + return JSON.getGson().fromJson(jsonString, PersonalNameUSRaceEthnicityOut.class); + } + + /** + * Convert an instance of PersonalNameUSRaceEthnicityOut to an JSON string + * + * @return JSON string + */ + public String toJson() { + return JSON.getGson().toJson(this); + } +} + diff --git a/src/main/java/com/namsor/sdk2/model/ProperNounCategorizedOut.java b/src/main/java/com/namsor/sdk2/model/ProperNounCategorizedOut.java index cee9e177..b088327d 100644 --- a/src/main/java/com/namsor/sdk2/model/ProperNounCategorizedOut.java +++ b/src/main/java/com/namsor/sdk2/model/ProperNounCategorizedOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * Classified typed proper names */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class ProperNounCategorizedOut { public static final String SERIALIZED_NAME_SCRIPT = "script"; @SerializedName(SERIALIZED_NAME_SCRIPT) diff --git a/src/main/java/com/namsor/sdk2/model/RegionISO.java b/src/main/java/com/namsor/sdk2/model/RegionISO.java index b534df92..8e780c47 100644 --- a/src/main/java/com/namsor/sdk2/model/RegionISO.java +++ b/src/main/java/com/namsor/sdk2/model/RegionISO.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -50,7 +50,7 @@ /** * List of countries and regions */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class RegionISO { public static final String SERIALIZED_NAME_COUNTRY_NAME = "countryName"; @SerializedName(SERIALIZED_NAME_COUNTRY_NAME) diff --git a/src/main/java/com/namsor/sdk2/model/RegionOut.java b/src/main/java/com/namsor/sdk2/model/RegionOut.java index 411c4343..289ce4e4 100644 --- a/src/main/java/com/namsor/sdk2/model/RegionOut.java +++ b/src/main/java/com/namsor/sdk2/model/RegionOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -53,7 +53,7 @@ /** * RegionOut */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class RegionOut { public static final String SERIALIZED_NAME_COUNTRIES_AND_REGIONS = "countriesAndRegions"; @SerializedName(SERIALIZED_NAME_COUNTRIES_AND_REGIONS) diff --git a/src/main/java/com/namsor/sdk2/model/ReligionStatOut.java b/src/main/java/com/namsor/sdk2/model/ReligionStatOut.java index 2fa89325..a0e29656 100644 --- a/src/main/java/com/namsor/sdk2/model/ReligionStatOut.java +++ b/src/main/java/com/namsor/sdk2/model/ReligionStatOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -48,9 +48,9 @@ import com.namsor.sdk2.invoke.JSON; /** - * Geographic religious statistics, assuming ethnicity OR best alternative is correctly predicted. + * Geographic religious statistics, assuming country is correctly predicted. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class ReligionStatOut { public static final String SERIALIZED_NAME_RELIGION = "religion"; @SerializedName(SERIALIZED_NAME_RELIGION) diff --git a/src/main/java/com/namsor/sdk2/model/SoftwareVersionOut.java b/src/main/java/com/namsor/sdk2/model/SoftwareVersionOut.java index 7d0c58f5..d0f2eb3e 100644 --- a/src/main/java/com/namsor/sdk2/model/SoftwareVersionOut.java +++ b/src/main/java/com/namsor/sdk2/model/SoftwareVersionOut.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -52,7 +52,7 @@ /** * The software version. */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-07-16T08:45:49.006+02:00[Europe/Berlin]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-01-28T10:15:07.323+01:00[Europe/Berlin]") public class SoftwareVersionOut { public static final String SERIALIZED_NAME_SOFTWARE_NAME_AND_VERSION = "softwareNameAndVersion"; @SerializedName(SERIALIZED_NAME_SOFTWARE_NAME_AND_VERSION) diff --git a/src/test/java/com/namsor/sdk2/api/AdminApiTest.java b/src/test/java/com/namsor/sdk2/api/AdminApiTest.java index 3591c5a0..82e7e1ec 100644 --- a/src/test/java/com/namsor/sdk2/api/AdminApiTest.java +++ b/src/test/java/com/namsor/sdk2/api/AdminApiTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -48,8 +48,7 @@ public class AdminApiTest { public void anonymizeTest() throws ApiException { String source = null; Boolean anonymized = null; - String token = null; - APIKeyOut response = api.anonymize(source, anonymized, token); + api.anonymize(source, anonymized); // TODO: test validations } @@ -62,7 +61,8 @@ public void anonymizeTest() throws ApiException { public void anonymize1Test() throws ApiException { String source = null; Boolean anonymized = null; - api.anonymize1(source, anonymized); + String token = null; + APIKeyOut response = api.anonymize1(source, anonymized, token); // TODO: test validations } diff --git a/src/test/java/com/namsor/sdk2/api/ChineseApiTest.java b/src/test/java/com/namsor/sdk2/api/ChineseApiTest.java index 7b8ff2e9..03896375 100644 --- a/src/test/java/com/namsor/sdk2/api/ChineseApiTest.java +++ b/src/test/java/com/namsor/sdk2/api/ChineseApiTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/api/GeneralApiTest.java b/src/test/java/com/namsor/sdk2/api/GeneralApiTest.java index 001399a6..ba19754b 100644 --- a/src/test/java/com/namsor/sdk2/api/GeneralApiTest.java +++ b/src/test/java/com/namsor/sdk2/api/GeneralApiTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/api/IndianApiTest.java b/src/test/java/com/namsor/sdk2/api/IndianApiTest.java index 86ddb42b..ce426c2d 100644 --- a/src/test/java/com/namsor/sdk2/api/IndianApiTest.java +++ b/src/test/java/com/namsor/sdk2/api/IndianApiTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/api/JapaneseApiTest.java b/src/test/java/com/namsor/sdk2/api/JapaneseApiTest.java index 77375e44..4d82af29 100644 --- a/src/test/java/com/namsor/sdk2/api/JapaneseApiTest.java +++ b/src/test/java/com/namsor/sdk2/api/JapaneseApiTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -107,7 +107,7 @@ public void japaneseNameGenderKanjiCandidatesBatchTest() throws ApiException { } /** - * 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. * * @throws ApiException if the Api call fails */ @@ -115,12 +115,13 @@ public void japaneseNameGenderKanjiCandidatesBatchTest() throws ApiException { public void japaneseNameKanjiCandidatesTest() throws ApiException { String japaneseSurnameLatin = null; String japaneseGivenNameLatin = null; - NameMatchCandidatesOut response = api.japaneseNameKanjiCandidates(japaneseSurnameLatin, japaneseGivenNameLatin); + String knownGender = null; + NameMatchCandidatesOut response = api.japaneseNameKanjiCandidates(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender); // TODO: test validations } /** - * 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 * * @throws ApiException if the Api call fails */ @@ -128,8 +129,7 @@ public void japaneseNameKanjiCandidatesTest() throws ApiException { public void japaneseNameKanjiCandidates1Test() throws ApiException { String japaneseSurnameLatin = null; String japaneseGivenNameLatin = null; - String knownGender = null; - NameMatchCandidatesOut response = api.japaneseNameKanjiCandidates1(japaneseSurnameLatin, japaneseGivenNameLatin, knownGender); + NameMatchCandidatesOut response = api.japaneseNameKanjiCandidates1(japaneseSurnameLatin, japaneseGivenNameLatin); // TODO: test validations } diff --git a/src/test/java/com/namsor/sdk2/api/PersonalApiTest.java b/src/test/java/com/namsor/sdk2/api/PersonalApiTest.java index ee4dc97b..78800bfe 100644 --- a/src/test/java/com/namsor/sdk2/api/PersonalApiTest.java +++ b/src/test/java/com/namsor/sdk2/api/PersonalApiTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -14,11 +14,14 @@ package com.namsor.sdk2.api; import com.namsor.sdk2.invoke.ApiException; +import com.namsor.sdk2.model.BatchCommunityEngageFullOut; +import com.namsor.sdk2.model.BatchCommunityEngageOut; import com.namsor.sdk2.model.BatchCorridorIn; import com.namsor.sdk2.model.BatchCorridorOut; import com.namsor.sdk2.model.BatchFirstLastNameDiasporaedOut; import com.namsor.sdk2.model.BatchFirstLastNameGenderedOut; import com.namsor.sdk2.model.BatchFirstLastNameGeoIn; +import com.namsor.sdk2.model.BatchFirstLastNameGeoOut; import com.namsor.sdk2.model.BatchFirstLastNameGeoSubclassificationOut; import com.namsor.sdk2.model.BatchFirstLastNameGeoSubdivisionIn; import com.namsor.sdk2.model.BatchFirstLastNameGeoZippedIn; @@ -26,14 +29,18 @@ import com.namsor.sdk2.model.BatchFirstLastNameOriginedOut; import com.namsor.sdk2.model.BatchFirstLastNameReligionedOut; import com.namsor.sdk2.model.BatchFirstLastNameUSRaceEthnicityOut; +import com.namsor.sdk2.model.BatchPersonalNameDiasporaedOut; import com.namsor.sdk2.model.BatchPersonalNameGenderedOut; import com.namsor.sdk2.model.BatchPersonalNameGeoIn; import com.namsor.sdk2.model.BatchPersonalNameGeoOut; import com.namsor.sdk2.model.BatchPersonalNameGeoSubclassificationOut; import com.namsor.sdk2.model.BatchPersonalNameGeoSubdivisionIn; import com.namsor.sdk2.model.BatchPersonalNameIn; +import com.namsor.sdk2.model.BatchPersonalNameOriginedOut; import com.namsor.sdk2.model.BatchPersonalNameParsedOut; import com.namsor.sdk2.model.BatchPersonalNameReligionedOut; +import com.namsor.sdk2.model.BatchPersonalNameUSRaceEthnicityOut; +import com.namsor.sdk2.model.CommunityEngageOut; import com.namsor.sdk2.model.CorridorOut; import com.namsor.sdk2.model.FirstLastNameDiasporaedOut; import com.namsor.sdk2.model.FirstLastNameGenderedOut; @@ -41,10 +48,13 @@ import com.namsor.sdk2.model.FirstLastNameOriginedOut; import com.namsor.sdk2.model.FirstLastNameReligionedOut; import com.namsor.sdk2.model.FirstLastNameUSRaceEthnicityOut; +import com.namsor.sdk2.model.PersonalNameDiasporaedOut; import com.namsor.sdk2.model.PersonalNameGenderedOut; import com.namsor.sdk2.model.PersonalNameGeoOut; +import com.namsor.sdk2.model.PersonalNameOriginedOut; import com.namsor.sdk2.model.PersonalNameParsedOut; import com.namsor.sdk2.model.PersonalNameReligionedOut; +import com.namsor.sdk2.model.PersonalNameUSRaceEthnicityOut; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -61,6 +71,57 @@ public class PersonalApiTest { private final PersonalApi api = new PersonalApi(); + /** + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + * + * @throws ApiException if the Api call fails + */ + @Test + public void communityEngageTest() throws ApiException { + String countryIso2 = null; + String firstName = null; + String lastName = null; + CommunityEngageOut response = api.communityEngage(countryIso2, firstName, lastName); + // TODO: test validations + } + + /** + * Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + * + * @throws ApiException if the Api call fails + */ + @Test + public void communityEngageBatchTest() throws ApiException { + BatchFirstLastNameGeoIn batchFirstLastNameGeoIn = null; + BatchCommunityEngageOut response = api.communityEngageBatch(batchFirstLastNameGeoIn); + // TODO: test validations + } + + /** + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + * + * @throws ApiException if the Api call fails + */ + @Test + public void communityEngageFullTest() throws ApiException { + String countryIso2 = null; + String personalNameFull = null; + CommunityEngageOut response = api.communityEngageFull(countryIso2, personalNameFull); + // TODO: test validations + } + + /** + * Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing) + * + * @throws ApiException if the Api call fails + */ + @Test + public void communityEngageFullBatchTest() throws ApiException { + BatchPersonalNameGeoIn batchPersonalNameGeoIn = null; + BatchCommunityEngageFullOut response = api.communityEngageFullBatch(batchPersonalNameGeoIn); + // TODO: test validations + } + /** * [USES 20 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com) * @@ -114,6 +175,31 @@ public void countryBatchTest() throws ApiException { // TODO: test validations } + /** + * [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal first / last name, or one surname. Assumes names as they are in the country of residence OR the country of origin. + * + * @throws ApiException if the Api call fails + */ + @Test + public void countryFnLnTest() throws ApiException { + String firstName = null; + String lastName = null; + FirstLastNameOriginedOut response = api.countryFnLn(firstName, lastName); + // TODO: test validations + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal first / last names, or surnames. Assumes names as they are in the country of residence OR the country of origin. + * + * @throws ApiException if the Api call fails + */ + @Test + public void countryFnLnBatchTest() throws ApiException { + BatchFirstLastNameIn batchFirstLastNameIn = null; + BatchFirstLastNameGeoOut response = api.countryFnLnBatch(batchFirstLastNameIn); + // TODO: test validations + } + /** * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) * @@ -140,6 +226,31 @@ public void diasporaBatchTest() throws ApiException { // TODO: test validations } + /** + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) + * + * @throws ApiException if the Api call fails + */ + @Test + public void diasporaFullTest() throws ApiException { + String countryIso2 = null; + String personalNameFull = null; + PersonalNameDiasporaedOut response = api.diasporaFull(countryIso2, personalNameFull); + // TODO: test validations + } + + /** + * [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) + * + * @throws ApiException if the Api call fails + */ + @Test + public void diasporaFullBatchTest() throws ApiException { + BatchPersonalNameGeoIn batchPersonalNameGeoIn = null; + BatchPersonalNameDiasporaedOut response = api.diasporaFullBatch(batchPersonalNameGeoIn); + // TODO: test validations + } + /** * Infer the likely gender of a just a fiven name, assuming default 'US' local context. Please use preferably full names and local geographic context for better accuracy. * @@ -277,6 +388,30 @@ public void originBatchTest() throws ApiException { // TODO: test validations } + /** + * [USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead. + * + * @throws ApiException if the Api call fails + */ + @Test + public void originFullTest() throws ApiException { + String personalNameFull = null; + PersonalNameOriginedOut response = api.originFull(personalNameFull); + // TODO: test validations + } + + /** + * [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context. + * + * @throws ApiException if the Api call fails + */ + @Test + public void originFullBatchTest() throws ApiException { + BatchPersonalNameIn batchPersonalNameIn = null; + BatchPersonalNameOriginedOut response = api.originFullBatch(batchPersonalNameIn); + // TODO: test validations + } + /** * Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. * @@ -455,6 +590,30 @@ public void usRaceEthnicityBatchTest() throws ApiException { // TODO: test validations } + /** + * [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). + * + * @throws ApiException if the Api call fails + */ + @Test + public void usRaceEthnicityFullTest() throws ApiException { + String personalNameFull = null; + PersonalNameUSRaceEthnicityOut response = api.usRaceEthnicityFull(personalNameFull); + // TODO: test validations + } + + /** + * [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). + * + * @throws ApiException if the Api call fails + */ + @Test + public void usRaceEthnicityFullBatchTest() throws ApiException { + BatchPersonalNameGeoIn batchPersonalNameGeoIn = null; + BatchPersonalNameUSRaceEthnicityOut response = api.usRaceEthnicityFullBatch(batchPersonalNameGeoIn); + // TODO: test validations + } + /** * [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander). * diff --git a/src/test/java/com/namsor/sdk2/api/SocialApiTest.java b/src/test/java/com/namsor/sdk2/api/SocialApiTest.java index 644459ad..7b2ae87b 100644 --- a/src/test/java/com/namsor/sdk2/api/SocialApiTest.java +++ b/src/test/java/com/namsor/sdk2/api/SocialApiTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/APIBillingPeriodUsageOutTest.java b/src/test/java/com/namsor/sdk2/model/APIBillingPeriodUsageOutTest.java index fbb8c2d1..de51c3f5 100644 --- a/src/test/java/com/namsor/sdk2/model/APIBillingPeriodUsageOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/APIBillingPeriodUsageOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/APIClassifierOutTest.java b/src/test/java/com/namsor/sdk2/model/APIClassifierOutTest.java index f00f6986..ed0cc565 100644 --- a/src/test/java/com/namsor/sdk2/model/APIClassifierOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/APIClassifierOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/APIClassifierTaxonomyOutTest.java b/src/test/java/com/namsor/sdk2/model/APIClassifierTaxonomyOutTest.java index 9076f786..2bad6c19 100644 --- a/src/test/java/com/namsor/sdk2/model/APIClassifierTaxonomyOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/APIClassifierTaxonomyOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/APIClassifiersStatusOutTest.java b/src/test/java/com/namsor/sdk2/model/APIClassifiersStatusOutTest.java index a85d856e..f52cd41b 100644 --- a/src/test/java/com/namsor/sdk2/model/APIClassifiersStatusOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/APIClassifiersStatusOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/APICounterV2OutTest.java b/src/test/java/com/namsor/sdk2/model/APICounterV2OutTest.java index ee4fa67a..51a11d96 100644 --- a/src/test/java/com/namsor/sdk2/model/APICounterV2OutTest.java +++ b/src/test/java/com/namsor/sdk2/model/APICounterV2OutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/APIKeyOutTest.java b/src/test/java/com/namsor/sdk2/model/APIKeyOutTest.java index 326638e1..5c0f59f6 100644 --- a/src/test/java/com/namsor/sdk2/model/APIKeyOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/APIKeyOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -18,6 +18,7 @@ import com.google.gson.annotations.SerializedName; import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.CommunityEngageOptionOut; import java.io.IOException; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @@ -133,4 +134,12 @@ public void ipAddressTest() { // TODO: test ipAddress } + /** + * Test the property 'communityEngageOption' + */ + @Test + public void communityEngageOptionTest() { + // TODO: test communityEngageOption + } + } diff --git a/src/test/java/com/namsor/sdk2/model/APIPeriodUsageOutTest.java b/src/test/java/com/namsor/sdk2/model/APIPeriodUsageOutTest.java index 39e91479..a0025fc0 100644 --- a/src/test/java/com/namsor/sdk2/model/APIPeriodUsageOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/APIPeriodUsageOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/APIPlanSubscriptionOutTest.java b/src/test/java/com/namsor/sdk2/model/APIPlanSubscriptionOutTest.java index c39e643a..d89302f0 100644 --- a/src/test/java/com/namsor/sdk2/model/APIPlanSubscriptionOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/APIPlanSubscriptionOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/APIServiceOutTest.java b/src/test/java/com/namsor/sdk2/model/APIServiceOutTest.java index f36d705b..25644669 100644 --- a/src/test/java/com/namsor/sdk2/model/APIServiceOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/APIServiceOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/APIServicesOutTest.java b/src/test/java/com/namsor/sdk2/model/APIServicesOutTest.java index 8910167c..20d26d92 100644 --- a/src/test/java/com/namsor/sdk2/model/APIServicesOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/APIServicesOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/APIUsageAggregatedOutTest.java b/src/test/java/com/namsor/sdk2/model/APIUsageAggregatedOutTest.java index c32fa85b..1e3a56f9 100644 --- a/src/test/java/com/namsor/sdk2/model/APIUsageAggregatedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/APIUsageAggregatedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/APIUsageHistoryOutTest.java b/src/test/java/com/namsor/sdk2/model/APIUsageHistoryOutTest.java index 6402db5c..73e0d57c 100644 --- a/src/test/java/com/namsor/sdk2/model/APIUsageHistoryOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/APIUsageHistoryOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchCommunityEngageFullOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchCommunityEngageFullOutTest.java new file mode 100644 index 00000000..e741bcb3 --- /dev/null +++ b/src/test/java/com/namsor/sdk2/model/BatchCommunityEngageFullOutTest.java @@ -0,0 +1,51 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.CommunityEngageOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + + +/** + * Model tests for BatchCommunityEngageFullOut + */ +public class BatchCommunityEngageFullOutTest { + private final BatchCommunityEngageFullOut model = new BatchCommunityEngageFullOut(); + + /** + * Model tests for BatchCommunityEngageFullOut + */ + @Test + public void testBatchCommunityEngageFullOut() { + // TODO: test BatchCommunityEngageFullOut + } + + /** + * Test the property 'engagementCandidates' + */ + @Test + public void engagementCandidatesTest() { + // TODO: test engagementCandidates + } + +} diff --git a/src/test/java/com/namsor/sdk2/model/BatchCommunityEngageOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchCommunityEngageOutTest.java new file mode 100644 index 00000000..9773634a --- /dev/null +++ b/src/test/java/com/namsor/sdk2/model/BatchCommunityEngageOutTest.java @@ -0,0 +1,51 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.CommunityEngageOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + + +/** + * Model tests for BatchCommunityEngageOut + */ +public class BatchCommunityEngageOutTest { + private final BatchCommunityEngageOut model = new BatchCommunityEngageOut(); + + /** + * Model tests for BatchCommunityEngageOut + */ + @Test + public void testBatchCommunityEngageOut() { + // TODO: test BatchCommunityEngageOut + } + + /** + * Test the property 'engagementCandidates' + */ + @Test + public void engagementCandidatesTest() { + // TODO: test engagementCandidates + } + +} diff --git a/src/test/java/com/namsor/sdk2/model/BatchCorridorInTest.java b/src/test/java/com/namsor/sdk2/model/BatchCorridorInTest.java index ad1bc9e7..2077c502 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchCorridorInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchCorridorInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchCorridorOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchCorridorOutTest.java index 19ea6c83..81cf955e 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchCorridorOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchCorridorOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameCasteOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameCasteOutTest.java index 2e4af3d7..7f581626 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameCasteOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameCasteOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameCastegroupOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameCastegroupOutTest.java index ea1baf23..b3d1d68e 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameCastegroupOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameCastegroupOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameDiasporaedOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameDiasporaedOutTest.java index 66a9ac4a..97544b0d 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameDiasporaedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameDiasporaedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGenderInTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGenderInTest.java index 3b1e4023..9755d81a 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGenderInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGenderInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGenderedOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGenderedOutTest.java index d54f0bc8..faf81ca3 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGenderedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGenderedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoInTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoInTest.java index 46a90c88..d229477e 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoOutTest.java new file mode 100644 index 00000000..fba23042 --- /dev/null +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoOutTest.java @@ -0,0 +1,51 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.FirstLastNameGeoOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + + +/** + * Model tests for BatchFirstLastNameGeoOut + */ +public class BatchFirstLastNameGeoOutTest { + private final BatchFirstLastNameGeoOut model = new BatchFirstLastNameGeoOut(); + + /** + * Model tests for BatchFirstLastNameGeoOut + */ + @Test + public void testBatchFirstLastNameGeoOut() { + // TODO: test BatchFirstLastNameGeoOut + } + + /** + * Test the property 'personalNames' + */ + @Test + public void personalNamesTest() { + // TODO: test personalNames + } + +} diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubclassificationOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubclassificationOutTest.java index e526cc93..28fcdd96 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubclassificationOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubclassificationOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubdivisionInTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubdivisionInTest.java index eb14121d..7327a22c 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubdivisionInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoSubdivisionInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoZippedInTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoZippedInTest.java index cd991bb8..e2087a5c 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoZippedInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameGeoZippedInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameInTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameInTest.java index 36d9fda0..255dbd50 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameOriginedOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameOriginedOutTest.java index a8230a6c..663ac085 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameOriginedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameOriginedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneCodedOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneCodedOutTest.java index a1ed6651..ab55191f 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneCodedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneCodedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberGeoInTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberGeoInTest.java index c844511e..ff987c34 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberGeoInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberGeoInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberInTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberInTest.java index 1a1e643f..c758faba 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNamePhoneNumberInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameReligionedOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameReligionedOutTest.java index c437c29a..5f05d8a2 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameReligionedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameReligionedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameSubdivisionInTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameSubdivisionInTest.java index 3ad9fcd1..f8bc546e 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameSubdivisionInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameSubdivisionInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameUSRaceEthnicityOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameUSRaceEthnicityOutTest.java index b868171e..4eac8dd5 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameUSRaceEthnicityOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchFirstLastNameUSRaceEthnicityOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchMatchPersonalFirstLastNameInTest.java b/src/test/java/com/namsor/sdk2/model/BatchMatchPersonalFirstLastNameInTest.java index 4b24b358..db0c2a1e 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchMatchPersonalFirstLastNameInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchMatchPersonalFirstLastNameInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchNameGeoInTest.java b/src/test/java/com/namsor/sdk2/model/BatchNameGeoInTest.java index 63913a6d..47d7274f 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchNameGeoInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchNameGeoInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchNameInTest.java b/src/test/java/com/namsor/sdk2/model/BatchNameInTest.java index 7e86b8d5..abd63876 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchNameInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchNameInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchNameMatchCandidatesOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchNameMatchCandidatesOutTest.java index b6114500..3ccea6b3 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchNameMatchCandidatesOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchNameMatchCandidatesOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchNameMatchedOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchNameMatchedOutTest.java index d5f6ea10..39dffcac 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchNameMatchedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchNameMatchedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameCastegroupOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameCastegroupOutTest.java index a01c2f65..d0eb83e9 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameCastegroupOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameCastegroupOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameDiasporaedOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameDiasporaedOutTest.java new file mode 100644 index 00000000..d40c18c6 --- /dev/null +++ b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameDiasporaedOutTest.java @@ -0,0 +1,51 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.PersonalNameDiasporaedOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + + +/** + * Model tests for BatchPersonalNameDiasporaedOut + */ +public class BatchPersonalNameDiasporaedOutTest { + private final BatchPersonalNameDiasporaedOut model = new BatchPersonalNameDiasporaedOut(); + + /** + * Model tests for BatchPersonalNameDiasporaedOut + */ + @Test + public void testBatchPersonalNameDiasporaedOut() { + // TODO: test BatchPersonalNameDiasporaedOut + } + + /** + * Test the property 'personalNames' + */ + @Test + public void personalNamesTest() { + // TODO: test personalNames + } + +} diff --git a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGenderedOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGenderedOutTest.java index eebeaf5b..813990e7 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGenderedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGenderedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoInTest.java b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoInTest.java index 0e303355..152d7471 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoOutTest.java index 32861d9e..d0c28d29 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubclassificationOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubclassificationOutTest.java index bf276c36..530f36a9 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubclassificationOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubclassificationOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubdivisionInTest.java b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubdivisionInTest.java index efb3d60d..1212878b 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubdivisionInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameGeoSubdivisionInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameInTest.java b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameInTest.java index 993fa870..b20a8e07 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameOriginedOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameOriginedOutTest.java new file mode 100644 index 00000000..b4c28e70 --- /dev/null +++ b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameOriginedOutTest.java @@ -0,0 +1,51 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.PersonalNameOriginedOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + + +/** + * Model tests for BatchPersonalNameOriginedOut + */ +public class BatchPersonalNameOriginedOutTest { + private final BatchPersonalNameOriginedOut model = new BatchPersonalNameOriginedOut(); + + /** + * Model tests for BatchPersonalNameOriginedOut + */ + @Test + public void testBatchPersonalNameOriginedOut() { + // TODO: test BatchPersonalNameOriginedOut + } + + /** + * Test the property 'personalNames' + */ + @Test + public void personalNamesTest() { + // TODO: test personalNames + } + +} diff --git a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameParsedOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameParsedOutTest.java index c63f8622..f642d6a1 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameParsedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameParsedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameReligionedOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameReligionedOutTest.java index 688ebefa..95e45dd9 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameReligionedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameReligionedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameSubdivisionInTest.java b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameSubdivisionInTest.java index 6524dc2c..81ee9661 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameSubdivisionInTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameSubdivisionInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/BatchPersonalNameUSRaceEthnicityOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameUSRaceEthnicityOutTest.java new file mode 100644 index 00000000..655c61e3 --- /dev/null +++ b/src/test/java/com/namsor/sdk2/model/BatchPersonalNameUSRaceEthnicityOutTest.java @@ -0,0 +1,51 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.PersonalNameUSRaceEthnicityOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + + +/** + * Model tests for BatchPersonalNameUSRaceEthnicityOut + */ +public class BatchPersonalNameUSRaceEthnicityOutTest { + private final BatchPersonalNameUSRaceEthnicityOut model = new BatchPersonalNameUSRaceEthnicityOut(); + + /** + * Model tests for BatchPersonalNameUSRaceEthnicityOut + */ + @Test + public void testBatchPersonalNameUSRaceEthnicityOut() { + // TODO: test BatchPersonalNameUSRaceEthnicityOut + } + + /** + * Test the property 'personalNames' + */ + @Test + public void personalNamesTest() { + // TODO: test personalNames + } + +} diff --git a/src/test/java/com/namsor/sdk2/model/BatchProperNounCategorizedOutTest.java b/src/test/java/com/namsor/sdk2/model/BatchProperNounCategorizedOutTest.java index 2dceb1e9..b4282a2b 100644 --- a/src/test/java/com/namsor/sdk2/model/BatchProperNounCategorizedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/BatchProperNounCategorizedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/CommunityEngageOptionOutTest.java b/src/test/java/com/namsor/sdk2/model/CommunityEngageOptionOutTest.java new file mode 100644 index 00000000..91874363 --- /dev/null +++ b/src/test/java/com/namsor/sdk2/model/CommunityEngageOptionOutTest.java @@ -0,0 +1,74 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + + +/** + * Model tests for CommunityEngageOptionOut + */ +public class CommunityEngageOptionOutTest { + private final CommunityEngageOptionOut model = new CommunityEngageOptionOut(); + + /** + * Model tests for CommunityEngageOptionOut + */ + @Test + public void testCommunityEngageOptionOut() { + // TODO: test CommunityEngageOptionOut + } + + /** + * Test the property 'genderFilter' + */ + @Test + public void genderFilterTest() { + // TODO: test genderFilter + } + + /** + * Test the property 'ethnicityFilter' + */ + @Test + public void ethnicityFilterTest() { + // TODO: test ethnicityFilter + } + + /** + * Test the property 'countryOutFilter' + */ + @Test + public void countryOutFilterTest() { + // TODO: test countryOutFilter + } + + /** + * Test the property 'usRaceEthnicityFilter' + */ + @Test + public void usRaceEthnicityFilterTest() { + // TODO: test usRaceEthnicityFilter + } + +} diff --git a/src/test/java/com/namsor/sdk2/model/CommunityEngageOutTest.java b/src/test/java/com/namsor/sdk2/model/CommunityEngageOutTest.java new file mode 100644 index 00000000..bc5c6234 --- /dev/null +++ b/src/test/java/com/namsor/sdk2/model/CommunityEngageOutTest.java @@ -0,0 +1,117 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.PersonalNameDiasporaedOut; +import com.namsor.sdk2.model.PersonalNameGenderedOut; +import com.namsor.sdk2.model.PersonalNameGeoOut; +import com.namsor.sdk2.model.PersonalNameOriginedOut; +import com.namsor.sdk2.model.PersonalNameUSRaceEthnicityOut; +import java.io.IOException; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + + +/** + * Model tests for CommunityEngageOut + */ +public class CommunityEngageOutTest { + private final CommunityEngageOut model = new CommunityEngageOut(); + + /** + * Model tests for CommunityEngageOut + */ + @Test + public void testCommunityEngageOut() { + // TODO: test CommunityEngageOut + } + + /** + * Test the property 'id' + */ + @Test + public void idTest() { + // TODO: test id + } + + /** + * Test the property 'personalNameDiasporaedOut' + */ + @Test + public void personalNameDiasporaedOutTest() { + // TODO: test personalNameDiasporaedOut + } + + /** + * Test the property 'personalNameOriginedOut' + */ + @Test + public void personalNameOriginedOutTest() { + // TODO: test personalNameOriginedOut + } + + /** + * Test the property 'country' + */ + @Test + public void countryTest() { + // TODO: test country + } + + /** + * Test the property 'gender' + */ + @Test + public void genderTest() { + // TODO: test gender + } + + /** + * Test the property 'personalNameUSRaceEthnicityOut' + */ + @Test + public void personalNameUSRaceEthnicityOutTest() { + // TODO: test personalNameUSRaceEthnicityOut + } + + /** + * Test the property 'prime' + */ + @Test + public void primeTest() { + // TODO: test prime + } + + /** + * Test the property 'scoped' + */ + @Test + public void scopedTest() { + // TODO: test scoped + } + + /** + * Test the property 'script' + */ + @Test + public void scriptTest() { + // TODO: test script + } + +} diff --git a/src/test/java/com/namsor/sdk2/model/CorridorInTest.java b/src/test/java/com/namsor/sdk2/model/CorridorInTest.java index c3ad93d3..1602fa30 100644 --- a/src/test/java/com/namsor/sdk2/model/CorridorInTest.java +++ b/src/test/java/com/namsor/sdk2/model/CorridorInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/CorridorOutTest.java b/src/test/java/com/namsor/sdk2/model/CorridorOutTest.java index 9f8719fa..6ecd6f14 100644 --- a/src/test/java/com/namsor/sdk2/model/CorridorOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/CorridorOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FeedbackLoopOutTest.java b/src/test/java/com/namsor/sdk2/model/FeedbackLoopOutTest.java index d077e3a7..6120986d 100644 --- a/src/test/java/com/namsor/sdk2/model/FeedbackLoopOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/FeedbackLoopOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameCasteOutTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameCasteOutTest.java index 918805f6..dfa2a8ee 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameCasteOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameCasteOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameCastegroupOutTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameCastegroupOutTest.java index 71d004c3..b147fc88 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameCastegroupOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameCastegroupOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameDiasporaedOutTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameDiasporaedOutTest.java index 5c7a8672..67f4c009 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameDiasporaedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameDiasporaedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameGenderInTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameGenderInTest.java index 22fc8058..7dfd3134 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameGenderInTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameGenderInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameGenderedOutTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameGenderedOutTest.java index eb2be3bc..fe80e84d 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameGenderedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameGenderedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoInTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoInTest.java index 658385e6..d6f2bb72 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoInTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoOutTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoOutTest.java new file mode 100644 index 00000000..8816eda4 --- /dev/null +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoOutTest.java @@ -0,0 +1,171 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.ReligionStatOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + + +/** + * Model tests for FirstLastNameGeoOut + */ +public class FirstLastNameGeoOutTest { + private final FirstLastNameGeoOut model = new FirstLastNameGeoOut(); + + /** + * Model tests for FirstLastNameGeoOut + */ + @Test + public void testFirstLastNameGeoOut() { + // TODO: test FirstLastNameGeoOut + } + + /** + * Test the property 'script' + */ + @Test + public void scriptTest() { + // TODO: test script + } + + /** + * Test the property 'id' + */ + @Test + public void idTest() { + // TODO: test id + } + + /** + * Test the property 'explanation' + */ + @Test + public void explanationTest() { + // TODO: test explanation + } + + /** + * Test the property 'firstName' + */ + @Test + public void firstNameTest() { + // TODO: test firstName + } + + /** + * Test the property 'lastName' + */ + @Test + public void lastNameTest() { + // TODO: test lastName + } + + /** + * Test the property 'score' + */ + @Test + public void scoreTest() { + // TODO: test score + } + + /** + * Test the property 'country' + */ + @Test + public void countryTest() { + // TODO: test country + } + + /** + * Test the property 'countryAlt' + */ + @Test + public void countryAltTest() { + // TODO: test countryAlt + } + + /** + * Test the property 'region' + */ + @Test + public void regionTest() { + // TODO: test region + } + + /** + * Test the property 'topRegion' + */ + @Test + public void topRegionTest() { + // TODO: test topRegion + } + + /** + * Test the property 'subRegion' + */ + @Test + public void subRegionTest() { + // TODO: test subRegion + } + + /** + * Test the property 'countriesTop' + */ + @Test + public void countriesTopTest() { + // TODO: test countriesTop + } + + /** + * Test the property 'probabilityCalibrated' + */ + @Test + public void probabilityCalibratedTest() { + // TODO: test probabilityCalibrated + } + + /** + * Test the property 'probabilityAltCalibrated' + */ + @Test + public void probabilityAltCalibratedTest() { + // TODO: test probabilityAltCalibrated + } + + /** + * Test the property 'religionStats' + */ + @Test + public void religionStatsTest() { + // TODO: test religionStats + } + + /** + * Test the property 'religionStatsAlt' + */ + @Test + public void religionStatsAltTest() { + // TODO: test religionStatsAlt + } + +} diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoSubclassificationOutTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoSubclassificationOutTest.java index 1817fd6e..75bf28d2 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoSubclassificationOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoSubclassificationOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoSubdivisionInTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoSubdivisionInTest.java index 75613e8b..864e0192 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoSubdivisionInTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoSubdivisionInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoZippedInTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoZippedInTest.java index 78b65edf..abd37ad3 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoZippedInTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameGeoZippedInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameInTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameInTest.java index d74df3f9..4cda1e97 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameInTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameOriginedOutTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameOriginedOutTest.java index 20b8f114..12fe421a 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameOriginedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameOriginedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameOutTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameOutTest.java index badf6907..74270e54 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNamePhoneCodedOutTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNamePhoneCodedOutTest.java index 949c30da..020175d8 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNamePhoneCodedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNamePhoneCodedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberGeoInTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberGeoInTest.java index ccd37ab4..86c76286 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberGeoInTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberGeoInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberInTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberInTest.java index 7e7582a5..8e039ad5 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberInTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNamePhoneNumberInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameReligionedOutTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameReligionedOutTest.java index 5ada50d2..635f8e08 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameReligionedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameReligionedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameSubdivisionInTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameSubdivisionInTest.java index 15a6d9cf..ea8647f9 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameSubdivisionInTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameSubdivisionInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/FirstLastNameUSRaceEthnicityOutTest.java b/src/test/java/com/namsor/sdk2/model/FirstLastNameUSRaceEthnicityOutTest.java index 3b58f64f..1e9c3951 100644 --- a/src/test/java/com/namsor/sdk2/model/FirstLastNameUSRaceEthnicityOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/FirstLastNameUSRaceEthnicityOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/MatchPersonalFirstLastNameInTest.java b/src/test/java/com/namsor/sdk2/model/MatchPersonalFirstLastNameInTest.java index a5918fa8..737e9219 100644 --- a/src/test/java/com/namsor/sdk2/model/MatchPersonalFirstLastNameInTest.java +++ b/src/test/java/com/namsor/sdk2/model/MatchPersonalFirstLastNameInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/NameGeoInTest.java b/src/test/java/com/namsor/sdk2/model/NameGeoInTest.java index d490b6f9..82889aa4 100644 --- a/src/test/java/com/namsor/sdk2/model/NameGeoInTest.java +++ b/src/test/java/com/namsor/sdk2/model/NameGeoInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/NameInTest.java b/src/test/java/com/namsor/sdk2/model/NameInTest.java index 55129acb..9f0a2343 100644 --- a/src/test/java/com/namsor/sdk2/model/NameInTest.java +++ b/src/test/java/com/namsor/sdk2/model/NameInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/NameMatchCandidateOutTest.java b/src/test/java/com/namsor/sdk2/model/NameMatchCandidateOutTest.java index 870ef0bd..4160cc16 100644 --- a/src/test/java/com/namsor/sdk2/model/NameMatchCandidateOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/NameMatchCandidateOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/NameMatchCandidatesOutTest.java b/src/test/java/com/namsor/sdk2/model/NameMatchCandidatesOutTest.java index 08bbfd7a..96e94d21 100644 --- a/src/test/java/com/namsor/sdk2/model/NameMatchCandidatesOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/NameMatchCandidatesOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/NameMatchedOutTest.java b/src/test/java/com/namsor/sdk2/model/NameMatchedOutTest.java index 228352ce..1337ff2e 100644 --- a/src/test/java/com/namsor/sdk2/model/NameMatchedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/NameMatchedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/PersonalNameCastegroupOutTest.java b/src/test/java/com/namsor/sdk2/model/PersonalNameCastegroupOutTest.java index d6b94155..5867b4df 100644 --- a/src/test/java/com/namsor/sdk2/model/PersonalNameCastegroupOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/PersonalNameCastegroupOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/PersonalNameDiasporaedOutTest.java b/src/test/java/com/namsor/sdk2/model/PersonalNameDiasporaedOutTest.java new file mode 100644 index 00000000..fcb7722d --- /dev/null +++ b/src/test/java/com/namsor/sdk2/model/PersonalNameDiasporaedOutTest.java @@ -0,0 +1,155 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.ReligionStatOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + + +/** + * Model tests for PersonalNameDiasporaedOut + */ +public class PersonalNameDiasporaedOutTest { + private final PersonalNameDiasporaedOut model = new PersonalNameDiasporaedOut(); + + /** + * Model tests for PersonalNameDiasporaedOut + */ + @Test + public void testPersonalNameDiasporaedOut() { + // TODO: test PersonalNameDiasporaedOut + } + + /** + * Test the property 'script' + */ + @Test + public void scriptTest() { + // TODO: test script + } + + /** + * Test the property 'id' + */ + @Test + public void idTest() { + // TODO: test id + } + + /** + * Test the property 'explanation' + */ + @Test + public void explanationTest() { + // TODO: test explanation + } + + /** + * Test the property 'name' + */ + @Test + public void nameTest() { + // TODO: test name + } + + /** + * Test the property 'score' + */ + @Test + public void scoreTest() { + // TODO: test score + } + + /** + * Test the property 'ethnicityAlt' + */ + @Test + public void ethnicityAltTest() { + // TODO: test ethnicityAlt + } + + /** + * Test the property 'ethnicity' + */ + @Test + public void ethnicityTest() { + // TODO: test ethnicity + } + + /** + * Test the property 'lifted' + */ + @Test + public void liftedTest() { + // TODO: test lifted + } + + /** + * Test the property 'countryIso2' + */ + @Test + public void countryIso2Test() { + // TODO: test countryIso2 + } + + /** + * Test the property 'ethnicitiesTop' + */ + @Test + public void ethnicitiesTopTest() { + // TODO: test ethnicitiesTop + } + + /** + * Test the property 'probabilityCalibrated' + */ + @Test + public void probabilityCalibratedTest() { + // TODO: test probabilityCalibrated + } + + /** + * Test the property 'probabilityAltCalibrated' + */ + @Test + public void probabilityAltCalibratedTest() { + // TODO: test probabilityAltCalibrated + } + + /** + * Test the property 'religionStats' + */ + @Test + public void religionStatsTest() { + // TODO: test religionStats + } + + /** + * Test the property 'religionStatsAlt' + */ + @Test + public void religionStatsAltTest() { + // TODO: test religionStatsAlt + } + +} diff --git a/src/test/java/com/namsor/sdk2/model/PersonalNameGenderedOutTest.java b/src/test/java/com/namsor/sdk2/model/PersonalNameGenderedOutTest.java index d22e80ef..287d19a8 100644 --- a/src/test/java/com/namsor/sdk2/model/PersonalNameGenderedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/PersonalNameGenderedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/PersonalNameGeoInTest.java b/src/test/java/com/namsor/sdk2/model/PersonalNameGeoInTest.java index 804cb6cc..28a7c489 100644 --- a/src/test/java/com/namsor/sdk2/model/PersonalNameGeoInTest.java +++ b/src/test/java/com/namsor/sdk2/model/PersonalNameGeoInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/PersonalNameGeoOutTest.java b/src/test/java/com/namsor/sdk2/model/PersonalNameGeoOutTest.java index b4207905..899f1840 100644 --- a/src/test/java/com/namsor/sdk2/model/PersonalNameGeoOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/PersonalNameGeoOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/PersonalNameGeoSubclassificationOutTest.java b/src/test/java/com/namsor/sdk2/model/PersonalNameGeoSubclassificationOutTest.java index f9f0d14b..125fc275 100644 --- a/src/test/java/com/namsor/sdk2/model/PersonalNameGeoSubclassificationOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/PersonalNameGeoSubclassificationOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/PersonalNameGeoSubdivisionInTest.java b/src/test/java/com/namsor/sdk2/model/PersonalNameGeoSubdivisionInTest.java index dd5f2946..7641bb19 100644 --- a/src/test/java/com/namsor/sdk2/model/PersonalNameGeoSubdivisionInTest.java +++ b/src/test/java/com/namsor/sdk2/model/PersonalNameGeoSubdivisionInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/PersonalNameInTest.java b/src/test/java/com/namsor/sdk2/model/PersonalNameInTest.java index db696402..764973f7 100644 --- a/src/test/java/com/namsor/sdk2/model/PersonalNameInTest.java +++ b/src/test/java/com/namsor/sdk2/model/PersonalNameInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/PersonalNameOriginedOutTest.java b/src/test/java/com/namsor/sdk2/model/PersonalNameOriginedOutTest.java new file mode 100644 index 00000000..6c14a564 --- /dev/null +++ b/src/test/java/com/namsor/sdk2/model/PersonalNameOriginedOutTest.java @@ -0,0 +1,171 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.namsor.sdk2.model.ReligionStatOut; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + + +/** + * Model tests for PersonalNameOriginedOut + */ +public class PersonalNameOriginedOutTest { + private final PersonalNameOriginedOut model = new PersonalNameOriginedOut(); + + /** + * Model tests for PersonalNameOriginedOut + */ + @Test + public void testPersonalNameOriginedOut() { + // TODO: test PersonalNameOriginedOut + } + + /** + * Test the property 'script' + */ + @Test + public void scriptTest() { + // TODO: test script + } + + /** + * Test the property 'id' + */ + @Test + public void idTest() { + // TODO: test id + } + + /** + * Test the property 'explanation' + */ + @Test + public void explanationTest() { + // TODO: test explanation + } + + /** + * Test the property 'name' + */ + @Test + public void nameTest() { + // TODO: test name + } + + /** + * Test the property 'countryOrigin' + */ + @Test + public void countryOriginTest() { + // TODO: test countryOrigin + } + + /** + * Test the property 'countryOriginAlt' + */ + @Test + public void countryOriginAltTest() { + // TODO: test countryOriginAlt + } + + /** + * Test the property 'countriesOriginTop' + */ + @Test + public void countriesOriginTopTest() { + // TODO: test countriesOriginTop + } + + /** + * Test the property 'score' + */ + @Test + public void scoreTest() { + // TODO: test score + } + + /** + * Test the property 'regionOrigin' + */ + @Test + public void regionOriginTest() { + // TODO: test regionOrigin + } + + /** + * Test the property 'topRegionOrigin' + */ + @Test + public void topRegionOriginTest() { + // TODO: test topRegionOrigin + } + + /** + * Test the property 'subRegionOrigin' + */ + @Test + public void subRegionOriginTest() { + // TODO: test subRegionOrigin + } + + /** + * Test the property 'probabilityCalibrated' + */ + @Test + public void probabilityCalibratedTest() { + // TODO: test probabilityCalibrated + } + + /** + * Test the property 'probabilityAltCalibrated' + */ + @Test + public void probabilityAltCalibratedTest() { + // TODO: test probabilityAltCalibrated + } + + /** + * Test the property 'religionStats' + */ + @Test + public void religionStatsTest() { + // TODO: test religionStats + } + + /** + * Test the property 'religionStatsAlt' + */ + @Test + public void religionStatsAltTest() { + // TODO: test religionStatsAlt + } + + /** + * Test the property 'religionStatsSynthetic' + */ + @Test + public void religionStatsSyntheticTest() { + // TODO: test religionStatsSynthetic + } + +} diff --git a/src/test/java/com/namsor/sdk2/model/PersonalNameParsedOutTest.java b/src/test/java/com/namsor/sdk2/model/PersonalNameParsedOutTest.java index 7e7c287a..a4110165 100644 --- a/src/test/java/com/namsor/sdk2/model/PersonalNameParsedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/PersonalNameParsedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/PersonalNameReligionedOutTest.java b/src/test/java/com/namsor/sdk2/model/PersonalNameReligionedOutTest.java index f81da879..f2386f76 100644 --- a/src/test/java/com/namsor/sdk2/model/PersonalNameReligionedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/PersonalNameReligionedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/PersonalNameSubdivisionInTest.java b/src/test/java/com/namsor/sdk2/model/PersonalNameSubdivisionInTest.java index 346edc2c..57f67be0 100644 --- a/src/test/java/com/namsor/sdk2/model/PersonalNameSubdivisionInTest.java +++ b/src/test/java/com/namsor/sdk2/model/PersonalNameSubdivisionInTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/PersonalNameUSRaceEthnicityOutTest.java b/src/test/java/com/namsor/sdk2/model/PersonalNameUSRaceEthnicityOutTest.java new file mode 100644 index 00000000..9f18a2cc --- /dev/null +++ b/src/test/java/com/namsor/sdk2/model/PersonalNameUSRaceEthnicityOutTest.java @@ -0,0 +1,122 @@ +/* + * NamSor API v2 + * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! + * + * The version of the OpenAPI document: 2.0.29 + * Contact: contact@namsor.com + * + * 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.namsor.sdk2.model; + +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; + + +/** + * Model tests for PersonalNameUSRaceEthnicityOut + */ +public class PersonalNameUSRaceEthnicityOutTest { + private final PersonalNameUSRaceEthnicityOut model = new PersonalNameUSRaceEthnicityOut(); + + /** + * Model tests for PersonalNameUSRaceEthnicityOut + */ + @Test + public void testPersonalNameUSRaceEthnicityOut() { + // TODO: test PersonalNameUSRaceEthnicityOut + } + + /** + * Test the property 'script' + */ + @Test + public void scriptTest() { + // TODO: test script + } + + /** + * Test the property 'id' + */ + @Test + public void idTest() { + // TODO: test id + } + + /** + * Test the property 'explanation' + */ + @Test + public void explanationTest() { + // TODO: test explanation + } + + /** + * Test the property 'name' + */ + @Test + public void nameTest() { + // TODO: test name + } + + /** + * Test the property 'raceEthnicityAlt' + */ + @Test + public void raceEthnicityAltTest() { + // TODO: test raceEthnicityAlt + } + + /** + * Test the property 'raceEthnicity' + */ + @Test + public void raceEthnicityTest() { + // TODO: test raceEthnicity + } + + /** + * Test the property 'score' + */ + @Test + public void scoreTest() { + // TODO: test score + } + + /** + * Test the property 'raceEthnicitiesTop' + */ + @Test + public void raceEthnicitiesTopTest() { + // TODO: test raceEthnicitiesTop + } + + /** + * Test the property 'probabilityCalibrated' + */ + @Test + public void probabilityCalibratedTest() { + // TODO: test probabilityCalibrated + } + + /** + * Test the property 'probabilityAltCalibrated' + */ + @Test + public void probabilityAltCalibratedTest() { + // TODO: test probabilityAltCalibrated + } + +} diff --git a/src/test/java/com/namsor/sdk2/model/ProperNounCategorizedOutTest.java b/src/test/java/com/namsor/sdk2/model/ProperNounCategorizedOutTest.java index 4c4dc856..b7546482 100644 --- a/src/test/java/com/namsor/sdk2/model/ProperNounCategorizedOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/ProperNounCategorizedOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/RegionISOTest.java b/src/test/java/com/namsor/sdk2/model/RegionISOTest.java index 42d77d3b..9cedec6f 100644 --- a/src/test/java/com/namsor/sdk2/model/RegionISOTest.java +++ b/src/test/java/com/namsor/sdk2/model/RegionISOTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/RegionOutTest.java b/src/test/java/com/namsor/sdk2/model/RegionOutTest.java index 19c35236..d3122ee6 100644 --- a/src/test/java/com/namsor/sdk2/model/RegionOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/RegionOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/ReligionStatOutTest.java b/src/test/java/com/namsor/sdk2/model/ReligionStatOutTest.java index 8c9ea242..52220009 100644 --- a/src/test/java/com/namsor/sdk2/model/ReligionStatOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/ReligionStatOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/test/java/com/namsor/sdk2/model/SoftwareVersionOutTest.java b/src/test/java/com/namsor/sdk2/model/SoftwareVersionOutTest.java index b625b4bd..f2f2e60d 100644 --- a/src/test/java/com/namsor/sdk2/model/SoftwareVersionOutTest.java +++ b/src/test/java/com/namsor/sdk2/model/SoftwareVersionOutTest.java @@ -2,7 +2,7 @@ * NamSor API v2 * NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! * - * The version of the OpenAPI document: 2.0.27 + * The version of the OpenAPI document: 2.0.29 * Contact: contact@namsor.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).