NamSorAPÏv2.0.26B01

namsor · Jun 19, 2023 · 2d38dbb · 2d38dbb
1 parent c1ccc87
commit 2d38dbb
Show file tree

Hide file tree

Showing 280 changed files with 6,246 additions and 7,665 deletions.
diff --git a/docs/APICounterV2Out.md b/docs/APICounterV2Out.md
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **api_key** | [**APIKeyOut**](APIKeyOut.md) |  | [optional] 
 **api_service** | **str** | The apiService corresponds to the classifier name. | [optional] 
+**host_address** | **str** | The processing hostAddress. | [optional] 
 **created_date_time** | **int** | The create datetime of the counter. | [optional] 
 **total_usage** | **int** | The usage of the counter. | [optional] 
 **last_flushed_date_time** | **int** | The flush datetime of the counter. | [optional] 

diff --git a/docs/APIKeyOut.md b/docs/APIKeyOut.md
@@ -13,6 +13,8 @@ Name | Type | Description | Notes
 **striped** | **bool** | The API Key is associated to a valid Stripe account. | [optional] 
 **corporate** | **bool** | The API Key has role corporate (ex SWIFT payments instead of Stripe payments). | [optional] 
 **disabled** | **bool** | The API Key is temporarily or permanently disabled. | [optional] 
