NamSorAPIv2_0_26B01

namsor · Jun 19, 2023 · b56cd39 · b56cd39
1 parent 8b3893e
commit b56cd39
Show file tree

Hide file tree

Showing 690 changed files with 8,382 additions and 10,477 deletions.
diff --git a/README.md b/README.md
diff --git a/build.gradle b/build.gradle
@@ -2,7 +2,7 @@ apply plugin: 'idea'
 apply plugin: 'eclipse'
 
 group = 'com.namsor'
-version = '2.0.16'
+version = '2.0.26'
 
 buildscript {
     repositories {

diff --git 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.16",
+    version := "2.0.26",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

diff --git a/docs/APIClassifierTaxonomyOut.md b/docs/APIClassifierTaxonomyOut.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **classifierName** | **String** | Name of the classifier as per apiStatus (corresponds also to the name of the service in apiServices) |  [optional]
 **taxonomyClasses** | **List&lt;String&gt;** | The taxonomy classes this classifier classifies to |  [optional]
+**classifyingScripts** | **List&lt;String&gt;** | The scripts / alphabets this classifiers classifies to |  [optional]
 
 
 
diff --git a/docs/APICounterV2Out.md b/docs/APICounterV2Out.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **apiKey** | [**APIKeyOut**](APIKeyOut.md) |  |  [optional]
 **apiService** | **String** | The apiService corresponds to the classifier name. |  [optional]
+**hostAddress** | **String** | The processing hostAddress. |  [optional]
 **createdDateTime** | **Long** | The create datetime of the counter. |  [optional]
 **totalUsage** | **Long** | The usage of the counter. |  [optional]
 **lastFlushedDateTime** | **Long** | The flush datetime of the counter. |  [optional]

diff --git a/docs/APIKeyOut.md b/docs/APIKeyOut.md
@@ -14,6 +14,8 @@ Name | Type | Description | Notes
 **striped** | **Boolean** | The API Key is associated to a valid Stripe account. |  [optional]
 **corporate** | **Boolean** | The API Key has role corporate (ex SWIFT payments instead of Stripe payments). |  [optional]
 **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]
 
 
 
diff --git a/docs/APIPlanOut.md b/docs/APIPlanOut.md
diff --git a/docs/APIPlansOut.md b/docs/APIPlansOut.md
diff --git a/docs/AdminApi.md b/docs/AdminApi.md
@@ -5,22 +5,21 @@ 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.
+[**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.
 [**apiUsageHistory**](AdminApi.md#apiUsageHistory) | **GET** /api2/json/apiUsageHistory | Print historical API usage.
 [**apiUsageHistoryAggregate**](AdminApi.md#apiUsageHistoryAggregate) | **GET** /api2/json/apiUsageHistoryAggregate | Print historical API usage (in an aggregated view, by service, by day/hour/min).
 [**availableServices**](AdminApi.md#availableServices) | **GET** /api2/json/apiServices | List of classification services and usage cost in Units per classification (default is 1&#x3D;ONE Unit). Some API endpoints (ex. Corridor) combine multiple classifiers.
-[**disable**](AdminApi.md#disable) | **GET** /api2/json/disable/{source}/{disabled} | Activate/deactivate an API Key.
-[**learnable**](AdminApi.md#learnable) | **GET** /api2/json/learnable/{source}/{learnable} | Activate/deactivate learning from a source.
-[**learnable1**](AdminApi.md#learnable1) | **GET** /api2/json/learnable/{source}/{learnable}/{token} | Activate/deactivate learning from a source.
+[**learnable**](AdminApi.md#learnable) | **GET** /api2/json/learnable/{source}/{learnable}/{token} | Activate/deactivate learning from a source.
+[**regions**](AdminApi.md#regions) | **GET** /api2/json/regions | Print basic source statistics.
 [**softwareVersion**](AdminApi.md#softwareVersion) | **GET** /api2/json/softwareVersion | Get the current software version
 [**taxonomyClasses**](AdminApi.md#taxonomyClasses) | **GET** /api2/json/taxonomyClasses/{classifierName} | Print the taxonomy classes valid for the given classifier.
 
 
 <a name="anonymize"></a>
 # **anonymize**
-> anonymize(source, anonymized, token)
+> APIKeyOut anonymize(source, anonymized, token)
 
 Activate/deactivate anonymization for a source.
 
@@ -46,7 +45,8 @@ String source = "source_example"; // String |
 Boolean anonymized = true; // Boolean | 
 String token = "token_example"; // String | 
 try {
-    apiInstance.anonymize(source, anonymized, token);
+    APIKeyOut result = apiInstance.anonymize(source, anonymized, token);
+    System.out.println(result);
 } catch (ApiException e) {
     System.err.println("Exception when calling AdminApi#anonymize");
     e.printStackTrace();
@@ -63,7 +63,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-null (empty response body)
+[**APIKeyOut**](APIKeyOut.md)
 
 ### Authorization
 
@@ -72,13 +72,13 @@ null (empty response body)
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Accept**: application/json
 
-<a name="anonymize1"></a>
-# **anonymize1**
-> anonymize1(source, anonymized)
+<a name="apiKeyInfo"></a>
+# **apiKeyInfo**
+> APIKeyOut apiKeyInfo()
 
-Activate/deactivate anonymization for a source.
+Read API Key info.
 
 ### Example
 ```java
@@ -98,26 +98,21 @@ api_key.setApiKey("YOUR API KEY");
 //api_key.setApiKeyPrefix("Token");
 
 AdminApi apiInstance = new AdminApi();
-String source = "source_example"; // String | 
-Boolean anonymized = true; // Boolean | 
 try {
-    apiInstance.anonymize1(source, anonymized);
+    APIKeyOut result = apiInstance.apiKeyInfo();
+    System.out.println(result);
 } catch (ApiException e) {
-    System.err.println("Exception when calling AdminApi#anonymize1");
+    System.err.println("Exception when calling AdminApi#apiKeyInfo");
     e.printStackTrace();
 }
 ```
 
 ### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **source** | **String**|  |
- **anonymized** | **Boolean**|  |
+This endpoint does not need any parameter.
 
 ### Return type
 
-null (empty response body)
+[**APIKeyOut**](APIKeyOut.md)
 
 ### Authorization
 
@@ -126,7 +121,7 @@ null (empty response body)
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Accept**: application/json
 
 <a name="apiStatus"></a>
 # **apiStatus**
@@ -373,63 +368,9 @@ This endpoint does not need any parameter.
  - **Content-Type**: Not defined
  - **Accept**: application/json
 
-<a name="disable"></a>
-# **disable**
-> disable(source, disabled)
-
-Activate/deactivate an API Key.
-
-### Example
-```java
-// Import classes:
-//import com.namsor.sdk2.invoke.ApiClient;
-//import com.namsor.sdk2.invoke.ApiException;
-//import com.namsor.sdk2.invoke.Configuration;
-//import com.namsor.sdk2.invoke.auth.*;
-//import com.namsor.sdk2.api.AdminApi;
-
-ApiClient defaultClient = Configuration.getDefaultApiClient();
-
-// Configure API key authorization: api_key
-ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
-api_key.setApiKey("YOUR API KEY");
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.setApiKeyPrefix("Token");
-
-AdminApi apiInstance = new AdminApi();
-String source = "source_example"; // String | The API Key to set as enabled/disabled.
-Boolean disabled = true; // Boolean | 
-try {
-    apiInstance.disable(source, disabled);
-} catch (ApiException e) {
-    System.err.println("Exception when calling AdminApi#disable");
-    e.printStackTrace();
-}
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **source** | **String**| The API Key to set as enabled/disabled. |
- **disabled** | **Boolean**|  |
-
-### Return type
-
-null (empty response body)
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
 <a name="learnable"></a>
 # **learnable**
-> learnable(source, learnable)
+> APIKeyOut learnable(source, learnable, token)
 
 Activate/deactivate learning from a source.
 
@@ -453,8 +394,10 @@ api_key.setApiKey("YOUR API KEY");
 AdminApi apiInstance = new AdminApi();
 String source = "source_example"; // String | The API Key to set as learnable/non learnable.
 Boolean learnable = true; // Boolean | 
+String token = "token_example"; // String | 
 try {
-    apiInstance.learnable(source, learnable);
+    APIKeyOut result = apiInstance.learnable(source, learnable, token);
+    System.out.println(result);
 } catch (ApiException e) {
     System.err.println("Exception when calling AdminApi#learnable");
     e.printStackTrace();
@@ -467,10 +410,11 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **source** | **String**| The API Key to set as learnable/non learnable. |
  **learnable** | **Boolean**|  |
+ **token** | **String**|  |
 
 ### Return type
 
-null (empty response body)
+[**APIKeyOut**](APIKeyOut.md)
 
 ### Authorization
 
@@ -479,13 +423,13 @@ null (empty response body)
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Accept**: application/json
 
-<a name="learnable1"></a>
-# **learnable1**
-> learnable1(source, learnable, token)
+<a name="regions"></a>
+# **regions**
+> RegionOut regions()
 
-Activate/deactivate learning from a source.
+Print basic source statistics.
 
 ### Example
 ```java
@@ -505,28 +449,21 @@ api_key.setApiKey("YOUR API KEY");
 //api_key.setApiKeyPrefix("Token");
 
 AdminApi apiInstance = new AdminApi();
-String source = "source_example"; // String | The API Key to set as learnable/non learnable.
-Boolean learnable = true; // Boolean | 
-String token = "token_example"; // String | 
 try {
-    apiInstance.learnable1(source, learnable, token);
+    RegionOut result = apiInstance.regions();
+    System.out.println(result);
 } catch (ApiException e) {
-    System.err.println("Exception when calling AdminApi#learnable1");
+    System.err.println("Exception when calling AdminApi#regions");
     e.printStackTrace();
 }
 ```
 
 ### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **source** | **String**| The API Key to set as learnable/non learnable. |
- **learnable** | **Boolean**|  |
- **token** | **String**|  |
+This endpoint does not need any parameter.
 
 ### Return type
 
-null (empty response body)
+[**RegionOut**](RegionOut.md)
 
 ### Authorization
 
@@ -535,7 +472,7 @@ null (empty response body)
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Accept**: application/json
 
 <a name="softwareVersion"></a>
 # **softwareVersion**

diff --git a/docs/BatchCorridorIn.md b/docs/BatchCorridorIn.md
@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **corridorFromTo** | [**List&lt;CorridorIn&gt;**](CorridorIn.md) |  |  [optional]
+**facts** | [**List&lt;FactIn&gt;**](FactIn.md) |  |  [optional]
 
 
 
diff --git a/docs/BatchFirstLastNameGenderIn.md b/docs/BatchFirstLastNameGenderIn.md
@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personalNames** | [**List&lt;FirstLastNameGenderIn&gt;**](FirstLastNameGenderIn.md) |  |  [optional]
+**facts** | [**List&lt;FactIn&gt;**](FactIn.md) |  |  [optional]
 
 
 
diff --git a/docs/BatchFirstLastNameGeoIn.md b/docs/BatchFirstLastNameGeoIn.md
@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personalNames** | [**List&lt;FirstLastNameGeoIn&gt;**](FirstLastNameGeoIn.md) |  |  [optional]
+**facts** | [**List&lt;FactIn&gt;**](FactIn.md) |  |  [optional]
 
 
 
diff --git a/docs/BatchFirstLastNameGeoZippedIn.md b/docs/BatchFirstLastNameGeoZippedIn.md
@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personalNames** | [**List&lt;FirstLastNameGeoZippedIn&gt;**](FirstLastNameGeoZippedIn.md) |  |  [optional]
+**facts** | [**List&lt;FactIn&gt;**](FactIn.md) |  |  [optional]
 
 
 
diff --git a/docs/BatchFirstLastNameIn.md b/docs/BatchFirstLastNameIn.md
@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personalNames** | [**List&lt;FirstLastNameIn&gt;**](FirstLastNameIn.md) |  |  [optional]
+**facts** | [**List&lt;FactIn&gt;**](FactIn.md) |  |  [optional]
 
 
 
diff --git a/docs/BatchFirstLastNamePhoneNumberGeoIn.md b/docs/BatchFirstLastNamePhoneNumberGeoIn.md
@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personalNamesWithPhoneNumbers** | [**List&lt;FirstLastNamePhoneNumberGeoIn&gt;**](FirstLastNamePhoneNumberGeoIn.md) |  |  [optional]
+**facts** | [**List&lt;FactIn&gt;**](FactIn.md) |  |  [optional]
 
 
 
diff --git a/docs/BatchFirstLastNamePhoneNumberIn.md b/docs/BatchFirstLastNamePhoneNumberIn.md
@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personalNamesWithPhoneNumbers** | [**List&lt;FirstLastNamePhoneNumberIn&gt;**](FirstLastNamePhoneNumberIn.md) |  |  [optional]
+**facts** | [**List&lt;FactIn&gt;**](FactIn.md) |  |  [optional]
 
 
 
diff --git a/docs/BatchMatchPersonalFirstLastNameIn.md b/docs/BatchMatchPersonalFirstLastNameIn.md
@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personalNames** | [**List&lt;MatchPersonalFirstLastNameIn&gt;**](MatchPersonalFirstLastNameIn.md) |  |  [optional]
+**facts** | [**List&lt;FactIn&gt;**](FactIn.md) |  |  [optional]