Skip to content

Commit

Permalink
Minor update
Browse files Browse the repository at this point in the history
  • Loading branch information
NamSor SAS committed Nov 24, 2019
1 parent ea42e4e commit 74e31de
Show file tree
Hide file tree
Showing 882 changed files with 36,720 additions and 46,135 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# namsor-sdk2

NamSor API v2
- API version: 2.0.6
- Build date: 2019-11-04T11:52:46.102+01:00[Europe/Berlin]
- API version: 2.0.7
- Build date: 2019-11-24T12:26:12.232+01:00[Europe/Berlin]

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!

Expand Down Expand Up @@ -41,7 +41,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>com.namsor</groupId>
<artifactId>namsor-sdk2</artifactId>
<version>2.0.6</version>
<version>2.0.7</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -51,7 +51,7 @@ Add this dependency to your project's POM:
Add this dependency to your project's build file:

```groovy
compile "com.namsor:namsor-sdk2:2.0.6"
compile "com.namsor:namsor-sdk2:2.0.7"
```

### Others
Expand All @@ -64,7 +64,7 @@ mvn clean package

Then manually install the following JARs:

* `target/namsor-sdk2-2.0.6.jar`
* `target/namsor-sdk2-2.0.7.jar`
* `target/lib/*.jar`

## Getting Started
Expand Down Expand Up @@ -116,11 +116,12 @@ Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AdminApi* | [**addCredits**](docs/AdminApi.md#addCredits) | **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* | [**apiStatus**](docs/AdminApi.md#apiStatus) | **GET** /api2/json/apiStatus | Prints the current status of the classifiers.
*AdminApi* | [**apiUsage**](docs/AdminApi.md#apiUsage) | **GET** /api2/json/apiUsage | Print current API usage.
*AdminApi* | [**apiUsageHistory**](docs/AdminApi.md#apiUsageHistory) | **GET** /api2/json/apiUsageHistory | Print historical API usage.
*AdminApi* | [**apiUsageHistoryAggregate**](docs/AdminApi.md#apiUsageHistoryAggregate) | **GET** /api2/json/apiUsageHistoryAggregate | Print historical API usage (in an aggregated view, by service, by day/hour/min).
*AdminApi* | [**availablePlans**](docs/AdminApi.md#availablePlans) | **GET** /api2/json/availablePlans | List all available plans in the default currency (usd).
*AdminApi* | [**availablePlans1**](docs/AdminApi.md#availablePlans1) | **GET** /api2/json/availablePlans/{token} | List all available plans in the user&#39;s preferred currency.
*AdminApi* | [**availablePlans**](docs/AdminApi.md#availablePlans) | **GET** /api2/json/availablePlans/{token} | List all available plans in the user&#39;s preferred currency.
*AdminApi* | [**availablePlans1**](docs/AdminApi.md#availablePlans1) | **GET** /api2/json/availablePlans | List all available plans in the default currency (usd).
*AdminApi* | [**availableServices**](docs/AdminApi.md#availableServices) | **GET** /api2/json/apiServices | List of API services and usage cost in Units (default is 1&#x3D;ONE Unit).
*AdminApi* | [**billingCurrencies**](docs/AdminApi.md#billingCurrencies) | **GET** /api2/json/billingCurrencies | List possible currency options for billing (USD, EUR, GBP, ...)
*AdminApi* | [**billingHistory**](docs/AdminApi.md#billingHistory) | **GET** /api2/json/billingHistory/{token} | Read the history billing information (invoices paid via Stripe or manually).
Expand All @@ -145,6 +146,7 @@ Class | Method | HTTP request | Description
*AdminApi* | [**stripeConnect**](docs/AdminApi.md#stripeConnect) | **GET** /api2/json/stripeConnect | Connects a Stripe Account.
*AdminApi* | [**subscribePlan**](docs/AdminApi.md#subscribePlan) | **GET** /api2/json/subscribePlan/{planName}/{token} | Subscribe to a give API plan, using the user&#39;s preferred or default currency.
*AdminApi* | [**subscribePlanOnBehalf**](docs/AdminApi.md#subscribePlanOnBehalf) | **GET** /api2/json/subscribePlanOnBehalf/{planName}/{apiKey} | Subscribe to a give API plan, using the user&#39;s preferred or default currency (admin only).
*AdminApi* | [**taxonomyClasses**](docs/AdminApi.md#taxonomyClasses) | **GET** /api2/json/taxonomyClasses/{classifierName} | Print the taxonomy classes valid for the given classifier.
*AdminApi* | [**updateBillingInfo**](docs/AdminApi.md#updateBillingInfo) | **POST** /api2/json/updateBillingInfo/{token} | Sets or update the billing information (company name, address, phone, vat ID)
*AdminApi* | [**updateLimit**](docs/AdminApi.md#updateLimit) | **GET** /api2/json/updateLimit/{usageLimit}/{hardOrSoft}/{token} | Modifies the hard/soft limit on the API plan&#39;s overages (default is 0$ soft limit).
*AdminApi* | [**updatePaymentDefault**](docs/AdminApi.md#updatePaymentDefault) | **GET** /api2/json/updatePaymentDefault/{defautSourceId}/{token} | Update the default Stripe card associated with the current google auth session token.
Expand Down Expand Up @@ -200,6 +202,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)
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apply plugin: 'idea'
apply plugin: 'eclipse'

group = 'com.namsor'
version = '2.0.6'
version = '2.0.7'

buildscript {
repositories {
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
settings(
organization := "com.namsor",
name := "namsor-sdk2",
version := "2.0.6",
version := "2.0.7",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
Expand Down
14 changes: 14 additions & 0 deletions docs/APIClassifierOut.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

# APIClassifierOut

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**classifierName** | **String** | | [optional]
**serving** | **Boolean** | | [optional]
**learning** | **Boolean** | | [optional]
**shuttingDown** | **Boolean** | | [optional]
**probabilityCalibrated** | **Boolean** | | [optional]



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

# APIClassifierTaxonomyOut

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**classifierName** | **String** | | [optional]
**taxonomyClasses** | **List&lt;String&gt;** | | [optional]



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

# APIClassifiersStatusOut

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**softwareVersion** | [**SoftwareVersionOut**](SoftwareVersionOut.md) | | [optional]
**classifiers** | [**List&lt;APIClassifierOut&gt;**](APIClassifierOut.md) | | [optional]



132 changes: 118 additions & 14 deletions docs/AdminApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**addCredits**](AdminApi.md#addCredits) | **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.
[**apiStatus**](AdminApi.md#apiStatus) | **GET** /api2/json/apiStatus | Prints the current status of the classifiers.
[**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).
[**availablePlans**](AdminApi.md#availablePlans) | **GET** /api2/json/availablePlans | List all available plans in the default currency (usd).
[**availablePlans1**](AdminApi.md#availablePlans1) | **GET** /api2/json/availablePlans/{token} | List all available plans in the user&#39;s preferred currency.
[**availablePlans**](AdminApi.md#availablePlans) | **GET** /api2/json/availablePlans/{token} | List all available plans in the user&#39;s preferred currency.
[**availablePlans1**](AdminApi.md#availablePlans1) | **GET** /api2/json/availablePlans | List all available plans in the default currency (usd).
[**availableServices**](AdminApi.md#availableServices) | **GET** /api2/json/apiServices | List of API services and usage cost in Units (default is 1&#x3D;ONE Unit).
[**billingCurrencies**](AdminApi.md#billingCurrencies) | **GET** /api2/json/billingCurrencies | List possible currency options for billing (USD, EUR, GBP, ...)
[**billingHistory**](AdminApi.md#billingHistory) | **GET** /api2/json/billingHistory/{token} | Read the history billing information (invoices paid via Stripe or manually).
Expand All @@ -35,6 +36,7 @@ Method | HTTP request | Description
[**stripeConnect**](AdminApi.md#stripeConnect) | **GET** /api2/json/stripeConnect | Connects a Stripe Account.
[**subscribePlan**](AdminApi.md#subscribePlan) | **GET** /api2/json/subscribePlan/{planName}/{token} | Subscribe to a give API plan, using the user&#39;s preferred or default currency.
[**subscribePlanOnBehalf**](AdminApi.md#subscribePlanOnBehalf) | **GET** /api2/json/subscribePlanOnBehalf/{planName}/{apiKey} | Subscribe to a give API plan, using the user&#39;s preferred or default currency (admin only).
[**taxonomyClasses**](AdminApi.md#taxonomyClasses) | **GET** /api2/json/taxonomyClasses/{classifierName} | Print the taxonomy classes valid for the given classifier.
[**updateBillingInfo**](AdminApi.md#updateBillingInfo) | **POST** /api2/json/updateBillingInfo/{token} | Sets or update the billing information (company name, address, phone, vat ID)
[**updateLimit**](AdminApi.md#updateLimit) | **GET** /api2/json/updateLimit/{usageLimit}/{hardOrSoft}/{token} | Modifies the hard/soft limit on the API plan&#39;s overages (default is 0$ soft limit).
[**updatePaymentDefault**](AdminApi.md#updatePaymentDefault) | **GET** /api2/json/updatePaymentDefault/{defautSourceId}/{token} | Update the default Stripe card associated with the current google auth session token.
Expand Down Expand Up @@ -155,6 +157,55 @@ null (empty response body)
- **Content-Type**: Not defined
- **Accept**: Not defined

<a name="apiStatus"></a>
# **apiStatus**
> APIPlansOut apiStatus()
Prints the current status of the classifiers.

### 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();
try {
APIPlansOut result = apiInstance.apiStatus();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AdminApi#apiStatus");
e.printStackTrace();
}
```

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

<a name="apiUsage"></a>
# **apiUsage**
> APIPeriodUsageOut apiUsage()
Expand Down Expand Up @@ -304,9 +355,9 @@ This endpoint does not need any parameter.

<a name="availablePlans"></a>
# **availablePlans**
> APIPlansOut availablePlans()
> APIPlansOut availablePlans(token)
List all available plans in the default currency (usd).
List all available plans in the user&#39;s preferred currency.

### Example
```java
Expand All @@ -326,8 +377,9 @@ api_key.setApiKey("YOUR API KEY");
//api_key.setApiKeyPrefix("Token");

AdminApi apiInstance = new AdminApi();
String token = "token_example"; // String |
try {
APIPlansOut result = apiInstance.availablePlans();
APIPlansOut result = apiInstance.availablePlans(token);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AdminApi#availablePlans");
Expand All @@ -336,7 +388,10 @@ try {
```

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

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

### Return type

Expand All @@ -353,9 +408,9 @@ This endpoint does not need any parameter.

<a name="availablePlans1"></a>
# **availablePlans1**
> APIPlansOut availablePlans1(token)
> APIPlansOut availablePlans1()
List all available plans in the user&#39;s preferred currency.
List all available plans in the default currency (usd).

### Example
```java
Expand All @@ -375,9 +430,8 @@ api_key.setApiKey("YOUR API KEY");
//api_key.setApiKeyPrefix("Token");

AdminApi apiInstance = new AdminApi();
String token = "token_example"; // String |
try {
APIPlansOut result = apiInstance.availablePlans1(token);
APIPlansOut result = apiInstance.availablePlans1();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AdminApi#availablePlans1");
Expand All @@ -386,10 +440,7 @@ try {
```

### Parameters

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

### Return type

Expand Down Expand Up @@ -1642,6 +1693,59 @@ Name | Type | Description | Notes

[api_key](../README.md#api_key)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="taxonomyClasses"></a>
# **taxonomyClasses**
> APIPlansOut taxonomyClasses(classifierName)
Print the taxonomy classes valid for the given classifier.

### 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 classifierName = "classifierName_example"; // String |
try {
APIPlansOut result = apiInstance.taxonomyClasses(classifierName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AdminApi#taxonomyClasses");
e.printStackTrace();
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**classifierName** | **String**| |

### Return type

[**APIPlansOut**](APIPlansOut.md)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

- **Content-Type**: Not defined
Expand Down
2 changes: 2 additions & 0 deletions docs/FirstLastNameOriginedOut.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Name | Type | Description | Notes
**regionOrigin** | **String** | Most likely region of Origin (based on countryOrigin ISO2 code) | [optional]
**topRegionOrigin** | **String** | Most likely region of Origin (based on countryOrigin ISO2 code) | [optional]
**subRegionOrigin** | **String** | Most likely region of Origin (based on countryOrigin ISO2 code) | [optional]
**probabilityCalibrated** | **Double** | | [optional]
**probabilityAltCalibrated** | **Double** | | [optional]



2 changes: 2 additions & 0 deletions docs/FirstLastNameUSRaceEthnicityOut.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Name | Type | Description | Notes
**raceEthnicity** | [**RaceEthnicityEnum**](#RaceEthnicityEnum) | Most likely US &#39;race&#39;/ethnicity | [optional]
**score** | **Double** | Compatibility to NamSor_v1 Origin score value | [optional]
**raceEthnicitiesTop** | **List&lt;String&gt;** | List &#39;race&#39;/ethnicities | [optional]
**probabilityCalibrated** | **Double** | | [optional]
**probabilityAltCalibrated** | **Double** | | [optional]


<a name="RaceEthnicityAltEnum"></a>
Expand Down
Loading

0 comments on commit 74e31de

Please sign in to comment.