-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
NamSor SAS
committed
Nov 1, 2020
1 parent
c3b5736
commit 4e714bb
Showing
556 changed files
with
6,110 additions
and
5,338 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| # GeneralApi | ||
|
|
||
| All URIs are relative to *https://v2.namsor.com/NamSorAPIv2* | ||
|
|
||
| Method | HTTP request | Description | ||
| ------------- | ------------- | ------------- | ||
| [**nameType**](GeneralApi.md#nameType) | **GET** /api2/json/nameType/{properNoun} | Infer the likely type of a proper noun (personal name, brand name, place name etc.) | ||
| [**nameType1**](GeneralApi.md#nameType1) | **GET** /api2/json/nameType/{properNoun}/{countryIso2} | Infer the likely type of a proper noun (personal name, brand name, place name etc.) | ||
|
|
||
|
|
||
| <a name="nameType"></a> | ||
| # **nameType** | ||
| > ProperNounCategorizedOut nameType(properNoun) | ||
| Infer the likely type of a proper noun (personal name, brand name, place name etc.) | ||
|
|
||
| ### 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.GeneralApi; | ||
|
|
||
| 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"); | ||
|
|
||
| GeneralApi apiInstance = new GeneralApi(); | ||
| String properNoun = "properNoun_example"; // String | | ||
| try { | ||
| ProperNounCategorizedOut result = apiInstance.nameType(properNoun); | ||
| System.out.println(result); | ||
| } catch (ApiException e) { | ||
| System.err.println("Exception when calling GeneralApi#nameType"); | ||
| e.printStackTrace(); | ||
| } | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **properNoun** | **String**| | | ||
|
|
||
| ### Return type | ||
|
|
||
| [**ProperNounCategorizedOut**](ProperNounCategorizedOut.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| [api_key](../README.md#api_key) | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: Not defined | ||
| - **Accept**: application/json | ||
|
|
||
| <a name="nameType1"></a> | ||
| # **nameType1** | ||
| > ProperNounCategorizedOut nameType1(properNoun, countryIso2) | ||
| Infer the likely type of a proper noun (personal name, brand name, place name etc.) | ||
|
|
||
| ### 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.GeneralApi; | ||
|
|
||
| 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"); | ||
|
|
||
| GeneralApi apiInstance = new GeneralApi(); | ||
| String properNoun = "properNoun_example"; // String | | ||
| String countryIso2 = "countryIso2_example"; // String | | ||
| try { | ||
| ProperNounCategorizedOut result = apiInstance.nameType1(properNoun, countryIso2); | ||
| System.out.println(result); | ||
| } catch (ApiException e) { | ||
| System.err.println("Exception when calling GeneralApi#nameType1"); | ||
| e.printStackTrace(); | ||
| } | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **properNoun** | **String**| | | ||
| **countryIso2** | **String**| | | ||
|
|
||
| ### Return type | ||
|
|
||
| [**ProperNounCategorizedOut**](ProperNounCategorizedOut.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| [api_key](../README.md#api_key) | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: Not defined | ||
| - **Accept**: application/json | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
|
|
||
| # ProperNounCategorizedOut | ||
|
|
||
| ## Properties | ||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **id** | **String** | | [optional] | ||
| **name** | **String** | | [optional] | ||
| **commonType** | **String** | | [optional] | ||
| **commonTypeAlt** | **String** | | [optional] | ||
| **score** | **Double** | | [optional] | ||
|
|
||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.