Skip to content

Commit

Permalink
Minor update
Browse files Browse the repository at this point in the history
  • Loading branch information
NamSor SAS committed Oct 28, 2019
1 parent bb76289 commit 5b2afc1
Show file tree
Hide file tree
Showing 165 changed files with 304 additions and 217 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.5
- API version: 2.0.6
- 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/)
Expand Down Expand Up @@ -84,8 +84,8 @@ Class | Method | HTTP request | Description
*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/{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_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_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).
Expand Down
32 changes: 16 additions & 16 deletions docs/AdminApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Method | HTTP request | Description
[**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/{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_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_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).
Expand Down Expand Up @@ -308,9 +308,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(token)
> APIPlansOut available_plans()
List all available plans in the user's preferred currency.
List all available plans in the default currency (usd).

### Example

Expand All @@ -330,21 +330,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_plans(token)
# List all available plans in the default currency (usd).
api_response = api_instance.available_plans()
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->available_plans: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**token** | **str**| |
This endpoint does not need any parameter.

### Return type

Expand All @@ -362,9 +358,9 @@ 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)

# **available_plans1**
> APIPlansOut available_plans1()
> APIPlansOut available_plans1(token)
List all available plans in the default currency (usd).
List all available plans in the user's preferred currency.

### Example

Expand All @@ -384,17 +380,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_plans1()
# List all available plans in the user's preferred currency.
api_response = api_instance.available_plans1(token)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->available_plans1: %s\n" % e)
```

### Parameters
This endpoint does not need any parameter.

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**token** | **str**| |

### Return type

Expand Down
1 change: 1 addition & 0 deletions docs/FirstLastNameDiasporaedOut.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Name | Type | Description | Notes
**ethnicity** | **str** | | [optional]
**lifted** | **bool** | | [optional]
**country_iso2** | **str** | | [optional]
**ethnicities_top** | **list[str]** | List ethnicities (top 10) | [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)

Expand Down
1 change: 1 addition & 0 deletions docs/FirstLastNameOriginedOut.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**last_name** | **str** | | [optional]
**country_origin** | **str** | Most likely country of Origin | [optional]
**country_origin_alt** | **str** | Second best alternative : country of Origin | [optional]
**countries_origin_top** | **list[str]** | List countries of Origin (top 10) | [optional]
**score** | **float** | Compatibility to NamSor_v1 Origin score value | [optional]
**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]
Expand Down
1 change: 1 addition & 0 deletions docs/FirstLastNameUSRaceEthnicityOut.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Name | Type | Description | Notes
**race_ethnicity_alt** | **str** | Second most likely US 'race'/ethnicity | [optional]
**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]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion openapi_client/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. 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! # noqa: E501
OpenAPI spec version: 2.0.5
OpenAPI spec version: 2.0.6
Contact: contact@namsor.com
Generated by: https://openapi-generator.tech
"""
Expand Down
58 changes: 29 additions & 29 deletions openapi_client/api/admin_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. 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! # noqa: E501
OpenAPI spec version: 2.0.5
OpenAPI spec version: 2.0.6
Contact: contact@namsor.com
Generated by: https://openapi-generator.tech
"""
Expand Down Expand Up @@ -499,45 +499,43 @@ def api_usage_history_aggregate_with_http_info(self, **kwargs): # noqa: E501
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)

def available_plans(self, token, **kwargs): # noqa: E501
"""List all available plans in the user's preferred currency. # noqa: E501
def available_plans(self, **kwargs): # noqa: E501
"""List all available plans in the default currency (usd). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.available_plans(token, async_req=True)
>>> thread = api.available_plans(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str token: (required)
:return: APIPlansOut
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.available_plans_with_http_info(token, **kwargs) # noqa: E501
return self.available_plans_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.available_plans_with_http_info(token, **kwargs) # noqa: E501
(data) = self.available_plans_with_http_info(**kwargs) # noqa: E501
return data

def available_plans_with_http_info(self, token, **kwargs): # noqa: E501
"""List all available plans in the user's preferred currency. # noqa: E501
def available_plans_with_http_info(self, **kwargs): # noqa: E501
"""List all available plans in the default currency (usd). # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.available_plans_with_http_info(token, async_req=True)
>>> thread = api.available_plans_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str token: (required)
:return: APIPlansOut
If the method is called asynchronously,
returns the request thread.
"""

local_var_params = locals()

all_params = ['token'] # noqa: E501
all_params = [] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
Expand All @@ -551,16 +549,10 @@ def available_plans_with_http_info(self, token, **kwargs): # noqa: E501
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'token' is set
if ('token' not in local_var_params or
local_var_params['token'] is None):
raise ValueError("Missing the required parameter `token` when calling `available_plans`") # noqa: E501

collection_formats = {}

path_params = {}
if 'token' in local_var_params:
path_params['token'] = local_var_params['token'] # noqa: E501

query_params = []

Expand All @@ -578,7 +570,7 @@ def available_plans_with_http_info(self, token, **kwargs): # noqa: E501
auth_settings = ['api_key'] # noqa: E501

return self.api_client.call_api(
'/api2/json/availablePlans/{token}', 'GET',
'/api2/json/availablePlans', 'GET',
path_params,
query_params,
header_params,
Expand All @@ -593,43 +585,45 @@ def available_plans_with_http_info(self, token, **kwargs): # noqa: E501
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)

def available_plans1(self, **kwargs): # noqa: E501
"""List all available plans in the default currency (usd). # noqa: E501
def available_plans1(self, token, **kwargs): # noqa: E501
"""List all available plans in the user's preferred currency. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.available_plans1(async_req=True)
>>> thread = api.available_plans1(token, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str token: (required)
:return: APIPlansOut
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.available_plans1_with_http_info(**kwargs) # noqa: E501
return self.available_plans1_with_http_info(token, **kwargs) # noqa: E501
else:
(data) = self.available_plans1_with_http_info(**kwargs) # noqa: E501
(data) = self.available_plans1_with_http_info(token, **kwargs) # noqa: E501
return data

def available_plans1_with_http_info(self, **kwargs): # noqa: E501
"""List all available plans in the default currency (usd). # noqa: E501
def available_plans1_with_http_info(self, token, **kwargs): # noqa: E501
"""List all available plans in the user's preferred currency. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.available_plans1_with_http_info(async_req=True)
>>> thread = api.available_plans1_with_http_info(token, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str token: (required)
:return: APIPlansOut
If the method is called asynchronously,
returns the request thread.
"""

local_var_params = locals()

all_params = [] # noqa: E501
all_params = ['token'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
Expand All @@ -643,10 +637,16 @@ def available_plans1_with_http_info(self, **kwargs): # noqa: E501
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'token' is set
if ('token' not in local_var_params or
local_var_params['token'] is None):
raise ValueError("Missing the required parameter `token` when calling `available_plans1`") # noqa: E501

collection_formats = {}

path_params = {}
if 'token' in local_var_params:
path_params['token'] = local_var_params['token'] # noqa: E501

query_params = []

Expand All @@ -664,7 +664,7 @@ def available_plans1_with_http_info(self, **kwargs): # noqa: E501
auth_settings = ['api_key'] # noqa: E501

return self.api_client.call_api(
'/api2/json/availablePlans', 'GET',
'/api2/json/availablePlans/{token}', 'GET',
path_params,
query_params,
header_params,
Expand Down
2 changes: 1 addition & 1 deletion openapi_client/api/chinese_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. 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! # noqa: E501
OpenAPI spec version: 2.0.5
OpenAPI spec version: 2.0.6
Contact: contact@namsor.com
Generated by: https://openapi-generator.tech
"""
Expand Down
2 changes: 1 addition & 1 deletion openapi_client/api/personal_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. 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! # noqa: E501
OpenAPI spec version: 2.0.5
OpenAPI spec version: 2.0.6
Contact: contact@namsor.com
Generated by: https://openapi-generator.tech
"""
Expand Down
2 changes: 1 addition & 1 deletion openapi_client/api/social_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. 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! # noqa: E501
OpenAPI spec version: 2.0.5
OpenAPI spec version: 2.0.6
Contact: contact@namsor.com
Generated by: https://openapi-generator.tech
"""
Expand Down
2 changes: 1 addition & 1 deletion openapi_client/api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. 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! # noqa: E501
OpenAPI spec version: 2.0.5
OpenAPI spec version: 2.0.6
Contact: contact@namsor.com
Generated by: https://openapi-generator.tech
"""
Expand Down
4 changes: 2 additions & 2 deletions openapi_client/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. 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! # noqa: E501
OpenAPI spec version: 2.0.5
OpenAPI spec version: 2.0.6
Contact: contact@namsor.com
Generated by: https://openapi-generator.tech
"""
Expand Down Expand Up @@ -231,6 +231,6 @@ def to_debug_report(self):
return "Python SDK Debug Report:\n"\
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
"Version of the API: 2.0.5\n"\
"Version of the API: 2.0.6\n"\
"SDK Package Version: 1.0.0".\
format(env=sys.platform, pyversion=sys.version)
2 changes: 1 addition & 1 deletion openapi_client/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. 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! # noqa: E501
OpenAPI spec version: 2.0.5
OpenAPI spec version: 2.0.6
Contact: contact@namsor.com
Generated by: https://openapi-generator.tech
"""
Expand Down
Loading

0 comments on commit 5b2afc1

Please sign in to comment.