+**explainable** | **bool** | The API Key supports the AI explainability option (may require a specific license). | [optional] 
+**ip_address** | **str** |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/APIPlansOut.md b/docs/APIPlansOut.md
diff --git a/docs/AdminApi.md b/docs/AdminApi.md
@@ -5,16 +5,14 @@ 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.
 [**api_key_info**](AdminApi.md#api_key_info) | **GET** /api2/json/apiKeyInfo | Read API Key info.
 [**api_status**](AdminApi.md#api_status) | **GET** /api2/json/apiStatus | Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices.
 [**api_usage**](AdminApi.md#api_usage) | **GET** /api2/json/apiUsage | Print current API usage.
 [**api_usage_history**](AdminApi.md#api_usage_history) | **GET** /api2/json/apiUsageHistory | Print historical API usage.
 [**api_usage_history_aggregate**](AdminApi.md#api_usage_history_aggregate) | **GET** /api2/json/apiUsageHistoryAggregate | Print historical API usage (in an aggregated view, by service, by day/hour/min).
 [**available_services**](AdminApi.md#available_services) | **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.
 [**software_version**](AdminApi.md#software_version) | **GET** /api2/json/softwareVersion | Get the current software version
 [**taxonomy_classes**](AdminApi.md#taxonomy_classes) | **GET** /api2/json/taxonomyClasses/{classifierName} | Print the taxonomy classes valid for the given classifier.
 
@@ -77,61 +75,6 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **anonymize1**
-> anonymize1(source, anonymized)
-
-Activate/deactivate anonymization for a source.
-
-### Example
-
-* Api Key Authentication (api_key): 
-```python
-from __future__ import print_function
-import time
-import openapi_client
-from openapi_client.rest import ApiException
-from pprint import pprint
-
-# Configure API key authorization: api_key
-configuration = openapi_client.Configuration()
-configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
-
-# create an instance of the API class
-api_instance = openapi_client.AdminApi(openapi_client.ApiClient(configuration))
-source = 'source_example' # str | 
-anonymized = True # bool | 
-
-try:
-    # Activate/deactivate anonymization for a source.
-    api_instance.anonymize1(source, anonymized)
-except ApiException as e:
-    print("Exception when calling AdminApi->anonymize1: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **source** | **str**|  | 
- **anonymized** | **bool**|  | 
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
 # **api_key_info**
 > APIKeyOut api_key_info()
 
@@ -432,63 +375,8 @@ This endpoint does not need any parameter.
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **disable**
-> disable(source, disabled)
-
-Activate/deactivate an API Key.
-
-### Example
-
-* Api Key Authentication (api_key): 
-```python
-from __future__ import print_function
-import time
-import openapi_client
-from openapi_client.rest import ApiException
-from pprint import pprint
-
-# Configure API key authorization: api_key
-configuration = openapi_client.Configuration()
-configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
-
-# create an instance of the API class
-api_instance = openapi_client.AdminApi(openapi_client.ApiClient(configuration))
-source = 'source_example' # str | The API Key to set as enabled/disabled.
-disabled = True # bool | 
-
-try:
-    # Activate/deactivate an API Key.
-    api_instance.disable(source, disabled)
-except ApiException as e:
-    print("Exception when calling AdminApi->disable: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **source** | **str**| The API Key to set as enabled/disabled. | 
- **disabled** | **bool**|  | 
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
 # **learnable**
-> learnable(source, learnable)
+> APIKeyOut learnable(source, learnable, token)
 
 Activate/deactivate learning from a source.
 
@@ -512,10 +400,12 @@ configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
 api_instance = openapi_client.AdminApi(openapi_client.ApiClient(configuration))
 source = 'source_example' # str | The API Key to set as learnable/non learnable.
 learnable = True # bool | 
+token = 'token_example' # str | 
 
 try:
     # Activate/deactivate learning from a source.
-    api_instance.learnable(source, learnable)
+    api_response = api_instance.learnable(source, learnable, token)
+    pprint(api_response)
 except ApiException as e:
     print("Exception when calling AdminApi->learnable: %s\n" % e)
 ```
@@ -526,10 +416,11 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **source** | **str**| The API Key to set as learnable/non learnable. | 
  **learnable** | **bool**|  | 
+ **token** | **str**|  | 
 
 ### Return type
 
-void (empty response body)
+[**APIKeyOut**](APIKeyOut.md)
 
 ### Authorization
 
@@ -538,14 +429,14 @@ void (empty response body)
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Accept**: application/json
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **learnable1**
-> APIKeyOut learnable1(source, learnable, token)
+# **regions**
+> RegionOut regions()
 
-Activate/deactivate learning from a source.
+Print basic source statistics.
 
 ### Example
 
@@ -565,29 +456,21 @@ configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
 
 # create an instance of the API class
 api_instance = openapi_client.AdminApi(openapi_client.ApiClient(configuration))
-source = 'source_example' # str | The API Key to set as learnable/non learnable.
-learnable = True # bool | 
-token = 'token_example' # str | 
 
 try:
-    # Activate/deactivate learning from a source.
-    api_response = api_instance.learnable1(source, learnable, token)
+    # Print basic source statistics.
+    api_response = api_instance.regions()
     pprint(api_response)
 except ApiException as e:
-    print("Exception when calling AdminApi->learnable1: %s\n" % e)
+    print("Exception when calling AdminApi->regions: %s\n" % e)
 ```
 
 ### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **source** | **str**| The API Key to set as learnable/non learnable. | 
- **learnable** | **bool**|  | 
- **token** | **str**|  | 
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**APIKeyOut**](APIKeyOut.md)
+[**RegionOut**](RegionOut.md)
 
 ### Authorization
 

diff --git a/docs/BatchCorridorIn.md b/docs/BatchCorridorIn.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **corridor_from_to** | [**list[CorridorIn]**](CorridorIn.md) |  | [optional] 
+**facts** | [**list[FactIn]**](FactIn.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/BatchFirstLastNameGenderIn.md b/docs/BatchFirstLastNameGenderIn.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personal_names** | [**list[FirstLastNameGenderIn]**](FirstLastNameGenderIn.md) |  | [optional] 
+**facts** | [**list[FactIn]**](FactIn.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/BatchFirstLastNameGeoIn.md b/docs/BatchFirstLastNameGeoIn.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personal_names** | [**list[FirstLastNameGeoIn]**](FirstLastNameGeoIn.md) |  | [optional] 
+**facts** | [**list[FactIn]**](FactIn.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/BatchFirstLastNameGeoZippedIn.md b/docs/BatchFirstLastNameGeoZippedIn.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personal_names** | [**list[FirstLastNameGeoZippedIn]**](FirstLastNameGeoZippedIn.md) |  | [optional] 
+**facts** | [**list[FactIn]**](FactIn.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/BatchFirstLastNameIn.md b/docs/BatchFirstLastNameIn.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personal_names** | [**list[FirstLastNameIn]**](FirstLastNameIn.md) |  | [optional] 
+**facts** | [**list[FactIn]**](FactIn.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/BatchFirstLastNamePhoneNumberGeoIn.md b/docs/BatchFirstLastNamePhoneNumberGeoIn.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personal_names_with_phone_numbers** | [**list[FirstLastNamePhoneNumberGeoIn]**](FirstLastNamePhoneNumberGeoIn.md) |  | [optional] 
+**facts** | [**list[FactIn]**](FactIn.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/BatchFirstLastNamePhoneNumberIn.md b/docs/BatchFirstLastNamePhoneNumberIn.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personal_names_with_phone_numbers** | [**list[FirstLastNamePhoneNumberIn]**](FirstLastNamePhoneNumberIn.md) |  | [optional] 
+**facts** | [**list[FactIn]**](FactIn.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/BatchMatchPersonalFirstLastNameIn.md b/docs/BatchMatchPersonalFirstLastNameIn.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personal_names** | [**list[MatchPersonalFirstLastNameIn]**](MatchPersonalFirstLastNameIn.md) |  | [optional] 
+**facts** | [**list[FactIn]**](FactIn.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/BatchNameGeoIn.md b/docs/BatchNameGeoIn.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **proper_nouns** | [**list[NameGeoIn]**](NameGeoIn.md) |  | [optional] 
+**facts** | [**list[FactIn]**](FactIn.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/BatchNameIn.md b/docs/BatchNameIn.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **proper_nouns** | [**list[NameIn]**](NameIn.md) |  | [optional] 
+**facts** | [**list[FactIn]**](FactIn.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/BatchPersonalNameCastegroupOut.md b/docs/BatchPersonalNameCastegroupOut.md
@@ -0,0 +1,10 @@
+# BatchPersonalNameCastegroupOut
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**personal_names** | [**list[PersonalNameCastegroupOut]**](PersonalNameCastegroupOut.md) | Caste group-coded names | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/BatchPersonalNameGeoIn.md b/docs/BatchPersonalNameGeoIn.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personal_names** | [**list[PersonalNameGeoIn]**](PersonalNameGeoIn.md) |  | [optional] 
+**facts** | [**list[FactIn]**](FactIn.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/BatchPersonalNameGeoSubclassificationOut.md b/docs/BatchPersonalNameGeoSubclassificationOut.md
@@ -0,0 +1,10 @@
+# BatchPersonalNameGeoSubclassificationOut
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**personal_names** | [**list[PersonalNameGeoSubclassificationOut]**](PersonalNameGeoSubclassificationOut.md) | Classified names at sub country level (region or state) | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/BillingHistoryOut.md → docs/BatchPersonalNameGeoSubdivisionIn.md b/docs/BillingHistoryOut.md → docs/BatchPersonalNameGeoSubdivisionIn.md
@@ -1,10 +1,10 @@
-# BillingHistoryOut
+# BatchPersonalNameGeoSubdivisionIn
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**stripe_invoices** | [**list[InvoiceOut]**](InvoiceOut.md) |  | [optional] 
-**corporate_invoices** | [**list[InvoiceOut]**](InvoiceOut.md) |  | [optional] 
+**personal_names** | [**list[PersonalNameGeoSubdivisionIn]**](PersonalNameGeoSubdivisionIn.md) |  | [optional] 
+**facts** | [**list[FactIn]**](FactIn.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/BatchPersonalNameIn.md b/docs/BatchPersonalNameIn.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **personal_names** | [**list[PersonalNameIn]**](PersonalNameIn.md) |  | [optional] 
+**facts** | [**list[FactIn]**](FactIn.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)