Skip to content

Commit

Permalink
NamSorAPÏv2.0.26B01
Browse files Browse the repository at this point in the history
  • Loading branch information
NamSor SAS committed Jun 19, 2023
1 parent 2d38dbb commit bef9b2c
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 9 deletions.
36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ 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.18
- Package version: 2.0.18
- API version: 2.0.26
- Package version: 2.0.26
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [http://www.namsor.com/](http://www.namsor.com/)

Expand Down Expand Up @@ -80,16 +80,14 @@ All URIs are relative to *https://v2.namsor.com/NamSorAPIv2*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AdminApi* | [**anonymize**](docs/AdminApi.md#anonymize) | **GET** /api2/json/anonymize/{source}/{anonymized}/{token} | Activate/deactivate anonymization for a source.
*AdminApi* | [**anonymize1**](docs/AdminApi.md#anonymize1) | **GET** /api2/json/anonymize/{source}/{anonymized} | Activate/deactivate anonymization for a source.
*AdminApi* | [**api_key_info**](docs/AdminApi.md#api_key_info) | **GET** /api2/json/apiKeyInfo | Read API Key info.
*AdminApi* | [**api_status**](docs/AdminApi.md#api_status) | **GET** /api2/json/apiStatus | Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices.
*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_services**](docs/AdminApi.md#available_services) | **GET** /api2/json/apiServices | List of classification services and usage cost in Units per classification (default is 1=ONE Unit). Some API endpoints (ex. Corridor) combine multiple classifiers.
*AdminApi* | [**disable**](docs/AdminApi.md#disable) | **GET** /api2/json/disable/{source}/{disabled} | Activate/deactivate an API Key.
*AdminApi* | [**learnable**](docs/AdminApi.md#learnable) | **GET** /api2/json/learnable/{source}/{learnable} | Activate/deactivate learning from a source.
*AdminApi* | [**learnable1**](docs/AdminApi.md#learnable1) | **GET** /api2/json/learnable/{source}/{learnable}/{token} | Activate/deactivate learning from a source.
*AdminApi* | [**learnable**](docs/AdminApi.md#learnable) | **GET** /api2/json/learnable/{source}/{learnable}/{token} | Activate/deactivate learning from a source.
*AdminApi* | [**regions**](docs/AdminApi.md#regions) | **GET** /api2/json/regions | Print basic source statistics.
*AdminApi* | [**software_version**](docs/AdminApi.md#software_version) | **GET** /api2/json/softwareVersion | Get the current software version
*AdminApi* | [**taxonomy_classes**](docs/AdminApi.md#taxonomy_classes) | **GET** /api2/json/taxonomyClasses/{classifierName} | Print the taxonomy classes valid for the given classifier.
*ChineseApi* | [**chinese_name_candidates**](docs/ChineseApi.md#chinese_name_candidates) | **GET** /api2/json/chineseNameCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin} | Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming
Expand All @@ -110,6 +108,14 @@ Class | Method | HTTP request | Description
*GeneralApi* | [**name_type_batch**](docs/GeneralApi.md#name_type_batch) | **POST** /api2/json/nameTypeBatch | Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)
*GeneralApi* | [**name_type_geo**](docs/GeneralApi.md#name_type_geo) | **GET** /api2/json/nameTypeGeo/{properNoun}/{countryIso2} | Infer the likely type of a proper noun (personal name, brand name, place name etc.)
*GeneralApi* | [**name_type_geo_batch**](docs/GeneralApi.md#name_type_geo_batch) | **POST** /api2/json/nameTypeGeoBatch | Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)
*IndianApi* | [**castegroup_indian_full**](docs/IndianApi.md#castegroup_indian_full) | **GET** /api2/json/castegroupIndianFull/{subDivisionIso31662}/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of a personal full name.
*IndianApi* | [**castegroup_indian_full_batch**](docs/IndianApi.md#castegroup_indian_full_batch) | **POST** /api2/json/castegroupIndianFullBatch | [USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of up to 100 personal full names.
*IndianApi* | [**religion**](docs/IndianApi.md#religion) | **GET** /api2/json/religionIndianFull/{subDivisionIso31662}/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely religion of a personal Indian full name, provided the Indian state or Union territory (NB/ this can be inferred using the subclassification endpoint).
*IndianApi* | [**religion_indian_full_batch**](docs/IndianApi.md#religion_indian_full_batch) | **POST** /api2/json/religionIndianFullBatch | [USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal full Indian names, provided the subclassification at State or Union territory level (NB/ can be inferred using the subclassification endpoint).
*IndianApi* | [**subclassification_indian**](docs/IndianApi.md#subclassification_indian) | **GET** /api2/json/subclassificationIndian/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on the name.
*IndianApi* | [**subclassification_indian_batch**](docs/IndianApi.md#subclassification_indian_batch) | **POST** /api2/json/subclassificationIndianBatch | [USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on a list of up to 100 names.
*IndianApi* | [**subclassification_indian_full**](docs/IndianApi.md#subclassification_indian_full) | **GET** /api2/json/subclassificationIndianFull/{fullName} | [USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on the name.
*IndianApi* | [**subclassification_indian_full_batch**](docs/IndianApi.md#subclassification_indian_full_batch) | **POST** /api2/json/subclassificationIndianFullBatch | [USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on a list of up to 100 names.
*JapaneseApi* | [**gender_japanese_name_full**](docs/JapaneseApi.md#gender_japanese_name_full) | **GET** /api2/json/genderJapaneseNameFull/{japaneseName} | Infer the likely gender of a Japanese full name ex. 王晓明
*JapaneseApi* | [**gender_japanese_name_full_batch**](docs/JapaneseApi.md#gender_japanese_name_full_batch) | **POST** /api2/json/genderJapaneseNameFullBatch | Infer the likely gender of up to 100 full names
*JapaneseApi* | [**gender_japanese_name_pinyin**](docs/JapaneseApi.md#gender_japanese_name_pinyin) | **GET** /api2/json/genderJapaneseName/{japaneseSurname}/{japaneseGivenName} | Infer the likely gender of a Japanese name in LATIN (Pinyin).
Expand Down Expand Up @@ -146,8 +152,12 @@ Class | Method | HTTP request | Description
*PersonalApi* | [**parse_name_batch**](docs/PersonalApi.md#parse_name_batch) | **POST** /api2/json/parseNameBatch | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
*PersonalApi* | [**parse_name_geo**](docs/PersonalApi.md#parse_name_geo) | **GET** /api2/json/parseName/{nameFull}/{countryIso2} | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. For better accuracy, provide a geographic context.
*PersonalApi* | [**parse_name_geo_batch**](docs/PersonalApi.md#parse_name_geo_batch) | **POST** /api2/json/parseNameGeoBatch | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. Giving a local context improves precision.
*PersonalApi* | [**religion_full**](docs/PersonalApi.md#religion_full) | **GET** /api2/json/religionFull/{countryIso2}/{subDivisionIso31662}/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely religion of a personal full name. NB: only for INDIA (as of current version).
*PersonalApi* | [**religion_full_batch**](docs/PersonalApi.md#religion_full_batch) | **POST** /api2/json/religionFullBatch | [USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal full names. NB: only for India as of currently.
*PersonalApi* | [**subclassification**](docs/PersonalApi.md#subclassification) | **GET** /api2/json/subclassification/{countryIso2}/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely origin of a name at a country subclassification level (state or regeion). Initially, this is only supported for India (ISO2 code 'IN').
*PersonalApi* | [**subclassification_batch**](docs/PersonalApi.md#subclassification_batch) | **POST** /api2/json/subclassificationBatch | [USES 10 UNITS PER NAME] Infer the likely origin of a list of up to 100 names at a country subclassification level (state or regeion). Initially, this is only supported for India (ISO2 code 'IN').
*PersonalApi* | [**subclassification_full**](docs/PersonalApi.md#subclassification_full) | **GET** /api2/json/subclassificationFull/{countryIso2}/{fullName} | [USES 10 UNITS PER NAME] Infer the likely origin of a name at a country subclassification level (state or regeion). Initially, this is only supported for India (ISO2 code 'IN').
*PersonalApi* | [**subclassification_full_batch**](docs/PersonalApi.md#subclassification_full_batch) | **POST** /api2/json/subclassificationFullBatch | [USES 10 UNITS PER NAME] Infer the likely origin of a list of up to 100 names at a country subclassification level (state or regeion). Initially, this is only supported for India (ISO2 code 'IN').
*PersonalApi* | [**us_race_ethnicity**](docs/PersonalApi.md#us_race_ethnicity) | **GET** /api2/json/usRaceEthnicity/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander).
*PersonalApi* | [**us_race_ethnicity_batch**](docs/PersonalApi.md#us_race_ethnicity_batch) | **POST** /api2/json/usRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander).
*PersonalApi* | [**us_race_ethnicity_zip5**](docs/PersonalApi.md#us_race_ethnicity_zip5) | **GET** /api2/json/usRaceEthnicityZIP5/{firstName}/{lastName}/{zip5Code} | [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander).
Expand Down Expand Up @@ -192,14 +202,20 @@ Class | Method | HTTP request | Description
- [BatchNameIn](docs/BatchNameIn.md)
- [BatchNameMatchCandidatesOut](docs/BatchNameMatchCandidatesOut.md)
- [BatchNameMatchedOut](docs/BatchNameMatchedOut.md)
- [BatchPersonalNameCastegroupOut](docs/BatchPersonalNameCastegroupOut.md)
- [BatchPersonalNameGenderedOut](docs/BatchPersonalNameGenderedOut.md)
- [BatchPersonalNameGeoIn](docs/BatchPersonalNameGeoIn.md)
- [BatchPersonalNameGeoOut](docs/BatchPersonalNameGeoOut.md)
- [BatchPersonalNameGeoSubclassificationOut](docs/BatchPersonalNameGeoSubclassificationOut.md)
- [BatchPersonalNameGeoSubdivisionIn](docs/BatchPersonalNameGeoSubdivisionIn.md)
- [BatchPersonalNameIn](docs/BatchPersonalNameIn.md)
- [BatchPersonalNameParsedOut](docs/BatchPersonalNameParsedOut.md)
- [BatchPersonalNameReligionedOut](docs/BatchPersonalNameReligionedOut.md)
- [BatchPersonalNameSubdivisionIn](docs/BatchPersonalNameSubdivisionIn.md)
- [BatchProperNounCategorizedOut](docs/BatchProperNounCategorizedOut.md)
- [CorridorIn](docs/CorridorIn.md)
- [CorridorOut](docs/CorridorOut.md)
- [FactIn](docs/FactIn.md)
- [FeedbackLoopOut](docs/FeedbackLoopOut.md)
- [FirstLastNameDiasporaedOut](docs/FirstLastNameDiasporaedOut.md)
- [FirstLastNameGenderIn](docs/FirstLastNameGenderIn.md)
Expand All @@ -220,12 +236,20 @@ Class | Method | HTTP request | Description
- [NameMatchCandidateOut](docs/NameMatchCandidateOut.md)
- [NameMatchCandidatesOut](docs/NameMatchCandidatesOut.md)
- [NameMatchedOut](docs/NameMatchedOut.md)
- [PersonalNameCastegroupOut](docs/PersonalNameCastegroupOut.md)
- [PersonalNameGenderedOut](docs/PersonalNameGenderedOut.md)
- [PersonalNameGeoIn](docs/PersonalNameGeoIn.md)
- [PersonalNameGeoOut](docs/PersonalNameGeoOut.md)
- [PersonalNameGeoSubclassificationOut](docs/PersonalNameGeoSubclassificationOut.md)
- [PersonalNameGeoSubdivisionIn](docs/PersonalNameGeoSubdivisionIn.md)
- [PersonalNameIn](docs/PersonalNameIn.md)
- [PersonalNameParsedOut](docs/PersonalNameParsedOut.md)
- [PersonalNameReligionedOut](docs/PersonalNameReligionedOut.md)
- [PersonalNameSubdivisionIn](docs/PersonalNameSubdivisionIn.md)
- [ProperNounCategorizedOut](docs/ProperNounCategorizedOut.md)
- [RegionISO](docs/RegionISO.md)
- [RegionOut](docs/RegionOut.md)
- [ReligionStatOut](docs/ReligionStatOut.md)
- [SoftwareVersionOut](docs/SoftwareVersionOut.md)


Expand Down
2 changes: 1 addition & 1 deletion run-python.bash
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ echo update openapi-generator
./bin/utils/openapi-generator-cli.sh
rm -Rf ./namsor/client/python/*
echo run openapi-generator
java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate --git-repo-id namsor-python-sdk2 --git-user-id namsor --skip-validate-spec -i https://v2.namsor.com/NamSorAPIv2/api2/openapi.json -g python -o namsor/client/python --additional-properties packageVersion=2.0.18
java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate --git-repo-id namsor-python-sdk2 --git-user-id namsor --skip-validate-spec -i https://v2.namsor.com/NamSorAPIv2/api2/openapi.json -g python -o namsor/client/python --additional-properties packageVersion=2.0.26
#~/dropbox_uploader.sh upload namsor-sdk2-1.0.0.jar namsor-sdk2-1.0.0.jar
#~/dropbox_uploader.sh upload namsor-sdk2-1.0.0-javadoc.jar namsor-sdk2-1.0.0-javadoc.jar
#~/dropbox_uploader.sh upload namsor-sdk2-1.0.0-sources.jar namsor-sdk2-1.0.0-sources.jar
Expand Down
4 changes: 2 additions & 2 deletions setup.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. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. 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.18
OpenAPI spec version: 2.0.26
Contact: contact@namsor.com
Generated by: https://openapi-generator.tech
"""
Expand All @@ -14,7 +14,7 @@
from setuptools import setup, find_packages # noqa: H301

NAME = "openapi-client"
VERSION = "2.0.18"
VERSION = "2.0.26"
# To install the library, run the following
#
# python setup.py install
Expand Down

0 comments on commit bef9b2c

Please sign in to comment.