Skip to content

Commit

Permalink
Minor update
Browse files Browse the repository at this point in the history
  • Loading branch information
NamSor SAS committed Feb 1, 2021
1 parent 53e9581 commit a958823
Show file tree
Hide file tree
Showing 218 changed files with 3,285 additions and 661 deletions.
122 changes: 62 additions & 60 deletions README.md

Large diffs are not rendered by default.

104 changes: 0 additions & 104 deletions docs/AdminApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ Method | HTTP request | Description
[**namsor_counter**](AdminApi.md#namsor_counter) | **GET** /api2/json/namsorCounter | Get the overall API counter
[**payment_info**](AdminApi.md#payment_info) | **GET** /api2/json/paymentInfo/{token} | Get the Stripe payment information associated with the current google auth session token.
[**procure_key**](AdminApi.md#procure_key) | **GET** /api2/json/procureKey/{token} | Procure an API Key (sent via Email), based on an auth token. Keep your API Key secret.
[**redeploy_ui**](AdminApi.md#redeploy_ui) | **GET** /api2/json/redeployUI/{live} | Redeploy UI from current dev branch.
[**redeploy_ui1**](AdminApi.md#redeploy_ui1) | **GET** /api2/json/redeployUI | Redeploy UI from current dev branch.
[**remove_user_account**](AdminApi.md#remove_user_account) | **GET** /api2/json/removeUserAccount/{token} | Remove the user account.
[**remove_user_account_on_behalf**](AdminApi.md#remove_user_account_on_behalf) | **GET** /api2/json/removeUserAccountOnBehalf/{apiKey} | Remove (on behalf) a user account.
[**shutdown**](AdminApi.md#shutdown) | **GET** /api2/json/shutdown | Stop learning and shutdown system.
Expand Down Expand Up @@ -1146,108 +1144,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)

# **redeploy_ui**
> redeploy_ui(live)
Redeploy UI from current dev branch.

### 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))
live = True # bool |

try:
# Redeploy UI from current dev branch.
api_instance.redeploy_ui(live)
except ApiException as e:
print("Exception when calling AdminApi->redeploy_ui: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**live** | **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)

# **redeploy_ui1**
> redeploy_ui1()
Redeploy UI from current dev branch.

### 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:
# Redeploy UI from current dev branch.
api_instance.redeploy_ui1()
except ApiException as e:
print("Exception when calling AdminApi->redeploy_ui1: %s\n" % e)
```

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

### 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)

# **remove_user_account**
> APIPlanSubscriptionOut remove_user_account(token)
Expand Down
5 changes: 2 additions & 3 deletions docs/DeployUIOut.md → docs/BatchCorridorIn.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# DeployUIOut
# BatchCorridorIn

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**error_message** | **str** | | [optional]
**succeeded** | **bool** | | [optional]
**corridor_from_to** | [**list[CorridorIn]**](CorridorIn.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)

Expand Down
10 changes: 10 additions & 0 deletions docs/BatchCorridorOut.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# BatchCorridorOut

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**corridor_from_to** | [**list[CorridorOut]**](CorridorOut.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)


10 changes: 10 additions & 0 deletions docs/BatchNameGeoIn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# BatchNameGeoIn

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**proper_nouns** | [**list[NameGeoIn]**](NameGeoIn.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)


10 changes: 10 additions & 0 deletions docs/BatchNameIn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# BatchNameIn

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**proper_nouns** | [**list[NameIn]**](NameIn.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)


10 changes: 10 additions & 0 deletions docs/BatchProperNounCategorizedOut.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# BatchProperNounCategorizedOut

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**proper_nouns** | [**list[ProperNounCategorizedOut]**](ProperNounCategorizedOut.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)


12 changes: 12 additions & 0 deletions docs/CorridorIn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# CorridorIn

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [optional]
**first_last_name_geo_from** | [**FirstLastNameGeoIn**](FirstLastNameGeoIn.md) | | [optional]
**first_last_name_geo_to** | [**FirstLastNameGeoIn**](FirstLastNameGeoIn.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)


15 changes: 15 additions & 0 deletions docs/CorridorOut.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# CorridorOut

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [optional]
**first_last_name_gendered_out** | [**FirstLastNameGenderedOut**](FirstLastNameGenderedOut.md) | | [optional]
**first_last_name_origined_out** | [**FirstLastNameOriginedOut**](FirstLastNameOriginedOut.md) | | [optional]
**first_last_name_diasporaed_out** | [**FirstLastNameDiasporaedOut**](FirstLastNameDiasporaedOut.md) | | [optional]
**script** | **str** | | [optional]
**category** | **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)


2 changes: 2 additions & 0 deletions docs/FirstLastNameDiasporaedOut.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **str** | | [optional]
**id** | **str** | | [optional]
**first_name** | **str** | | [optional]
**last_name** | **str** | | [optional]
Expand All @@ -12,6 +13,7 @@ Name | Type | Description | Notes
**lifted** | **bool** | | [optional]
**country_iso2** | **str** | | [optional]
**ethnicities_top** | **list[str]** | List ethnicities (top 10) | [optional]
**category** | **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)

Expand Down
2 changes: 2 additions & 0 deletions docs/FirstLastNameGenderedOut.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **str** | | [optional]
**id** | **str** | | [optional]
**first_name** | **str** | | [optional]
**last_name** | **str** | | [optional]
**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]
**category** | **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)

Expand Down
2 changes: 2 additions & 0 deletions docs/FirstLastNameOriginedOut.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **str** | | [optional]
**id** | **str** | | [optional]
**first_name** | **str** | | [optional]
**last_name** | **str** | | [optional]
Expand All @@ -15,6 +16,7 @@ Name | Type | Description | Notes
**sub_region_origin** | **str** | Most likely region of Origin (based on countryOrigin ISO2 code) | [optional]
**probability_calibrated** | **float** | | [optional]
**probability_alt_calibrated** | **float** | | [optional]
**category** | **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)

Expand Down
2 changes: 2 additions & 0 deletions docs/FirstLastNameOut.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **str** | | [optional]
**id** | **str** | | [optional]
**first_name** | **str** | | [optional]
**last_name** | **str** | | [optional]
**category** | **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)

Expand Down
2 changes: 2 additions & 0 deletions docs/FirstLastNamePhoneCodedOut.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **str** | | [optional]
**id** | **str** | | [optional]
**first_name** | **str** | | [optional]
**last_name** | **str** | | [optional]
Expand All @@ -18,6 +19,7 @@ Name | Type | Description | Notes
**verified** | **bool** | | [optional]
**score** | **float** | | [optional]
**country_iso2** | **str** | | [optional]
**category** | **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)

Expand Down
2 changes: 2 additions & 0 deletions docs/FirstLastNameUSRaceEthnicityOut.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **str** | | [optional]
**id** | **str** | | [optional]
**first_name** | **str** | | [optional]
**last_name** | **str** | | [optional]
Expand All @@ -12,6 +13,7 @@ Name | Type | Description | Notes
**race_ethnicities_top** | **list[str]** | List 'race'/ethnicities | [optional]
**probability_calibrated** | **float** | | [optional]
**probability_alt_calibrated** | **float** | | [optional]
**category** | **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)

Expand Down
Loading

0 comments on commit a958823

Please sign in to comment.