Minor update

README.md

@@ -3,7 +3,7 @@ NamSor API v2 : enpoints to process personal names (gender, cultural origin or e
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 2.0.6
+- API version: 2.0.7
 - Package version: 1.0.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [http://www.namsor.com/](http://www.namsor.com/)
@@ -81,11 +81,12 @@ Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *AdminApi* | [**add_credits**](docs/AdminApi.md#add_credits) | **GET** /api2/json/addCredits/{apiKey}/{usageCredits}/{userMessage} | Add usage credits to an API Key.
 *AdminApi* | [**anonymize**](docs/AdminApi.md#anonymize) | **GET** /api2/json/anonymize/{source}/{anonymized} | Activate/deactivate anonymization for a source.
+*AdminApi* | [**api_status**](docs/AdminApi.md#api_status) | **GET** /api2/json/apiStatus | Prints the current status of the classifiers.
 *AdminApi* | [**api_usage**](docs/AdminApi.md#api_usage) | **GET** /api2/json/apiUsage | Print current API usage.
 *AdminApi* | [**api_usage_history**](docs/AdminApi.md#api_usage_history) | **GET** /api2/json/apiUsageHistory | Print historical API usage.
 *AdminApi* | [**api_usage_history_aggregate**](docs/AdminApi.md#api_usage_history_aggregate) | **GET** /api2/json/apiUsageHistoryAggregate | Print historical API usage (in an aggregated view, by service, by day/hour/min).
-*AdminApi* | [**available_plans**](docs/AdminApi.md#available_plans) | **GET** /api2/json/availablePlans | List all available plans in the default currency (usd).
-*AdminApi* | [**available_plans1**](docs/AdminApi.md#available_plans1) | **GET** /api2/json/availablePlans/{token} | List all available plans in the user's preferred currency.
+*AdminApi* | [**available_plans**](docs/AdminApi.md#available_plans) | **GET** /api2/json/availablePlans/{token} | List all available plans in the user's preferred currency.
+*AdminApi* | [**available_plans1**](docs/AdminApi.md#available_plans1) | **GET** /api2/json/availablePlans | List all available plans in the default currency (usd).
 *AdminApi* | [**available_services**](docs/AdminApi.md#available_services) | **GET** /api2/json/apiServices | List of API services and usage cost in Units (default is 1=ONE Unit).
 *AdminApi* | [**billing_currencies**](docs/AdminApi.md#billing_currencies) | **GET** /api2/json/billingCurrencies | List possible currency options for billing (USD, EUR, GBP, ...)
 *AdminApi* | [**billing_history**](docs/AdminApi.md#billing_history) | **GET** /api2/json/billingHistory/{token} | Read the history billing information (invoices paid via Stripe or manually).
@@ -110,6 +111,7 @@ Class | Method | HTTP request | Description
 *AdminApi* | [**stripe_connect**](docs/AdminApi.md#stripe_connect) | **GET** /api2/json/stripeConnect | Connects a Stripe Account.
 *AdminApi* | [**subscribe_plan**](docs/AdminApi.md#subscribe_plan) | **GET** /api2/json/subscribePlan/{planName}/{token} | Subscribe to a give API plan, using the user's preferred or default currency.
 *AdminApi* | [**subscribe_plan_on_behalf**](docs/AdminApi.md#subscribe_plan_on_behalf) | **GET** /api2/json/subscribePlanOnBehalf/{planName}/{apiKey} | Subscribe to a give API plan, using the user's preferred or default currency (admin only).
+*AdminApi* | [**taxonomy_classes**](docs/AdminApi.md#taxonomy_classes) | **GET** /api2/json/taxonomyClasses/{classifierName} | Print the taxonomy classes valid for the given classifier.
 *AdminApi* | [**update_billing_info**](docs/AdminApi.md#update_billing_info) | **POST** /api2/json/updateBillingInfo/{token} | Sets or update the billing information (company name, address, phone, vat ID)
 *AdminApi* | [**update_limit**](docs/AdminApi.md#update_limit) | **GET** /api2/json/updateLimit/{usageLimit}/{hardOrSoft}/{token} | Modifies the hard/soft limit on the API plan's overages (default is 0$ soft limit).
 *AdminApi* | [**update_payment_default**](docs/AdminApi.md#update_payment_default) | **GET** /api2/json/updatePaymentDefault/{defautSourceId}/{token} | Update the default Stripe card associated with the current google auth session token.
@@ -165,6 +167,9 @@ Class | Method | HTTP request | Description
 ## Documentation For Models
 
  - [APIBillingPeriodUsageOut](docs/APIBillingPeriodUsageOut.md)
+ - [APIClassifierOut](docs/APIClassifierOut.md)
+ - [APIClassifierTaxonomyOut](docs/APIClassifierTaxonomyOut.md)
+ - [APIClassifiersStatusOut](docs/APIClassifiersStatusOut.md)
  - [APICounterV2Out](docs/APICounterV2Out.md)
  - [APIKeyOut](docs/APIKeyOut.md)
  - [APIPeriodUsageOut](docs/APIPeriodUsageOut.md)

docs/APIClassifierOut.md

@@ -0,0 +1,14 @@
+# APIClassifierOut
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**classifier_name** | **str** |  | [optional] 
+**serving** | **bool** |  | [optional] 
+**learning** | **bool** |  | [optional] 
+**shutting_down** | **bool** |  | [optional] 
+**probability_calibrated** | **bool** |  | [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)
+
+

docs/APIClassifierTaxonomyOut.md

@@ -0,0 +1,11 @@
+# APIClassifierTaxonomyOut
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**classifier_name** | **str** |  | [optional] 
+**taxonomy_classes** | **list[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)
+
+

docs/APIClassifiersStatusOut.md

@@ -0,0 +1,11 @@
+# APIClassifiersStatusOut
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**software_version** | [**SoftwareVersionOut**](SoftwareVersionOut.md) |  | [optional] 
+**classifiers** | [**list[APIClassifierOut]**](APIClassifierOut.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)
+
+

docs/AdminApi.md

@@ -6,11 +6,12 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**add_credits**](AdminApi.md#add_credits) | **GET** /api2/json/addCredits/{apiKey}/{usageCredits}/{userMessage} | Add usage credits to an API Key.
 [**anonymize**](AdminApi.md#anonymize) | **GET** /api2/json/anonymize/{source}/{anonymized} | Activate/deactivate anonymization for a source.
+[**api_status**](AdminApi.md#api_status) | **GET** /api2/json/apiStatus | Prints the current status of the classifiers.
 [**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_plans**](AdminApi.md#available_plans) | **GET** /api2/json/availablePlans | List all available plans in the default currency (usd).
-[**available_plans1**](AdminApi.md#available_plans1) | **GET** /api2/json/availablePlans/{token} | List all available plans in the user's preferred currency.
+[**available_plans**](AdminApi.md#available_plans) | **GET** /api2/json/availablePlans/{token} | List all available plans in the user's preferred currency.
+[**available_plans1**](AdminApi.md#available_plans1) | **GET** /api2/json/availablePlans | List all available plans in the default currency (usd).
 [**available_services**](AdminApi.md#available_services) | **GET** /api2/json/apiServices | List of API services and usage cost in Units (default is 1=ONE Unit).
 [**billing_currencies**](AdminApi.md#billing_currencies) | **GET** /api2/json/billingCurrencies | List possible currency options for billing (USD, EUR, GBP, ...)
 [**billing_history**](AdminApi.md#billing_history) | **GET** /api2/json/billingHistory/{token} | Read the history billing information (invoices paid via Stripe or manually).
@@ -35,6 +36,7 @@ Method | HTTP request | Description
 [**stripe_connect**](AdminApi.md#stripe_connect) | **GET** /api2/json/stripeConnect | Connects a Stripe Account.
 [**subscribe_plan**](AdminApi.md#subscribe_plan) | **GET** /api2/json/subscribePlan/{planName}/{token} | Subscribe to a give API plan, using the user's preferred or default currency.
 [**subscribe_plan_on_behalf**](AdminApi.md#subscribe_plan_on_behalf) | **GET** /api2/json/subscribePlanOnBehalf/{planName}/{apiKey} | Subscribe to a give API plan, using the user's preferred or default currency (admin only).
+[**taxonomy_classes**](AdminApi.md#taxonomy_classes) | **GET** /api2/json/taxonomyClasses/{classifierName} | Print the taxonomy classes valid for the given classifier.
 [**update_billing_info**](AdminApi.md#update_billing_info) | **POST** /api2/json/updateBillingInfo/{token} | Sets or update the billing information (company name, address, phone, vat ID)
 [**update_limit**](AdminApi.md#update_limit) | **GET** /api2/json/updateLimit/{usageLimit}/{hardOrSoft}/{token} | Modifies the hard/soft limit on the API plan's overages (default is 0$ soft limit).
 [**update_payment_default**](AdminApi.md#update_payment_default) | **GET** /api2/json/updatePaymentDefault/{defautSourceId}/{token} | Update the default Stripe card associated with the current google auth session token.
@@ -157,6 +159,56 @@ void (empty response body)
 
 [[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_status**
+> APIPlansOut api_status()
+
+Prints the current status of the classifiers.
+
+### 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))
+
+try:
+    # Prints the current status of the classifiers.
+    api_response = api_instance.api_status()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling AdminApi->api_status: %s\n" % e)
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**APIPlansOut**](APIPlansOut.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: 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)
+
 # **api_usage**
 > APIPeriodUsageOut api_usage()
 
@@ -308,9 +360,9 @@ 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)
 
 # **available_plans**
-> APIPlansOut available_plans()
+> APIPlansOut available_plans(token)
 
-List all available plans in the default currency (usd).
+List all available plans in the user's preferred currency.
 
 ### Example
 
@@ -330,17 +382,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))
+token = 'token_example' # str | 
 
 try:
-    # List all available plans in the default currency (usd).
-    api_response = api_instance.available_plans()
+    # List all available plans in the user's preferred currency.
+    api_response = api_instance.available_plans(token)
     pprint(api_response)
 except ApiException as e:
     print("Exception when calling AdminApi->available_plans: %s\n" % e)
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **token** | **str**|  | 
 
 ### Return type
 
@@ -358,9 +414,9 @@ 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)
 
 # **available_plans1**
-> APIPlansOut available_plans1(token)
+> APIPlansOut available_plans1()
 
-List all available plans in the user's preferred currency.
+List all available plans in the default currency (usd).
 
 ### Example
 
@@ -380,21 +436,17 @@ 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))
-token = 'token_example' # str | 
 
 try:
-    # List all available plans in the user's preferred currency.
-    api_response = api_instance.available_plans1(token)
+    # List all available plans in the default currency (usd).
+    api_response = api_instance.available_plans1()
     pprint(api_response)
 except ApiException as e:
     print("Exception when calling AdminApi->available_plans1: %s\n" % e)
 ```
 
 ### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **token** | **str**|  | 
+This endpoint does not need any parameter.
 
 ### Return type
 
@@ -1678,6 +1730,60 @@ 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)
 
+# **taxonomy_classes**
+> APIPlansOut taxonomy_classes(classifier_name)
+
+Print the taxonomy classes valid for the given classifier.
+
+### 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))
+classifier_name = 'classifier_name_example' # str | 
+
+try:
+    # Print the taxonomy classes valid for the given classifier.
+    api_response = api_instance.taxonomy_classes(classifier_name)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling AdminApi->taxonomy_classes: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **classifier_name** | **str**|  | 
+
+### Return type
+
+[**APIPlansOut**](APIPlansOut.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: 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)
+
 # **update_billing_info**
 > BillingInfoInOut update_billing_info(token, billing_info_in_out=billing_info_in_out)
 

docs/FirstLastNameOriginedOut.md

@@ -13,6 +13,8 @@ Name | Type | Description | Notes
 **region_origin** | **str** | Most likely region of Origin (based on countryOrigin ISO2 code) | [optional] 
 **top_region_origin** | **str** | Most likely region of Origin (based on countryOrigin ISO2 code) | [optional] 
 **sub_region_origin** | **str** | Most likely region of Origin (based on countryOrigin ISO2 code) | [optional] 
+**probability_calibrated** | **float** |  | [optional] 
+**probability_alt_calibrated** | **float** |  | [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)
 

docs/FirstLastNameUSRaceEthnicityOut.md

@@ -10,6 +10,8 @@ Name | Type | Description | Notes
 **race_ethnicity** | **str** | Most likely US 'race'/ethnicity | [optional] 
 **score** | **float** | Compatibility to NamSor_v1 Origin score value | [optional] 
 **race_ethnicities_top** | **list[str]** | List 'race'/ethnicities | [optional] 
+**probability_calibrated** | **float** |  | [optional] 
+**probability_alt_calibrated** | **float** |  | [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)
 

docs/PersonalApi.md

@@ -361,7 +361,7 @@ 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)
 
 # **gender_full**
-> FirstLastNameGenderedOut gender_full(full_name)
+> PersonalNameGenderedOut gender_full(full_name)
 
 Infer the likely gender of a full name, ex. John H. Smith
 
@@ -401,7 +401,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**FirstLastNameGenderedOut**](FirstLastNameGenderedOut.md)
+[**PersonalNameGenderedOut**](PersonalNameGenderedOut.md)
 
 ### Authorization
 
@@ -469,7 +469,7 @@ 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)
 
 # **gender_full_geo**
-> FirstLastNameGenderedOut gender_full_geo(full_name, country_iso2)
+> PersonalNameGenderedOut gender_full_geo(full_name, country_iso2)
 
 Infer the likely gender of a full name, given a local context (ISO2 country code).
 
@@ -511,7 +511,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**FirstLastNameGenderedOut**](FirstLastNameGenderedOut.md)
+[**PersonalNameGenderedOut**](PersonalNameGenderedOut.md)
 
 ### Authorization
 

docs/PersonalNameGenderedOut.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **likely_gender** | **str** | Most likely gender | [optional] 
 **gender_scale** | **float** | Compatibility to NamSor_v1 Gender Scale M[-1..U..+1]F value | [optional] 
 **score** | **float** |  | [optional] 
+**probability_calibrated** | **float** |  | [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)
 

docs/PersonalNameGeoOut.md

@@ -11,6 +11,9 @@ Name | Type | Description | Notes
 **region** | **str** |  | [optional] 
 **top_region** | **str** |  | [optional] 
 **sub_region** | **str** |  | [optional] 
+**countries_top** | **list[str]** | List countries (top 10) | [optional] 
+**probability_calibrated** | **float** |  | [optional] 
+**probability_alt_calibrated** | **float** |  | [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)