From 2fffac87e7a70a5c0a91c36eb7d928741a8f19d3 Mon Sep 17 00:00:00 2001 From: NamSor SAS Date: Sat, 17 Jul 2021 18:30:57 +0200 Subject: [PATCH] Minor update --- README.md | 86 +- docs/APIBillingPeriodUsageOut.md | 20 +- docs/APIClassifierOut.md | 10 +- docs/APIClassifierTaxonomyOut.md | 4 +- docs/APIClassifiersStatusOut.md | 2 +- docs/APICounterV2Out.md | 12 +- docs/APIKeyOut.md | 20 +- docs/APIPeriodUsageOut.md | 8 +- docs/APIPlanSubscriptionOut.md | 38 +- docs/APIServiceOut.md | 6 +- docs/APIServicesOut.md | 2 +- docs/APIUsageAggregatedOut.md | 16 +- docs/APIUsageHistoryOut.md | 10 + docs/AdminApi.md | 1646 +--------- docs/BatchCorridorOut.md | 2 +- docs/BatchFirstLastNameDiasporaedOut.md | 2 +- docs/BatchFirstLastNameGenderedOut.md | 2 +- docs/BatchFirstLastNameOriginedOut.md | 2 +- docs/BatchFirstLastNamePhoneCodedOut.md | 2 +- docs/BatchFirstLastNameUSRaceEthnicityOut.md | 2 +- docs/BatchNameMatchCandidatesOut.md | 2 +- docs/BatchNameMatchedOut.md | 2 +- docs/BatchPersonalNameGenderedOut.md | 2 +- docs/BatchPersonalNameGeoOut.md | 2 +- docs/BatchPersonalNameParsedOut.md | 2 +- docs/BatchProperNounCategorizedOut.md | 2 +- docs/ChineseApi.md | 30 +- docs/CorridorOut.md | 1 - docs/FeedbackLoopOut.md | 2 +- docs/FirstLastNameDiasporaedOut.md | 17 +- docs/FirstLastNameGenderIn.md | 2 +- docs/FirstLastNameGenderedOut.md | 9 +- docs/FirstLastNameOriginedOut.md | 15 +- docs/FirstLastNameOut.md | 5 +- docs/FirstLastNamePhoneCodedOut.md | 27 +- docs/FirstLastNameUSRaceEthnicityOut.md | 11 +- docs/JapaneseApi.md | 38 +- docs/NameMatchCandidateOut.md | 8 +- docs/NameMatchCandidatesOut.md | 9 +- docs/NameMatchedOut.md | 3 +- docs/PersonalApi.md | 134 +- docs/PersonalNameGenderedOut.md | 7 +- docs/PersonalNameGeoOut.md | 19 +- docs/PersonalNameParsedOut.md | 9 +- docs/ProperNounCategorizedOut.md | 9 +- docs/SoftwareVersionOut.md | 4 +- openapi_client/__init__.py | 30 +- openapi_client/api/admin_api.py | 2880 +---------------- openapi_client/api/chinese_api.py | 48 +- openapi_client/api/general_api.py | 4 +- openapi_client/api/japanese_api.py | 60 +- openapi_client/api/personal_api.py | 208 +- openapi_client/api/social_api.py | 4 +- openapi_client/api_client.py | 6 +- openapi_client/configuration.py | 8 +- openapi_client/models/__init__.py | 28 +- .../models/api_billing_period_usage_out.py | 24 +- openapi_client/models/api_classifier_out.py | 14 +- .../models/api_classifier_taxonomy_out.py | 8 +- .../models/api_classifiers_status_out.py | 6 +- openapi_client/models/api_counter_v2_out.py | 16 +- openapi_client/models/api_key_out.py | 24 +- openapi_client/models/api_period_usage_out.py | 12 +- .../models/api_plan_subscription_out.py | 42 +- openapi_client/models/api_service_out.py | 10 +- openapi_client/models/api_services_out.py | 6 +- .../models/api_usage_aggregated_out.py | 20 +- .../models/api_usage_history_out.py | 115 + openapi_client/models/batch_corridor_in.py | 4 +- openapi_client/models/batch_corridor_out.py | 6 +- .../batch_first_last_name_diasporaed_out.py | 6 +- .../models/batch_first_last_name_gender_in.py | 4 +- .../batch_first_last_name_gendered_out.py | 6 +- .../models/batch_first_last_name_geo_in.py | 4 +- .../batch_first_last_name_geo_zipped_in.py | 4 +- .../models/batch_first_last_name_in.py | 4 +- .../batch_first_last_name_origined_out.py | 6 +- .../batch_first_last_name_phone_coded_out.py | 6 +- ...tch_first_last_name_phone_number_geo_in.py | 4 +- .../batch_first_last_name_phone_number_in.py | 4 +- ...h_first_last_name_us_race_ethnicity_out.py | 6 +- ...batch_match_personal_first_last_name_in.py | 4 +- openapi_client/models/batch_name_geo_in.py | 4 +- openapi_client/models/batch_name_in.py | 4 +- .../models/batch_name_match_candidates_out.py | 6 +- .../models/batch_name_matched_out.py | 6 +- .../batch_personal_name_gendered_out.py | 6 +- .../models/batch_personal_name_geo_in.py | 4 +- .../models/batch_personal_name_geo_out.py | 6 +- .../models/batch_personal_name_in.py | 4 +- .../models/batch_personal_name_parsed_out.py | 6 +- .../batch_proper_noun_categorized_out.py | 6 +- openapi_client/models/corridor_in.py | 4 +- openapi_client/models/corridor_out.py | 36 +- openapi_client/models/feedback_loop_out.py | 6 +- .../models/first_last_name_diasporaed_out.py | 60 +- .../models/first_last_name_gender_in.py | 6 +- .../models/first_last_name_gendered_out.py | 48 +- .../models/first_last_name_geo_in.py | 4 +- .../models/first_last_name_geo_zipped_in.py | 4 +- openapi_client/models/first_last_name_in.py | 4 +- .../models/first_last_name_origined_out.py | 60 +- openapi_client/models/first_last_name_out.py | 40 +- .../models/first_last_name_phone_coded_out.py | 66 +- .../first_last_name_phone_number_geo_in.py | 4 +- .../models/first_last_name_phone_number_in.py | 4 +- .../first_last_name_us_race_ethnicity_out.py | 56 +- .../match_personal_first_last_name_in.py | 4 +- openapi_client/models/name_geo_in.py | 4 +- openapi_client/models/name_in.py | 4 +- .../models/name_match_candidate_out.py | 12 +- .../models/name_match_candidates_out.py | 44 +- openapi_client/models/name_matched_out.py | 38 +- .../models/personal_name_gendered_out.py | 46 +- openapi_client/models/personal_name_geo_in.py | 4 +- .../models/personal_name_geo_out.py | 58 +- openapi_client/models/personal_name_in.py | 4 +- .../models/personal_name_parsed_out.py | 48 +- .../models/proper_noun_categorized_out.py | 48 +- openapi_client/models/software_version_out.py | 8 +- openapi_client/rest.py | 4 +- run-python.bash | 2 +- setup.py | 8 +- test/test_admin_api.py | 210 +- test/test_api_billing_period_usage_out.py | 4 +- test/test_api_classifier_out.py | 4 +- test/test_api_classifier_taxonomy_out.py | 4 +- test/test_api_classifiers_status_out.py | 4 +- test/test_api_counter_v2_out.py | 4 +- test/test_api_key_out.py | 4 +- test/test_api_period_usage_out.py | 4 +- test/test_api_plan_subscription_out.py | 4 +- test/test_api_service_out.py | 4 +- test/test_api_services_out.py | 4 +- test/test_api_usage_aggregated_out.py | 4 +- test/test_api_usage_history_out.py | 40 + test/test_batch_corridor_in.py | 4 +- test/test_batch_corridor_out.py | 4 +- ...st_batch_first_last_name_diasporaed_out.py | 4 +- test/test_batch_first_last_name_gender_in.py | 4 +- ...test_batch_first_last_name_gendered_out.py | 4 +- test/test_batch_first_last_name_geo_in.py | 4 +- ...est_batch_first_last_name_geo_zipped_in.py | 4 +- test/test_batch_first_last_name_in.py | 4 +- ...test_batch_first_last_name_origined_out.py | 4 +- ...t_batch_first_last_name_phone_coded_out.py | 4 +- ...tch_first_last_name_phone_number_geo_in.py | 4 +- ...t_batch_first_last_name_phone_number_in.py | 4 +- ...h_first_last_name_us_race_ethnicity_out.py | 4 +- ...batch_match_personal_first_last_name_in.py | 4 +- test/test_batch_name_geo_in.py | 4 +- test/test_batch_name_in.py | 4 +- test/test_batch_name_match_candidates_out.py | 4 +- test/test_batch_name_matched_out.py | 4 +- test/test_batch_personal_name_gendered_out.py | 4 +- test/test_batch_personal_name_geo_in.py | 4 +- test/test_batch_personal_name_geo_out.py | 4 +- test/test_batch_personal_name_in.py | 4 +- test/test_batch_personal_name_parsed_out.py | 4 +- .../test_batch_proper_noun_categorized_out.py | 4 +- test/test_chinese_api.py | 4 +- test/test_corridor_in.py | 4 +- test/test_corridor_out.py | 4 +- test/test_feedback_loop_out.py | 4 +- test/test_first_last_name_diasporaed_out.py | 4 +- test/test_first_last_name_gender_in.py | 4 +- test/test_first_last_name_gendered_out.py | 4 +- test/test_first_last_name_geo_in.py | 4 +- test/test_first_last_name_geo_zipped_in.py | 4 +- test/test_first_last_name_in.py | 4 +- test/test_first_last_name_origined_out.py | 4 +- test/test_first_last_name_out.py | 4 +- test/test_first_last_name_phone_coded_out.py | 4 +- ...est_first_last_name_phone_number_geo_in.py | 4 +- test/test_first_last_name_phone_number_in.py | 4 +- ...t_first_last_name_us_race_ethnicity_out.py | 4 +- test/test_general_api.py | 4 +- test/test_japanese_api.py | 4 +- .../test_match_personal_first_last_name_in.py | 4 +- test/test_name_geo_in.py | 4 +- test/test_name_in.py | 4 +- test/test_name_match_candidate_out.py | 4 +- test/test_name_match_candidates_out.py | 4 +- test/test_name_matched_out.py | 4 +- test/test_personal_api.py | 26 +- test/test_personal_name_gendered_out.py | 4 +- test/test_personal_name_geo_in.py | 4 +- test/test_personal_name_geo_out.py | 4 +- test/test_personal_name_in.py | 4 +- test/test_personal_name_parsed_out.py | 4 +- test/test_proper_noun_categorized_out.py | 4 +- test/test_social_api.py | 4 +- test/test_software_version_out.py | 4 +- 193 files changed, 1304 insertions(+), 5934 deletions(-) create mode 100644 docs/APIUsageHistoryOut.md create mode 100644 openapi_client/models/api_usage_history_out.py create mode 100644 test/test_api_usage_history_out.py diff --git a/README.md b/README.md index 45a0b54..b5d3c07 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # openapi-client -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! +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! This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: 2.0.13 -- Package version: 2.0.13 +- API version: 2.0.15 +- Package version: 2.0.15 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [http://www.namsor.com/](http://www.namsor.com/) @@ -60,16 +60,14 @@ 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)) -api_key = 'api_key_example' # str | -usage_credits = 56 # int | -user_message = 'user_message_example' # str | +source = 'source_example' # str | +anonymized = True # bool | try: - # Add usage credits to an API Key. - api_response = api_instance.add_credits(api_key, usage_credits, user_message) - pprint(api_response) + # Activate/deactivate anonymization for a source. + api_instance.anonymize(source, anonymized) except ApiException as e: - print("Exception when calling AdminApi->add_credits: %s\n" % e) + print("Exception when calling AdminApi->anonymize: %s\n" % e) ``` @@ -79,44 +77,16 @@ All URIs are relative to *https://v2.namsor.com/NamSorAPIv2* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*AdminApi* | [**add_credits**](docs/AdminApi.md#add_credits) | **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* | [**api_status**](docs/AdminApi.md#api_status) | **GET** /api2/json/apiStatus | Prints the current status of the classifiers. +*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_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_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). -*AdminApi* | [**billing_info**](docs/AdminApi.md#billing_info) | **GET** /api2/json/billingInfo/{token} | Read the billing information (company name, address, phone, vat ID) -*AdminApi* | [**charge**](docs/AdminApi.md#charge) | **POST** /api2/json/charge | Create a Stripe Customer, based on a payment card token (from secure StripeJS) and email. -*AdminApi* | [**corporate_key**](docs/AdminApi.md#corporate_key) | **GET** /api2/json/corporateKey/{apiKey}/{corporate} | Setting an API Key to a corporate status. -*AdminApi* | [**debug_level**](docs/AdminApi.md#debug_level) | **GET** /api2/json/debugLevel/{logger}/{level} | Update debug level for a classifier -*AdminApi* | [**flush**](docs/AdminApi.md#flush) | **GET** /api2/json/flush | Flush counters. -*AdminApi* | [**invalidate_cache**](docs/AdminApi.md#invalidate_cache) | **GET** /api2/json/invalidateCache | Invalidate system caches. +*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* | [**namsor_counter**](docs/AdminApi.md#namsor_counter) | **GET** /api2/json/namsorCounter | Get the overall API counter -*AdminApi* | [**payment_info**](docs/AdminApi.md#payment_info) | **GET** /api2/json/paymentInfo/{token} | Get the Stripe payment information associated with the current google auth session token. -*AdminApi* | [**procure_key**](docs/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. -*AdminApi* | [**remove_user_account**](docs/AdminApi.md#remove_user_account) | **GET** /api2/json/removeUserAccount/{token} | Remove the user account. -*AdminApi* | [**remove_user_account_on_behalf**](docs/AdminApi.md#remove_user_account_on_behalf) | **GET** /api2/json/removeUserAccountOnBehalf/{apiKey} | Remove (on behalf) a user account. -*AdminApi* | [**shutdown**](docs/AdminApi.md#shutdown) | **GET** /api2/json/shutdown | Stop learning and shutdown system. *AdminApi* | [**software_version**](docs/AdminApi.md#software_version) | **GET** /api2/json/softwareVersion | Get the current software version -*AdminApi* | [**source_stats**](docs/AdminApi.md#source_stats) | **GET** /api2/json/sourceStats/{source} | Print basic source statistics. -*AdminApi* | [**stats**](docs/AdminApi.md#stats) | **GET** /api2/json/stats | Print basic system statistics. -*AdminApi* | [**stripe_connect**](docs/AdminApi.md#stripe_connect) | **GET** /api2/json/stripeConnect | Connects a Stripe Account. -*AdminApi* | [**subscribe_plan**](docs/AdminApi.md#subscribe_plan) | **GET** /api2/json/subscribePlan/{planName}/{token} | Subscribe to a give API plan, using the user's preferred or default currency. -*AdminApi* | [**subscribe_plan_on_behalf**](docs/AdminApi.md#subscribe_plan_on_behalf) | **GET** /api2/json/subscribePlanOnBehalf/{planName}/{apiKey} | Subscribe to a give API plan, using the user's preferred or default currency (admin only). *AdminApi* | [**taxonomy_classes**](docs/AdminApi.md#taxonomy_classes) | **GET** /api2/json/taxonomyClasses/{classifierName} | Print the taxonomy classes valid for the given classifier. -*AdminApi* | [**update_billing_info**](docs/AdminApi.md#update_billing_info) | **POST** /api2/json/updateBillingInfo/{token} | Sets or update the billing information (company name, address, phone, vat ID) -*AdminApi* | [**update_limit**](docs/AdminApi.md#update_limit) | **GET** /api2/json/updateLimit/{usageLimit}/{hardOrSoft}/{token} | Modifies the hard/soft limit on the API plan's overages (default is 0$ soft limit). -*AdminApi* | [**update_payment_default**](docs/AdminApi.md#update_payment_default) | **GET** /api2/json/updatePaymentDefault/{defautSourceId}/{token} | Update the default Stripe card associated with the current google auth session token. -*AdminApi* | [**user_info**](docs/AdminApi.md#user_info) | **GET** /api2/json/userInfo/{token} | Get the user profile associated with the current google auth session token. -*AdminApi* | [**verify_email**](docs/AdminApi.md#verify_email) | **GET** /api2/json/verifyEmail/{emailToken} | Verifies an email, based on token sent to that email -*AdminApi* | [**verify_remove_email**](docs/AdminApi.md#verify_remove_email) | **GET** /api2/json/verifyRemoveEmail/{emailToken} | Verifies an email, based on token sent to that email -*AdminApi* | [**vet**](docs/AdminApi.md#vet) | **GET** /api2/json/vetting/{source}/{vetted} | Vetting of a source. *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 *ChineseApi* | [**chinese_name_candidates_batch**](docs/ChineseApi.md#chinese_name_candidates_batch) | **POST** /api2/json/chineseNameCandidatesBatch | Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming *ChineseApi* | [**chinese_name_candidates_gender_batch**](docs/ChineseApi.md#chinese_name_candidates_gender_batch) | **POST** /api2/json/chineseNameCandidatesGenderBatch | Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname) ex. Wang Xiaoming. @@ -170,12 +140,10 @@ 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* | [**parsed_gender_batch**](docs/PersonalApi.md#parsed_gender_batch) | **POST** /api2/json/parsedGenderBatch | Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. -*PersonalApi* | [**parsed_gender_geo_batch**](docs/PersonalApi.md#parsed_gender_geo_batch) | **POST** /api2/json/parsedGenderGeoBatch | Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. -*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). -*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. -*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). -*PersonalApi* | [**us_zip_race_ethnicity_batch**](docs/PersonalApi.md#us_zip_race_ethnicity_batch) | **POST** /api2/json/usZipRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. +*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). +*PersonalApi* | [**us_zip_race_ethnicity_batch**](docs/PersonalApi.md#us_zip_race_ethnicity_batch) | **POST** /api2/json/usZipRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. 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). *SocialApi* | [**phone_code**](docs/SocialApi.md#phone_code) | **GET** /api2/json/phoneCode/{firstName}/{lastName}/{phoneNumber} | [USES 11 UNITS PER NAME] Infer the likely country and phone prefix, given a personal name and formatted / unformatted phone number. *SocialApi* | [**phone_code_batch**](docs/SocialApi.md#phone_code_batch) | **POST** /api2/json/phoneCodeBatch | [USES 11 UNITS PER NAME] Infer the likely country and phone prefix, of up to 100 personal names, detecting automatically the local context given a name and formatted / unformatted phone number. *SocialApi* | [**phone_code_geo**](docs/SocialApi.md#phone_code_geo) | **GET** /api2/json/phoneCodeGeo/{firstName}/{lastName}/{phoneNumber}/{countryIso2} | [USES 11 UNITS PER NAME] Infer the likely phone prefix, given a personal name and formatted / unformatted phone number, with a local context (ISO2 country of residence). @@ -192,12 +160,11 @@ Class | Method | HTTP request | Description - [APICounterV2Out](docs/APICounterV2Out.md) - [APIKeyOut](docs/APIKeyOut.md) - [APIPeriodUsageOut](docs/APIPeriodUsageOut.md) - - [APIPlanOut](docs/APIPlanOut.md) - [APIPlanSubscriptionOut](docs/APIPlanSubscriptionOut.md) - - [APIPlansOut](docs/APIPlansOut.md) - [APIServiceOut](docs/APIServiceOut.md) - [APIServicesOut](docs/APIServicesOut.md) - [APIUsageAggregatedOut](docs/APIUsageAggregatedOut.md) + - [APIUsageHistoryOut](docs/APIUsageHistoryOut.md) - [BatchCorridorIn](docs/BatchCorridorIn.md) - [BatchCorridorOut](docs/BatchCorridorOut.md) - [BatchFirstLastNameDiasporaedOut](docs/BatchFirstLastNameDiasporaedOut.md) @@ -216,22 +183,14 @@ Class | Method | HTTP request | Description - [BatchNameIn](docs/BatchNameIn.md) - [BatchNameMatchCandidatesOut](docs/BatchNameMatchCandidatesOut.md) - [BatchNameMatchedOut](docs/BatchNameMatchedOut.md) - - [BatchParsedFullNameGeoIn](docs/BatchParsedFullNameGeoIn.md) - - [BatchParsedFullNameIn](docs/BatchParsedFullNameIn.md) - [BatchPersonalNameGenderedOut](docs/BatchPersonalNameGenderedOut.md) - [BatchPersonalNameGeoIn](docs/BatchPersonalNameGeoIn.md) - [BatchPersonalNameGeoOut](docs/BatchPersonalNameGeoOut.md) - [BatchPersonalNameIn](docs/BatchPersonalNameIn.md) - [BatchPersonalNameParsedOut](docs/BatchPersonalNameParsedOut.md) - [BatchProperNounCategorizedOut](docs/BatchProperNounCategorizedOut.md) - - [BillingHistoryOut](docs/BillingHistoryOut.md) - - [BillingInfoInOut](docs/BillingInfoInOut.md) - - [CacheMetricsOut](docs/CacheMetricsOut.md) - - [ClassifierMetricsOut](docs/ClassifierMetricsOut.md) - [CorridorIn](docs/CorridorIn.md) - [CorridorOut](docs/CorridorOut.md) - - [CurrenciesOut](docs/CurrenciesOut.md) - - [ExpectedClassMetricsOut](docs/ExpectedClassMetricsOut.md) - [FeedbackLoopOut](docs/FeedbackLoopOut.md) - [FirstLastNameDiasporaedOut](docs/FirstLastNameDiasporaedOut.md) - [FirstLastNameGenderIn](docs/FirstLastNameGenderIn.md) @@ -245,32 +204,19 @@ Class | Method | HTTP request | Description - [FirstLastNamePhoneNumberGeoIn](docs/FirstLastNamePhoneNumberGeoIn.md) - [FirstLastNamePhoneNumberIn](docs/FirstLastNamePhoneNumberIn.md) - [FirstLastNameUSRaceEthnicityOut](docs/FirstLastNameUSRaceEthnicityOut.md) - - [InlineObject](docs/InlineObject.md) - - [InvoiceItemOut](docs/InvoiceItemOut.md) - - [InvoiceOut](docs/InvoiceOut.md) - [MatchPersonalFirstLastNameIn](docs/MatchPersonalFirstLastNameIn.md) - - [NamSorCounterOut](docs/NamSorCounterOut.md) - [NameGeoIn](docs/NameGeoIn.md) - [NameIn](docs/NameIn.md) - [NameMatchCandidateOut](docs/NameMatchCandidateOut.md) - [NameMatchCandidatesOut](docs/NameMatchCandidatesOut.md) - [NameMatchedOut](docs/NameMatchedOut.md) - - [ParsedFullNameGeoIn](docs/ParsedFullNameGeoIn.md) - - [ParsedFullNameIn](docs/ParsedFullNameIn.md) - [PersonalNameGenderedOut](docs/PersonalNameGenderedOut.md) - [PersonalNameGeoIn](docs/PersonalNameGeoIn.md) - [PersonalNameGeoOut](docs/PersonalNameGeoOut.md) - [PersonalNameIn](docs/PersonalNameIn.md) - [PersonalNameParsedOut](docs/PersonalNameParsedOut.md) - [ProperNounCategorizedOut](docs/ProperNounCategorizedOut.md) - - [RomanizedNameOut](docs/RomanizedNameOut.md) - [SoftwareVersionOut](docs/SoftwareVersionOut.md) - - [SourceDetailedMetricsOut](docs/SourceDetailedMetricsOut.md) - - [SourceMetricsOut](docs/SourceMetricsOut.md) - - [StripeCardOut](docs/StripeCardOut.md) - - [StripeCustomerOut](docs/StripeCustomerOut.md) - - [SystemMetricsOut](docs/SystemMetricsOut.md) - - [UserInfoOut](docs/UserInfoOut.md) ## Documentation For Authorization diff --git a/docs/APIBillingPeriodUsageOut.md b/docs/APIBillingPeriodUsageOut.md index 6544692..b2cdd44 100644 --- a/docs/APIBillingPeriodUsageOut.md +++ b/docs/APIBillingPeriodUsageOut.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**api_key** | **str** | | [optional] -**subscription_started** | **int** | | [optional] -**period_started** | **int** | | [optional] -**period_ended** | **int** | | [optional] -**stripe_current_period_end** | **int** | | [optional] -**stripe_current_period_start** | **int** | | [optional] -**billing_status** | **str** | | [optional] -**usage** | **int** | | [optional] -**soft_limit** | **int** | | [optional] -**hard_limit** | **int** | | [optional] +**api_key** | **str** | User API Key. | [optional] +**subscription_started** | **int** | Datetime when the user subscribed to the plan. | [optional] +**period_started** | **int** | Datetime when the the plan's current period started. | [optional] +**period_ended** | **int** | Datetime when the the plan's current period endend. | [optional] +**stripe_current_period_end** | **int** | Datetime when the the plan's current period endend (in Stripe). Internal and Stripe periodicity should ~coincide. | [optional] +**stripe_current_period_start** | **int** | Datetime when the the plan's current period started (in Stripe). Internal and Stripe periodicity should ~coincide. | [optional] +**billing_status** | **str** | Current period billing status ex OPEN. | [optional] +**usage** | **int** | Current period usage in units (NB some API endpoints use more than one unit). | [optional] +**soft_limit** | **int** | Current period soft limit (reaching the limit sends an email notification). | [optional] +**hard_limit** | **int** | Current period hard limit (reaching the limit sends an email notification and blocks the API Key). | [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) diff --git a/docs/APIClassifierOut.md b/docs/APIClassifierOut.md index 4a06be0..c70d6a7 100644 --- a/docs/APIClassifierOut.md +++ b/docs/APIClassifierOut.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**classifier_name** | **str** | | [optional] -**serving** | **bool** | | [optional] -**learning** | **bool** | | [optional] -**shutting_down** | **bool** | | [optional] -**probability_calibrated** | **bool** | | [optional] +**classifier_name** | **str** | The classifier name | [optional] +**serving** | **bool** | True if the classifier is serving requests (has reached minimal learning, is not shutting down) | [optional] +**learning** | **bool** | True if the classifier is learning | [optional] +**shutting_down** | **bool** | True if the classifier is shutting down | [optional] +**probability_calibrated** | **bool** | True if the classifier has finished the initial learning and calibrated probabilities (meanwhile, during initial learning, probabilities will be equal to -1) | [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) diff --git a/docs/APIClassifierTaxonomyOut.md b/docs/APIClassifierTaxonomyOut.md index a5b97d0..8fa92a9 100644 --- a/docs/APIClassifierTaxonomyOut.md +++ b/docs/APIClassifierTaxonomyOut.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**classifier_name** | **str** | | [optional] -**taxonomy_classes** | **list[str]** | | [optional] +**classifier_name** | **str** | Name of the classifier as per apiStatus (corresponds also to the name of the service in apiServices) | [optional] +**taxonomy_classes** | **list[str]** | The taxonomy classes this classifier classifies to | [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) diff --git a/docs/APIClassifiersStatusOut.md b/docs/APIClassifiersStatusOut.md index 532ef2c..2cd2e27 100644 --- a/docs/APIClassifiersStatusOut.md +++ b/docs/APIClassifiersStatusOut.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **software_version** | [**SoftwareVersionOut**](SoftwareVersionOut.md) | | [optional] -**classifiers** | [**list[APIClassifierOut]**](APIClassifierOut.md) | | [optional] +**classifiers** | [**list[APIClassifierOut]**](APIClassifierOut.md) | The list of classifiers and versions. | [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) diff --git a/docs/APICounterV2Out.md b/docs/APICounterV2Out.md index 8d56f65..204586b 100644 --- a/docs/APICounterV2Out.md +++ b/docs/APICounterV2Out.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **api_key** | [**APIKeyOut**](APIKeyOut.md) | | [optional] -**api_service** | **str** | | [optional] -**created_date_time** | **int** | | [optional] -**total_usage** | **int** | | [optional] -**last_flushed_date_time** | **int** | | [optional] -**last_used_date_time** | **int** | | [optional] -**service_features_usage** | **dict(str, int)** | | [optional] +**api_service** | **str** | The apiService corresponds to the classifier name. | [optional] +**created_date_time** | **int** | The create datetime of the counter. | [optional] +**total_usage** | **int** | The usage of the counter. | [optional] +**last_flushed_date_time** | **int** | The flush datetime of the counter. | [optional] +**last_used_date_time** | **int** | The last usage datetime of the counter. | [optional] +**service_features_usage** | **dict(str, int)** | Usage of special features, such as Chinese, Japanese. | [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) diff --git a/docs/APIKeyOut.md b/docs/APIKeyOut.md index 4f05d8e..8427952 100644 --- a/docs/APIKeyOut.md +++ b/docs/APIKeyOut.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**api_key** | **str** | | [optional] -**user_id** | **str** | | [optional] -**admin** | **bool** | | [optional] -**vetted** | **bool** | | [optional] -**learnable** | **bool** | | [optional] -**anonymized** | **bool** | | [optional] -**partner** | **bool** | | [optional] -**striped** | **bool** | | [optional] -**corporate** | **bool** | | [optional] -**disabled** | **bool** | | [optional] +**api_key** | **str** | The user API Key. | [optional] +**user_id** | **str** | The user identifier. | [optional] +**admin** | **bool** | The API Key has admin role. | [optional] +**vetted** | **bool** | The API Key is vetted (assumed truthful) for machine learning. | [optional] +**learnable** | **bool** | The API Key is learnable (without assuming truthfulness) for machine learning. Set learnable=false and anonymized=true for highest privacy (ie. to forget data as it's processed). | [optional] +**anonymized** | **bool** | The API Key is anonymized (using SHA-252 digest for logging). Set learnable=false and anonymized=true for highest privacy (ie. to forget data as it's processed). | [optional] +**partner** | **bool** | The API Key has partner role. | [optional] +**striped** | **bool** | The API Key is associated to a valid Stripe account. | [optional] +**corporate** | **bool** | The API Key has role corporate (ex SWIFT payments instead of Stripe payments). | [optional] +**disabled** | **bool** | The API Key is temporarily or permanently disabled. | [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) diff --git a/docs/APIPeriodUsageOut.md b/docs/APIPeriodUsageOut.md index c420826..6b0ac18 100644 --- a/docs/APIPeriodUsageOut.md +++ b/docs/APIPeriodUsageOut.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **subscription** | [**APIPlanSubscriptionOut**](APIPlanSubscriptionOut.md) | | [optional] **billing_period** | [**APIBillingPeriodUsageOut**](APIBillingPeriodUsageOut.md) | | [optional] -**overage_excl_tax** | **float** | | [optional] -**overage_incl_tax** | **float** | | [optional] -**overage_currency** | **str** | | [optional] -**overage_quantity** | **int** | | [optional] +**overage_excl_tax** | **float** | Overage amount including any tax. | [optional] +**overage_incl_tax** | **float** | Overage amount including tax (if applicable). | [optional] +**overage_currency** | **str** | Currency of the overage amount. | [optional] +**overage_quantity** | **int** | Quantity above monthly quota of the current subscritpion, in units. | [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) diff --git a/docs/APIPlanSubscriptionOut.md b/docs/APIPlanSubscriptionOut.md index 5acc51e..2807059 100644 --- a/docs/APIPlanSubscriptionOut.md +++ b/docs/APIPlanSubscriptionOut.md @@ -3,25 +3,25 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**api_key** | **str** | | [optional] -**plan_started** | **int** | | [optional] -**prior_plan_started** | **int** | | [optional] -**plan_ended** | **int** | | [optional] -**tax_rate** | **float** | | [optional] -**plan_name** | **str** | | [optional] -**plan_base_fees_key** | **str** | | [optional] -**plan_status** | **str** | | [optional] -**plan_quota** | **int** | | [optional] -**price_usd** | **float** | | [optional] -**price_overage_usd** | **float** | | [optional] -**price** | **float** | | [optional] -**price_overage** | **float** | | [optional] -**currency** | **str** | | [optional] -**currency_factor** | **float** | | [optional] -**stripe_customer_id** | **str** | | [optional] -**stripe_status** | **str** | | [optional] -**stripe_subscription** | **str** | | [optional] -**user_id** | **str** | | [optional] +**api_key** | **str** | User API Key. | [optional] +**plan_started** | **int** | Datetime when the user subscribed to the current plan. | [optional] +**prior_plan_started** | **int** | Datetime when the user subscribed to the prior plan. | [optional] +**plan_ended** | **int** | Datetime when the user ended the plan. | [optional] +**tax_rate** | **float** | Applicable tax rate for the plan. | [optional] +**plan_name** | **str** | Current plan name. | [optional] +**plan_base_fees_key** | **str** | Current plan key (as in Stripe product). | [optional] +**plan_status** | **str** | Plan status. | [optional] +**plan_quota** | **int** | Current plan quota in quantity of units (NB: some API use several units per name). | [optional] +**price_usd** | **float** | Current plan monthly price expressed in USD (includes a free quota). | [optional] +**price_overage_usd** | **float** | Current plan price for overages expressed in USD (extra price per unit above the free quota). | [optional] +**price** | **float** | Current plan price for overages expressed in Currency (extra price per unit above the free quota). | [optional] +**price_overage** | **float** | Current plan price for overages expressed in Currency (extra price per unit above the free quota). | [optional] +**currency** | **str** | Current plan Currency for prices. | [optional] +**currency_factor** | **float** | For USD, GBP, EUR - the factor is 1. | [optional] +**stripe_customer_id** | **str** | Stripe customer identifier. | [optional] +**stripe_status** | **str** | Stripe status ex active. | [optional] +**stripe_subscription** | **str** | Stripe subscription identifier. | [optional] +**user_id** | **str** | Internal user identifier. | [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) diff --git a/docs/APIServiceOut.md b/docs/APIServiceOut.md index 0852bed..8e01b5f 100644 --- a/docs/APIServiceOut.md +++ b/docs/APIServiceOut.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**service_name** | **str** | | [optional] -**service_group** | **str** | | [optional] -**cost_in_units** | **int** | | [optional] +**service_name** | **str** | A service name corresponds to classifier name in apiStatus (ex. personalname_gender or personalfullname_gender) | [optional] +**service_group** | **str** | Groups together classifiers providing a similar service (ex. gender groups personalname_gender and personalfullname_gender) | [optional] +**cost_in_units** | **int** | Indicates how many units per call this service costs (ex. the number of units per name) | [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) diff --git a/docs/APIServicesOut.md b/docs/APIServicesOut.md index 88ecd30..d316b3a 100644 --- a/docs/APIServicesOut.md +++ b/docs/APIServicesOut.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**api_services** | [**list[APIServiceOut]**](APIServiceOut.md) | | [optional] +**api_services** | [**list[APIServiceOut]**](APIServiceOut.md) | List of API Services | [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) diff --git a/docs/APIUsageAggregatedOut.md b/docs/APIUsageAggregatedOut.md index 184c3bd..5521eba 100644 --- a/docs/APIUsageAggregatedOut.md +++ b/docs/APIUsageAggregatedOut.md @@ -3,14 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time_unit** | **str** | | [optional] -**period_start** | **int** | | [optional] -**period_end** | **int** | | [optional] -**total_usage** | **int** | | [optional] -**history_truncated** | **bool** | | [optional] -**data** | **list[list[int]]** | | [optional] -**col_headers** | **list[str]** | | [optional] -**row_headers** | **list[str]** | | [optional] +**time_unit** | **str** | Time unit is DAY, WEEK or MONTH depending on prior usage | [optional] +**period_start** | **int** | Start datetime of the reporting period | [optional] +**period_end** | **int** | End datetime of the reporting period | [optional] +**total_usage** | **int** | Total usage in the current period | [optional] +**history_truncated** | **bool** | If the history was truncaded due to data limit | [optional] +**data** | **list[list[int]]** | Data points : usage per DAY, WEEK or MONTH and per apiService | [optional] +**col_headers** | **list[str]** | apiServices as column headers | [optional] +**row_headers** | **list[str]** | dates as row headers | [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) diff --git a/docs/APIUsageHistoryOut.md b/docs/APIUsageHistoryOut.md new file mode 100644 index 0000000..5986e8f --- /dev/null +++ b/docs/APIUsageHistoryOut.md @@ -0,0 +1,10 @@ +# APIUsageHistoryOut + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailed_usage** | [**list[APICounterV2Out]**](APICounterV2Out.md) | Detailed usage as reported by the deduplicating API counter. | [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) + + diff --git a/docs/AdminApi.md b/docs/AdminApi.md index dd0c369..d080567 100644 --- a/docs/AdminApi.md +++ b/docs/AdminApi.md @@ -4,104 +4,18 @@ All URIs are relative to *https://v2.namsor.com/NamSorAPIv2* Method | HTTP request | Description ------------- | ------------- | ------------- -[**add_credits**](AdminApi.md#add_credits) | **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. -[**api_status**](AdminApi.md#api_status) | **GET** /api2/json/apiStatus | Prints the current status of the classifiers. +[**api_status**](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. [**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_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). -[**billing_info**](AdminApi.md#billing_info) | **GET** /api2/json/billingInfo/{token} | Read the billing information (company name, address, phone, vat ID) -[**charge**](AdminApi.md#charge) | **POST** /api2/json/charge | Create a Stripe Customer, based on a payment card token (from secure StripeJS) and email. -[**corporate_key**](AdminApi.md#corporate_key) | **GET** /api2/json/corporateKey/{apiKey}/{corporate} | Setting an API Key to a corporate status. -[**debug_level**](AdminApi.md#debug_level) | **GET** /api2/json/debugLevel/{logger}/{level} | Update debug level for a classifier -[**flush**](AdminApi.md#flush) | **GET** /api2/json/flush | Flush counters. -[**invalidate_cache**](AdminApi.md#invalidate_cache) | **GET** /api2/json/invalidateCache | Invalidate system caches. +[**available_services**](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. +[**disable**](AdminApi.md#disable) | **GET** /api2/json/disable/{source}/{disabled} | Activate/deactivate an API Key. [**learnable**](AdminApi.md#learnable) | **GET** /api2/json/learnable/{source}/{learnable} | Activate/deactivate learning from a source. -[**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. -[**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. [**software_version**](AdminApi.md#software_version) | **GET** /api2/json/softwareVersion | Get the current software version -[**source_stats**](AdminApi.md#source_stats) | **GET** /api2/json/sourceStats/{source} | Print basic source statistics. -[**stats**](AdminApi.md#stats) | **GET** /api2/json/stats | Print basic system statistics. -[**stripe_connect**](AdminApi.md#stripe_connect) | **GET** /api2/json/stripeConnect | Connects a Stripe Account. -[**subscribe_plan**](AdminApi.md#subscribe_plan) | **GET** /api2/json/subscribePlan/{planName}/{token} | Subscribe to a give API plan, using the user's preferred or default currency. -[**subscribe_plan_on_behalf**](AdminApi.md#subscribe_plan_on_behalf) | **GET** /api2/json/subscribePlanOnBehalf/{planName}/{apiKey} | Subscribe to a give API plan, using the user's preferred or default currency (admin only). [**taxonomy_classes**](AdminApi.md#taxonomy_classes) | **GET** /api2/json/taxonomyClasses/{classifierName} | Print the taxonomy classes valid for the given classifier. -[**update_billing_info**](AdminApi.md#update_billing_info) | **POST** /api2/json/updateBillingInfo/{token} | Sets or update the billing information (company name, address, phone, vat ID) -[**update_limit**](AdminApi.md#update_limit) | **GET** /api2/json/updateLimit/{usageLimit}/{hardOrSoft}/{token} | Modifies the hard/soft limit on the API plan's overages (default is 0$ soft limit). -[**update_payment_default**](AdminApi.md#update_payment_default) | **GET** /api2/json/updatePaymentDefault/{defautSourceId}/{token} | Update the default Stripe card associated with the current google auth session token. -[**user_info**](AdminApi.md#user_info) | **GET** /api2/json/userInfo/{token} | Get the user profile associated with the current google auth session token. -[**verify_email**](AdminApi.md#verify_email) | **GET** /api2/json/verifyEmail/{emailToken} | Verifies an email, based on token sent to that email -[**verify_remove_email**](AdminApi.md#verify_remove_email) | **GET** /api2/json/verifyRemoveEmail/{emailToken} | Verifies an email, based on token sent to that email -[**vet**](AdminApi.md#vet) | **GET** /api2/json/vetting/{source}/{vetted} | Vetting of a source. -# **add_credits** -> SystemMetricsOut add_credits(api_key, usage_credits, user_message) - -Add usage credits to an API Key. - -### 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)) -api_key = 'api_key_example' # str | -usage_credits = 56 # int | -user_message = 'user_message_example' # str | - -try: - # Add usage credits to an API Key. - api_response = api_instance.add_credits(api_key, usage_credits, user_message) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->add_credits: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **api_key** | **str**| | - **usage_credits** | **int**| | - **user_message** | **str**| | - -### Return type - -[**SystemMetricsOut**](SystemMetricsOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - # **anonymize** > anonymize(source, anonymized) @@ -158,9 +72,9 @@ void (empty response body) [[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) # **api_status** -> APIPlansOut api_status() +> APIClassifiersStatusOut api_status() -Prints the current status of the classifiers. +Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices. ### Example @@ -182,7 +96,7 @@ configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY' api_instance = openapi_client.AdminApi(openapi_client.ApiClient(configuration)) try: - # Prints the current status of the classifiers. + # Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices. api_response = api_instance.api_status() pprint(api_response) except ApiException as e: @@ -194,7 +108,7 @@ This endpoint does not need any parameter. ### Return type -[**APIPlansOut**](APIPlansOut.md) +[**APIClassifiersStatusOut**](APIClassifiersStatusOut.md) ### Authorization @@ -258,7 +172,7 @@ 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) # **api_usage_history** -> APIPeriodUsageOut api_usage_history() +> APIUsageHistoryOut api_usage_history() Print historical API usage. @@ -294,7 +208,7 @@ This endpoint does not need any parameter. ### Return type -[**APIPeriodUsageOut**](APIPeriodUsageOut.md) +[**APIUsageHistoryOut**](APIUsageHistoryOut.md) ### Authorization @@ -308,7 +222,7 @@ 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) # **api_usage_history_aggregate** -> APIPeriodUsageOut api_usage_history_aggregate() +> APIUsageAggregatedOut api_usage_history_aggregate() Print historical API usage (in an aggregated view, by service, by day/hour/min). @@ -344,111 +258,7 @@ This endpoint does not need any parameter. ### Return type -[**APIPeriodUsageOut**](APIPeriodUsageOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -List all available plans in the user's preferred currency. - -### 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)) -token = 'token_example' # str | - -try: - # List all available plans in the user's preferred currency. - api_response = api_instance.available_plans(token) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->available_plans: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **token** | **str**| | - -### Return type - -[**APIPlansOut**](APIPlansOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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() - -List all available plans in the default currency (usd). - -### 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: - # List all available plans in the default currency (usd). - api_response = api_instance.available_plans1() - 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. - -### Return type - -[**APIPlansOut**](APIPlansOut.md) +[**APIUsageAggregatedOut**](APIUsageAggregatedOut.md) ### Authorization @@ -462,9 +272,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_services** -> APIPlansOut available_services() +> APIServicesOut available_services() -List of API services and usage cost in Units (default is 1=ONE Unit). +List of classification services and usage cost in Units per classification (default is 1=ONE Unit). Some API endpoints (ex. Corridor) combine multiple classifiers. ### Example @@ -486,7 +296,7 @@ configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY' api_instance = openapi_client.AdminApi(openapi_client.ApiClient(configuration)) try: - # List of API services and usage cost in Units (default is 1=ONE Unit). + # List of classification services and usage cost in Units per classification (default is 1=ONE Unit). Some API endpoints (ex. Corridor) combine multiple classifiers. api_response = api_instance.available_services() pprint(api_response) except ApiException as e: @@ -498,57 +308,7 @@ 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 - -[[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) - -# **billing_currencies** -> CurrenciesOut billing_currencies() - -List possible currency options for billing (USD, EUR, GBP, ...) - -### 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: - # List possible currency options for billing (USD, EUR, GBP, ...) - api_response = api_instance.billing_currencies() - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->billing_currencies: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**CurrenciesOut**](CurrenciesOut.md) +[**APIServicesOut**](APIServicesOut.md) ### Authorization @@ -561,10 +321,10 @@ 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) -# **billing_history** -> BillingHistoryOut billing_history(token) +# **disable** +> disable(source, disabled) -Read the history billing information (invoices paid via Stripe or manually). +Activate/deactivate an API Key. ### Example @@ -584,25 +344,26 @@ 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 | +source = 'source_example' # str | The API Key to set as enabled/disabled. +disabled = True # bool | try: - # Read the history billing information (invoices paid via Stripe or manually). - api_response = api_instance.billing_history(token) - pprint(api_response) + # Activate/deactivate an API Key. + api_instance.disable(source, disabled) except ApiException as e: - print("Exception when calling AdminApi->billing_history: %s\n" % e) + print("Exception when calling AdminApi->disable: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **token** | **str**| | + **source** | **str**| The API Key to set as enabled/disabled. | + **disabled** | **bool**| | ### Return type -[**BillingHistoryOut**](BillingHistoryOut.md) +void (empty response body) ### Authorization @@ -611,14 +372,14 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **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) -# **billing_info** -> BillingInfoInOut billing_info(token) +# **learnable** +> learnable(source, learnable) -Read the billing information (company name, address, phone, vat ID) +Activate/deactivate learning from a source. ### Example @@ -638,25 +399,26 @@ 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 | +source = 'source_example' # str | The API Key to set as learnable/non learnable. +learnable = True # bool | try: - # Read the billing information (company name, address, phone, vat ID) - api_response = api_instance.billing_info(token) - pprint(api_response) + # Activate/deactivate learning from a source. + api_instance.learnable(source, learnable) except ApiException as e: - print("Exception when calling AdminApi->billing_info: %s\n" % e) + print("Exception when calling AdminApi->learnable: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **token** | **str**| | + **source** | **str**| The API Key to set as learnable/non learnable. | + **learnable** | **bool**| | ### Return type -[**BillingInfoInOut**](BillingInfoInOut.md) +void (empty response body) ### Authorization @@ -665,14 +427,14 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **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) -# **charge** -> APIKeyOut charge(inline_object=inline_object) +# **software_version** +> SoftwareVersionOut software_version() -Create a Stripe Customer, based on a payment card token (from secure StripeJS) and email. +Get the current software version ### Example @@ -692,25 +454,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)) -inline_object = openapi_client.InlineObject() # InlineObject | (optional) try: - # Create a Stripe Customer, based on a payment card token (from secure StripeJS) and email. - api_response = api_instance.charge(inline_object=inline_object) + # Get the current software version + api_response = api_instance.software_version() pprint(api_response) except ApiException as e: - print("Exception when calling AdminApi->charge: %s\n" % e) + print("Exception when calling AdminApi->software_version: %s\n" % e) ``` ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **inline_object** | [**InlineObject**](InlineObject.md)| | [optional] +This endpoint does not need any parameter. ### Return type -[**APIKeyOut**](APIKeyOut.md) +[**SoftwareVersionOut**](SoftwareVersionOut.md) ### Authorization @@ -723,10 +481,10 @@ 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) -# **corporate_key** -> corporate_key(api_key, corporate) +# **taxonomy_classes** +> APIClassifierTaxonomyOut taxonomy_classes(classifier_name) -Setting an API Key to a corporate status. +Print the taxonomy classes valid for the given classifier. ### Example @@ -746,1260 +504,25 @@ 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)) -api_key = 'api_key_example' # str | -corporate = True # bool | +classifier_name = 'classifier_name_example' # str | try: - # Setting an API Key to a corporate status. - api_instance.corporate_key(api_key, corporate) + # Print the taxonomy classes valid for the given classifier. + api_response = api_instance.taxonomy_classes(classifier_name) + pprint(api_response) except ApiException as e: - print("Exception when calling AdminApi->corporate_key: %s\n" % e) + print("Exception when calling AdminApi->taxonomy_classes: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **api_key** | **str**| | - **corporate** | **bool**| | + **classifier_name** | **str**| | ### 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) - -# **debug_level** -> debug_level(logger, level) - -Update debug level for a classifier - -### 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)) -logger = 'logger_example' # str | -level = 'level_example' # str | - -try: - # Update debug level for a classifier - api_instance.debug_level(logger, level) -except ApiException as e: - print("Exception when calling AdminApi->debug_level: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **logger** | **str**| | - **level** | **str**| | - -### 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) - -# **flush** -> flush() - -Flush counters. - -### 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: - # Flush counters. - api_instance.flush() -except ApiException as e: - print("Exception when calling AdminApi->flush: %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) - -# **invalidate_cache** -> invalidate_cache() - -Invalidate system caches. - -### 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: - # Invalidate system caches. - api_instance.invalidate_cache() -except ApiException as e: - print("Exception when calling AdminApi->invalidate_cache: %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) - -# **learnable** -> learnable(source, learnable) - -Activate/deactivate learning from a source. - -### 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)) -source = 'source_example' # str | -learnable = True # bool | - -try: - # Activate/deactivate learning from a source. - api_instance.learnable(source, learnable) -except ApiException as e: - print("Exception when calling AdminApi->learnable: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **source** | **str**| | - **learnable** | **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) - -# **namsor_counter** -> SoftwareVersionOut namsor_counter() - -Get the overall API counter - -### 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: - # Get the overall API counter - api_response = api_instance.namsor_counter() - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->namsor_counter: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**SoftwareVersionOut**](SoftwareVersionOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **payment_info** -> APIKeyOut payment_info(token) - -Get the Stripe payment information associated with the current google auth session token. - -### 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)) -token = 'token_example' # str | - -try: - # Get the Stripe payment information associated with the current google auth session token. - api_response = api_instance.payment_info(token) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->payment_info: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **token** | **str**| | - -### Return type - -[**APIKeyOut**](APIKeyOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **procure_key** -> APIKeyOut procure_key(token) - -Procure an API Key (sent via Email), based on an auth token. Keep your API Key secret. - -### 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)) -token = 'token_example' # str | - -try: - # Procure an API Key (sent via Email), based on an auth token. Keep your API Key secret. - api_response = api_instance.procure_key(token) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->procure_key: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **token** | **str**| | - -### Return type - -[**APIKeyOut**](APIKeyOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -Remove the user account. - -### 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)) -token = 'token_example' # str | - -try: - # Remove the user account. - api_response = api_instance.remove_user_account(token) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->remove_user_account: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **token** | **str**| | - -### Return type - -[**APIPlanSubscriptionOut**](APIPlanSubscriptionOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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_on_behalf** -> APIPlanSubscriptionOut remove_user_account_on_behalf(api_key) - -Remove (on behalf) a user account. - -### 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)) -api_key = 'api_key_example' # str | - -try: - # Remove (on behalf) a user account. - api_response = api_instance.remove_user_account_on_behalf(api_key) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->remove_user_account_on_behalf: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **api_key** | **str**| | - -### Return type - -[**APIPlanSubscriptionOut**](APIPlanSubscriptionOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **shutdown** -> shutdown() - -Stop learning and shutdown system. - -### 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: - # Stop learning and shutdown system. - api_instance.shutdown() -except ApiException as e: - print("Exception when calling AdminApi->shutdown: %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) - -# **software_version** -> SoftwareVersionOut software_version() - -Get the current software version - -### 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: - # Get the current software version - api_response = api_instance.software_version() - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->software_version: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**SoftwareVersionOut**](SoftwareVersionOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **source_stats** -> SystemMetricsOut source_stats(source) - -Print basic source statistics. - -### 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)) -source = 'source_example' # str | - -try: - # Print basic source statistics. - api_response = api_instance.source_stats(source) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->source_stats: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **source** | **str**| | - -### Return type - -[**SystemMetricsOut**](SystemMetricsOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **stats** -> SystemMetricsOut stats() - -Print basic system statistics. - -### 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: - # Print basic system statistics. - api_response = api_instance.stats() - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->stats: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**SystemMetricsOut**](SystemMetricsOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **stripe_connect** -> stripe_connect(scope=scope, code=code, error=error, error_description=error_description) - -Connects a Stripe Account. - -### 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)) -scope = 'scope_example' # str | (optional) -code = 'code_example' # str | (optional) -error = 'error_example' # str | (optional) -error_description = 'error_description_example' # str | (optional) - -try: - # Connects a Stripe Account. - api_instance.stripe_connect(scope=scope, code=code, error=error, error_description=error_description) -except ApiException as e: - print("Exception when calling AdminApi->stripe_connect: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **scope** | **str**| | [optional] - **code** | **str**| | [optional] - **error** | **str**| | [optional] - **error_description** | **str**| | [optional] - -### 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) - -# **subscribe_plan** -> APIPlanSubscriptionOut subscribe_plan(plan_name, token) - -Subscribe to a give API plan, using the user's preferred or default currency. - -### 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)) -plan_name = 'plan_name_example' # str | -token = 'token_example' # str | - -try: - # Subscribe to a give API plan, using the user's preferred or default currency. - api_response = api_instance.subscribe_plan(plan_name, token) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->subscribe_plan: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **plan_name** | **str**| | - **token** | **str**| | - -### Return type - -[**APIPlanSubscriptionOut**](APIPlanSubscriptionOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **subscribe_plan_on_behalf** -> APIPlanSubscriptionOut subscribe_plan_on_behalf(plan_name, api_key) - -Subscribe to a give API plan, using the user's preferred or default currency (admin only). - -### 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)) -plan_name = 'plan_name_example' # str | -api_key = 'api_key_example' # str | - -try: - # Subscribe to a give API plan, using the user's preferred or default currency (admin only). - api_response = api_instance.subscribe_plan_on_behalf(plan_name, api_key) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->subscribe_plan_on_behalf: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **plan_name** | **str**| | - **api_key** | **str**| | - -### Return type - -[**APIPlanSubscriptionOut**](APIPlanSubscriptionOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **taxonomy_classes** -> APIPlansOut taxonomy_classes(classifier_name) - -Print the taxonomy classes valid for the given classifier. - -### 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)) -classifier_name = 'classifier_name_example' # str | - -try: - # Print the taxonomy classes valid for the given classifier. - api_response = api_instance.taxonomy_classes(classifier_name) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->taxonomy_classes: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **classifier_name** | **str**| | - -### Return type - -[**APIPlansOut**](APIPlansOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **update_billing_info** -> BillingInfoInOut update_billing_info(token, billing_info_in_out=billing_info_in_out) - -Sets or update the billing information (company name, address, phone, vat ID) - -### 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)) -token = 'token_example' # str | -billing_info_in_out = openapi_client.BillingInfoInOut() # BillingInfoInOut | (optional) - -try: - # Sets or update the billing information (company name, address, phone, vat ID) - api_response = api_instance.update_billing_info(token, billing_info_in_out=billing_info_in_out) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->update_billing_info: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **token** | **str**| | - **billing_info_in_out** | [**BillingInfoInOut**](BillingInfoInOut.md)| | [optional] - -### Return type - -[**BillingInfoInOut**](BillingInfoInOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: application/json;charset=UTF-8 - - **Accept**: application/json - -[[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) - -# **update_limit** -> APIPeriodUsageOut update_limit(usage_limit, hard_or_soft, token) - -Modifies the hard/soft limit on the API plan's overages (default is 0$ soft limit). - -### 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)) -usage_limit = 56 # int | -hard_or_soft = True # bool | -token = 'token_example' # str | - -try: - # Modifies the hard/soft limit on the API plan's overages (default is 0$ soft limit). - api_response = api_instance.update_limit(usage_limit, hard_or_soft, token) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->update_limit: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **usage_limit** | **int**| | - **hard_or_soft** | **bool**| | - **token** | **str**| | - -### Return type - -[**APIPeriodUsageOut**](APIPeriodUsageOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **update_payment_default** -> APIKeyOut update_payment_default(defaut_source_id, token) - -Update the default Stripe card associated with the current google auth session token. - -### 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)) -defaut_source_id = 'defaut_source_id_example' # str | -token = 'token_example' # str | - -try: - # Update the default Stripe card associated with the current google auth session token. - api_response = api_instance.update_payment_default(defaut_source_id, token) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->update_payment_default: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **defaut_source_id** | **str**| | - **token** | **str**| | - -### Return type - -[**APIKeyOut**](APIKeyOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **user_info** -> APIKeyOut user_info(token) - -Get the user profile associated with the current google auth session token. - -### 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)) -token = 'token_example' # str | - -try: - # Get the user profile associated with the current google auth session token. - api_response = api_instance.user_info(token) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->user_info: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **token** | **str**| | - -### Return type - -[**APIKeyOut**](APIKeyOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **verify_email** -> APIKeyOut verify_email(email_token) - -Verifies an email, based on token sent to that email - -### 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)) -email_token = 'email_token_example' # str | - -try: - # Verifies an email, based on token sent to that email - api_response = api_instance.verify_email(email_token) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->verify_email: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **email_token** | **str**| | - -### Return type - -[**APIKeyOut**](APIKeyOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **verify_remove_email** -> APIKeyOut verify_remove_email(email_token) - -Verifies an email, based on token sent to that email - -### 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)) -email_token = 'email_token_example' # str | - -try: - # Verifies an email, based on token sent to that email - api_response = api_instance.verify_remove_email(email_token) - pprint(api_response) -except ApiException as e: - print("Exception when calling AdminApi->verify_remove_email: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **email_token** | **str**| | - -### Return type - -[**APIKeyOut**](APIKeyOut.md) +[**APIClassifierTaxonomyOut**](APIClassifierTaxonomyOut.md) ### Authorization @@ -2012,58 +535,3 @@ 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) -# **vet** -> vet(source, vetted) - -Vetting of a source. - -### 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)) -source = 'source_example' # str | -vetted = True # bool | - -try: - # Vetting of a source. - api_instance.vet(source, vetted) -except ApiException as e: - print("Exception when calling AdminApi->vet: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **source** | **str**| | - **vetted** | **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) - diff --git a/docs/BatchCorridorOut.md b/docs/BatchCorridorOut.md index a680d7b..87c1fe8 100644 --- a/docs/BatchCorridorOut.md +++ b/docs/BatchCorridorOut.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**corridor_from_to** | [**list[CorridorOut]**](CorridorOut.md) | | [optional] +**corridor_from_to** | [**list[CorridorOut]**](CorridorOut.md) | Classified corridors | [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) diff --git a/docs/BatchFirstLastNameDiasporaedOut.md b/docs/BatchFirstLastNameDiasporaedOut.md index 7f3a6b2..5817fa9 100644 --- a/docs/BatchFirstLastNameDiasporaedOut.md +++ b/docs/BatchFirstLastNameDiasporaedOut.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**personal_names** | [**list[FirstLastNameDiasporaedOut]**](FirstLastNameDiasporaedOut.md) | | [optional] +**personal_names** | [**list[FirstLastNameDiasporaedOut]**](FirstLastNameDiasporaedOut.md) | Classified diaspora names | [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) diff --git a/docs/BatchFirstLastNameGenderedOut.md b/docs/BatchFirstLastNameGenderedOut.md index e44d851..f2298fe 100644 --- a/docs/BatchFirstLastNameGenderedOut.md +++ b/docs/BatchFirstLastNameGenderedOut.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**personal_names** | [**list[FirstLastNameGenderedOut]**](FirstLastNameGenderedOut.md) | | [optional] +**personal_names** | [**list[FirstLastNameGenderedOut]**](FirstLastNameGenderedOut.md) | Classified genderized names | [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) diff --git a/docs/BatchFirstLastNameOriginedOut.md b/docs/BatchFirstLastNameOriginedOut.md index 4db0e2b..116af61 100644 --- a/docs/BatchFirstLastNameOriginedOut.md +++ b/docs/BatchFirstLastNameOriginedOut.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**personal_names** | [**list[FirstLastNameOriginedOut]**](FirstLastNameOriginedOut.md) | | [optional] +**personal_names** | [**list[FirstLastNameOriginedOut]**](FirstLastNameOriginedOut.md) | Classified origined names | [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) diff --git a/docs/BatchFirstLastNamePhoneCodedOut.md b/docs/BatchFirstLastNamePhoneCodedOut.md index e7e5e88..dc347cd 100644 --- a/docs/BatchFirstLastNamePhoneCodedOut.md +++ b/docs/BatchFirstLastNamePhoneCodedOut.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**personal_names_with_phone_numbers** | [**list[FirstLastNamePhoneCodedOut]**](FirstLastNamePhoneCodedOut.md) | | [optional] +**personal_names_with_phone_numbers** | [**list[FirstLastNamePhoneCodedOut]**](FirstLastNamePhoneCodedOut.md) | Classified phone-coded names | [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) diff --git a/docs/BatchFirstLastNameUSRaceEthnicityOut.md b/docs/BatchFirstLastNameUSRaceEthnicityOut.md index 8988b2d..113111d 100644 --- a/docs/BatchFirstLastNameUSRaceEthnicityOut.md +++ b/docs/BatchFirstLastNameUSRaceEthnicityOut.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**personal_names** | [**list[FirstLastNameUSRaceEthnicityOut]**](FirstLastNameUSRaceEthnicityOut.md) | | [optional] +**personal_names** | [**list[FirstLastNameUSRaceEthnicityOut]**](FirstLastNameUSRaceEthnicityOut.md) | Classified US 'race'/ethnicized names | [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) diff --git a/docs/BatchNameMatchCandidatesOut.md b/docs/BatchNameMatchCandidatesOut.md index 76b3d0e..19f57ba 100644 --- a/docs/BatchNameMatchCandidatesOut.md +++ b/docs/BatchNameMatchCandidatesOut.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**names_and_match_candidates** | [**list[NameMatchCandidatesOut]**](NameMatchCandidatesOut.md) | | [optional] +**names_and_match_candidates** | [**list[NameMatchCandidatesOut]**](NameMatchCandidatesOut.md) | Classified matched names | [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) diff --git a/docs/BatchNameMatchedOut.md b/docs/BatchNameMatchedOut.md index 0d3fbd4..3a82191 100644 --- a/docs/BatchNameMatchedOut.md +++ b/docs/BatchNameMatchedOut.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**matched_names** | [**list[NameMatchedOut]**](NameMatchedOut.md) | | [optional] +**matched_names** | [**list[NameMatchedOut]**](NameMatchedOut.md) | Classified matched names | [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) diff --git a/docs/BatchPersonalNameGenderedOut.md b/docs/BatchPersonalNameGenderedOut.md index ede95af..cd26ba0 100644 --- a/docs/BatchPersonalNameGenderedOut.md +++ b/docs/BatchPersonalNameGenderedOut.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**personal_names** | [**list[PersonalNameGenderedOut]**](PersonalNameGenderedOut.md) | | [optional] +**personal_names** | [**list[PersonalNameGenderedOut]**](PersonalNameGenderedOut.md) | Classified genderized names | [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) diff --git a/docs/BatchPersonalNameGeoOut.md b/docs/BatchPersonalNameGeoOut.md index 55c1a50..4ea589e 100644 --- a/docs/BatchPersonalNameGeoOut.md +++ b/docs/BatchPersonalNameGeoOut.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**personal_names** | [**list[PersonalNameGeoOut]**](PersonalNameGeoOut.md) | | [optional] +**personal_names** | [**list[PersonalNameGeoOut]**](PersonalNameGeoOut.md) | Classified geo names | [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) diff --git a/docs/BatchPersonalNameParsedOut.md b/docs/BatchPersonalNameParsedOut.md index aa0e219..9f3a798 100644 --- a/docs/BatchPersonalNameParsedOut.md +++ b/docs/BatchPersonalNameParsedOut.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**personal_names** | [**list[PersonalNameParsedOut]**](PersonalNameParsedOut.md) | | [optional] +**personal_names** | [**list[PersonalNameParsedOut]**](PersonalNameParsedOut.md) | Classified parsed names | [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) diff --git a/docs/BatchProperNounCategorizedOut.md b/docs/BatchProperNounCategorizedOut.md index dba2086..c8d1252 100644 --- a/docs/BatchProperNounCategorizedOut.md +++ b/docs/BatchProperNounCategorizedOut.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**proper_nouns** | [**list[ProperNounCategorizedOut]**](ProperNounCategorizedOut.md) | | [optional] +**proper_nouns** | [**list[ProperNounCategorizedOut]**](ProperNounCategorizedOut.md) | Classified typed proper names | [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) diff --git a/docs/ChineseApi.md b/docs/ChineseApi.md index d1e2255..8ac2d78 100644 --- a/docs/ChineseApi.md +++ b/docs/ChineseApi.md @@ -21,7 +21,7 @@ Method | HTTP request | Description # **chinese_name_candidates** -> RomanizedNameOut chinese_name_candidates(chinese_surname_latin, chinese_given_name_latin) +> NameMatchCandidatesOut chinese_name_candidates(chinese_surname_latin, chinese_given_name_latin) Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming @@ -63,7 +63,7 @@ Name | Type | Description | Notes ### Return type -[**RomanizedNameOut**](RomanizedNameOut.md) +[**NameMatchCandidatesOut**](NameMatchCandidatesOut.md) ### Authorization @@ -131,7 +131,7 @@ 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) # **chinese_name_candidates_gender_batch** -> BatchNameMatchCandidatesOut chinese_name_candidates_gender_batch(batch_first_last_name_in=batch_first_last_name_in) +> BatchNameMatchCandidatesOut chinese_name_candidates_gender_batch(batch_first_last_name_gender_in=batch_first_last_name_gender_in) Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname) ex. Wang Xiaoming. @@ -153,11 +153,11 @@ configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = openapi_client.ChineseApi(openapi_client.ApiClient(configuration)) -batch_first_last_name_in = openapi_client.BatchFirstLastNameIn() # BatchFirstLastNameIn | A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname (optional) +batch_first_last_name_gender_in = openapi_client.BatchFirstLastNameGenderIn() # BatchFirstLastNameGenderIn | A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname (optional) try: # Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname) ex. Wang Xiaoming. - api_response = api_instance.chinese_name_candidates_gender_batch(batch_first_last_name_in=batch_first_last_name_in) + api_response = api_instance.chinese_name_candidates_gender_batch(batch_first_last_name_gender_in=batch_first_last_name_gender_in) pprint(api_response) except ApiException as e: print("Exception when calling ChineseApi->chinese_name_candidates_gender_batch: %s\n" % e) @@ -167,7 +167,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **batch_first_last_name_in** | [**BatchFirstLastNameIn**](BatchFirstLastNameIn.md)| A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname | [optional] + **batch_first_last_name_gender_in** | [**BatchFirstLastNameGenderIn**](BatchFirstLastNameGenderIn.md)| A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname | [optional] ### Return type @@ -185,7 +185,7 @@ 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) # **chinese_name_gender_candidates** -> RomanizedNameOut chinese_name_gender_candidates(chinese_surname_latin, chinese_given_name_latin, known_gender) +> NameMatchCandidatesOut chinese_name_gender_candidates(chinese_surname_latin, chinese_given_name_latin, known_gender) Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming - having a known gender ('male' or 'female') @@ -229,7 +229,7 @@ Name | Type | Description | Notes ### Return type -[**RomanizedNameOut**](RomanizedNameOut.md) +[**NameMatchCandidatesOut**](NameMatchCandidatesOut.md) ### Authorization @@ -243,7 +243,7 @@ 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) # **chinese_name_match** -> RomanizedNameOut chinese_name_match(chinese_surname_latin, chinese_given_name_latin, chinese_name) +> NameMatchedOut chinese_name_match(chinese_surname_latin, chinese_given_name_latin, chinese_name) Return a score for matching Chinese name ex. 王晓明 with a romanized name ex. Wang Xiaoming @@ -287,7 +287,7 @@ Name | Type | Description | Notes ### Return type -[**RomanizedNameOut**](RomanizedNameOut.md) +[**NameMatchedOut**](NameMatchedOut.md) ### Authorization @@ -301,7 +301,7 @@ 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) # **chinese_name_match_batch** -> BatchNameMatchCandidatesOut chinese_name_match_batch(batch_first_last_name_in=batch_first_last_name_in) +> BatchNameMatchedOut chinese_name_match_batch(batch_match_personal_first_last_name_in=batch_match_personal_first_last_name_in) Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming @@ -323,11 +323,11 @@ configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = openapi_client.ChineseApi(openapi_client.ApiClient(configuration)) -batch_first_last_name_in = openapi_client.BatchFirstLastNameIn() # BatchFirstLastNameIn | A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname (optional) +batch_match_personal_first_last_name_in = openapi_client.BatchMatchPersonalFirstLastNameIn() # BatchMatchPersonalFirstLastNameIn | A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname (optional) try: # Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming - api_response = api_instance.chinese_name_match_batch(batch_first_last_name_in=batch_first_last_name_in) + api_response = api_instance.chinese_name_match_batch(batch_match_personal_first_last_name_in=batch_match_personal_first_last_name_in) pprint(api_response) except ApiException as e: print("Exception when calling ChineseApi->chinese_name_match_batch: %s\n" % e) @@ -337,11 +337,11 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **batch_first_last_name_in** | [**BatchFirstLastNameIn**](BatchFirstLastNameIn.md)| A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname | [optional] + **batch_match_personal_first_last_name_in** | [**BatchMatchPersonalFirstLastNameIn**](BatchMatchPersonalFirstLastNameIn.md)| A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname | [optional] ### Return type -[**BatchNameMatchCandidatesOut**](BatchNameMatchCandidatesOut.md) +[**BatchNameMatchedOut**](BatchNameMatchedOut.md) ### Authorization diff --git a/docs/CorridorOut.md b/docs/CorridorOut.md index 8f26087..bf7ba09 100644 --- a/docs/CorridorOut.md +++ b/docs/CorridorOut.md @@ -8,7 +8,6 @@ Name | Type | Description | Notes **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) diff --git a/docs/FeedbackLoopOut.md b/docs/FeedbackLoopOut.md index b66ee79..6d2ba6a 100644 --- a/docs/FeedbackLoopOut.md +++ b/docs/FeedbackLoopOut.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**feedback_credits** | **int** | | [optional] +**feedback_credits** | **int** | Number of units recredited as per feedback loop successful classification | [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) diff --git a/docs/FirstLastNameDiasporaedOut.md b/docs/FirstLastNameDiasporaedOut.md index 476fd4d..0f6e819 100644 --- a/docs/FirstLastNameDiasporaedOut.md +++ b/docs/FirstLastNameDiasporaedOut.md @@ -5,15 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **script** | **str** | | [optional] **id** | **str** | | [optional] -**first_name** | **str** | | [optional] -**last_name** | **str** | | [optional] -**score** | **float** | Compatibility to NamSor_v1 Origin score value | [optional] -**ethnicity_alt** | **str** | | [optional] -**ethnicity** | **str** | | [optional] -**lifted** | **bool** | | [optional] -**country_iso2** | **str** | | [optional] -**ethnicities_top** | **list[str]** | List ethnicities (top 10) | [optional] -**category** | **str** | | [optional] +**first_name** | **str** | The first name (also known as given name) | [optional] +**last_name** | **str** | The last name (also known as family name, or surname) | [optional] +**score** | **float** | Compatibility to NamSor_v1 Diaspora score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] +**ethnicity_alt** | **str** | The second best alternative ethnicity | [optional] +**ethnicity** | **str** | The most likely ethnicity | [optional] +**lifted** | **bool** | Indicates if the output ethnicity is based on machine learning only, or further lifted as a known fact by a country-specific rule. Let us know if you believe ethnicity is incorrect on a specific case where lifted is true. | [optional] +**country_iso2** | **str** | From input data, the countryIso2 of geographic context (US,CA etc.) | [optional] +**ethnicities_top** | **list[str]** | List most likely 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) diff --git a/docs/FirstLastNameGenderIn.md b/docs/FirstLastNameGenderIn.md index b610508..7295b4e 100644 --- a/docs/FirstLastNameGenderIn.md +++ b/docs/FirstLastNameGenderIn.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **id** | **str** | | [optional] **first_name** | **str** | | [optional] **last_name** | **str** | | [optional] -**gender** | **str** | | [optional] +**gender** | **str** | The known gender of the name | [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) diff --git a/docs/FirstLastNameGenderedOut.md b/docs/FirstLastNameGenderedOut.md index 05c7de2..fb7657b 100644 --- a/docs/FirstLastNameGenderedOut.md +++ b/docs/FirstLastNameGenderedOut.md @@ -5,13 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **script** | **str** | | [optional] **id** | **str** | | [optional] -**first_name** | **str** | | [optional] -**last_name** | **str** | | [optional] +**first_name** | **str** | The first name (also known as given name) | [optional] +**last_name** | **str** | The last name (also known as family name, or surname) | [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] +**score** | **float** | Compatibility to NamSor_v1 Gender score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] +**probability_calibrated** | **float** | The calibrated probability for inferred gender to have been guessed correctly. | [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) diff --git a/docs/FirstLastNameOriginedOut.md b/docs/FirstLastNameOriginedOut.md index 338f462..c601320 100644 --- a/docs/FirstLastNameOriginedOut.md +++ b/docs/FirstLastNameOriginedOut.md @@ -5,18 +5,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **script** | **str** | | [optional] **id** | **str** | | [optional] -**first_name** | **str** | | [optional] -**last_name** | **str** | | [optional] +**first_name** | **str** | The first name (also known as given name) | [optional] +**last_name** | **str** | The last name (also known as family name, or surname) | [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] +**score** | **float** | Compatibility to NamSor_v1 Origin score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [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] -**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] +**top_region_origin** | **str** | Most likely top region of Origin (based on countryOrigin ISO2 code) | [optional] +**sub_region_origin** | **str** | Most likely sub region of Origin (based on countryOrigin ISO2 code) | [optional] +**probability_calibrated** | **float** | The calibrated probability for countryOrigin to have been guessed correctly. | [optional] +**probability_alt_calibrated** | **float** | The calibrated probability for countryOrigin OR countryOriginAlt to have been guessed correctly. | [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) diff --git a/docs/FirstLastNameOut.md b/docs/FirstLastNameOut.md index 951e613..66311d8 100644 --- a/docs/FirstLastNameOut.md +++ b/docs/FirstLastNameOut.md @@ -5,9 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **script** | **str** | | [optional] **id** | **str** | | [optional] -**first_name** | **str** | | [optional] -**last_name** | **str** | | [optional] -**category** | **str** | | [optional] +**first_name** | **str** | The first name (also known as given name) | [optional] +**last_name** | **str** | The last name (also known as family name, or surname) | [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) diff --git a/docs/FirstLastNamePhoneCodedOut.md b/docs/FirstLastNamePhoneCodedOut.md index 67cea85..2357677 100644 --- a/docs/FirstLastNamePhoneCodedOut.md +++ b/docs/FirstLastNamePhoneCodedOut.md @@ -5,21 +5,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **script** | **str** | | [optional] **id** | **str** | | [optional] -**first_name** | **str** | | [optional] -**last_name** | **str** | | [optional] -**international_phone_number_verified** | **str** | | [optional] -**phone_country_iso2_verified** | **str** | | [optional] -**phone_country_code** | **int** | | [optional] -**phone_country_code_alt** | **int** | | [optional] -**phone_country_iso2** | **str** | | [optional] -**phone_country_iso2_alt** | **str** | | [optional] -**origin_country_iso2** | **str** | | [optional] -**origin_country_iso2_alt** | **str** | | [optional] -**phone_number** | **str** | | [optional] -**verified** | **bool** | | [optional] -**score** | **float** | | [optional] +**first_name** | **str** | The first name (also known as given name) | [optional] +**last_name** | **str** | The last name (also known as family name, or surname) | [optional] +**international_phone_number_verified** | **str** | The normalized phone number, verified using libphonenumber. | [optional] +**phone_country_iso2_verified** | **str** | The phone ISO2 country code, verified using libphonenumber. | [optional] +**phone_country_code** | **int** | The phone country code of the phone number, verified using libphonenumber. | [optional] +**phone_country_code_alt** | **int** | The best alternative phone country code of the phone number. | [optional] +**phone_country_iso2** | **str** | The likely country of the phone number. | [optional] +**phone_country_iso2_alt** | **str** | The best alternative country of the phone number. | [optional] +**origin_country_iso2** | **str** | The likely country of origin of the name. | [optional] +**origin_country_iso2_alt** | **str** | The best alternative country of origin of the name. | [optional] +**phone_number** | **str** | The input phone number. | [optional] +**verified** | **bool** | Indicates if the phone number could be positively verified using libphonenumber. | [optional] +**score** | **float** | Higher score is better, but score is not normalized. Use calibratedProbability if available. | [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) diff --git a/docs/FirstLastNameUSRaceEthnicityOut.md b/docs/FirstLastNameUSRaceEthnicityOut.md index 9d30f05..beb7c33 100644 --- a/docs/FirstLastNameUSRaceEthnicityOut.md +++ b/docs/FirstLastNameUSRaceEthnicityOut.md @@ -5,15 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **script** | **str** | | [optional] **id** | **str** | | [optional] -**first_name** | **str** | | [optional] -**last_name** | **str** | | [optional] +**first_name** | **str** | The first name (also known as given name) | [optional] +**last_name** | **str** | The last name (also known as family name, or surname) | [optional] **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] +**score** | **float** | Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] **race_ethnicities_top** | **list[str]** | List 'race'/ethnicities | [optional] -**probability_calibrated** | **float** | | [optional] -**probability_alt_calibrated** | **float** | | [optional] -**category** | **str** | | [optional] +**probability_calibrated** | **float** | The calibrated probability for raceEthnicity to have been guessed correctly. | [optional] +**probability_alt_calibrated** | **float** | The calibrated probability for raceEthnicity OR raceEthnicityAlt to have been guessed correctly. | [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) diff --git a/docs/JapaneseApi.md b/docs/JapaneseApi.md index fde7ded..2e5029d 100644 --- a/docs/JapaneseApi.md +++ b/docs/JapaneseApi.md @@ -240,7 +240,7 @@ 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) # **japanese_name_gender_kanji_candidates_batch** -> BatchNameMatchCandidatesOut japanese_name_gender_kanji_candidates_batch(batch_first_last_name_in=batch_first_last_name_in) +> BatchNameMatchCandidatesOut japanese_name_gender_kanji_candidates_batch(batch_first_last_name_gender_in=batch_first_last_name_gender_in) Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname) with KNOWN gender, ex. Yamamoto Sanae @@ -262,11 +262,11 @@ configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = openapi_client.JapaneseApi(openapi_client.ApiClient(configuration)) -batch_first_last_name_in = openapi_client.BatchFirstLastNameIn() # BatchFirstLastNameIn | A list of personal japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname and known gender (optional) +batch_first_last_name_gender_in = openapi_client.BatchFirstLastNameGenderIn() # BatchFirstLastNameGenderIn | A list of personal japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname and known gender (optional) try: # Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname) with KNOWN gender, ex. Yamamoto Sanae - api_response = api_instance.japanese_name_gender_kanji_candidates_batch(batch_first_last_name_in=batch_first_last_name_in) + api_response = api_instance.japanese_name_gender_kanji_candidates_batch(batch_first_last_name_gender_in=batch_first_last_name_gender_in) pprint(api_response) except ApiException as e: print("Exception when calling JapaneseApi->japanese_name_gender_kanji_candidates_batch: %s\n" % e) @@ -276,7 +276,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **batch_first_last_name_in** | [**BatchFirstLastNameIn**](BatchFirstLastNameIn.md)| A list of personal japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname and known gender | [optional] + **batch_first_last_name_gender_in** | [**BatchFirstLastNameGenderIn**](BatchFirstLastNameGenderIn.md)| A list of personal japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname and known gender | [optional] ### Return type @@ -294,7 +294,7 @@ 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) # **japanese_name_kanji_candidates** -> RomanizedNameOut japanese_name_kanji_candidates(japanese_surname_latin, japanese_given_name_latin, known_gender) +> NameMatchCandidatesOut japanese_name_kanji_candidates(japanese_surname_latin, japanese_given_name_latin, known_gender) Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae - and a known gender. @@ -338,7 +338,7 @@ Name | Type | Description | Notes ### Return type -[**RomanizedNameOut**](RomanizedNameOut.md) +[**NameMatchCandidatesOut**](NameMatchCandidatesOut.md) ### Authorization @@ -352,7 +352,7 @@ 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) # **japanese_name_kanji_candidates1** -> RomanizedNameOut japanese_name_kanji_candidates1(japanese_surname_latin, japanese_given_name_latin) +> NameMatchCandidatesOut japanese_name_kanji_candidates1(japanese_surname_latin, japanese_given_name_latin) Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae @@ -394,7 +394,7 @@ Name | Type | Description | Notes ### Return type -[**RomanizedNameOut**](RomanizedNameOut.md) +[**NameMatchCandidatesOut**](NameMatchCandidatesOut.md) ### Authorization @@ -462,7 +462,7 @@ 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) # **japanese_name_latin_candidates** -> RomanizedNameOut japanese_name_latin_candidates(japanese_surname_kanji, japanese_given_name_kanji) +> NameMatchCandidatesOut japanese_name_latin_candidates(japanese_surname_kanji, japanese_given_name_kanji) Romanize japanese name, based on the name in Kanji. @@ -504,7 +504,7 @@ Name | Type | Description | Notes ### Return type -[**RomanizedNameOut**](RomanizedNameOut.md) +[**NameMatchCandidatesOut**](NameMatchCandidatesOut.md) ### Authorization @@ -572,7 +572,7 @@ 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) # **japanese_name_match** -> RomanizedNameOut japanese_name_match(japanese_surname_latin, japanese_given_name_latin, japanese_name) +> NameMatchedOut japanese_name_match(japanese_surname_latin, japanese_given_name_latin, japanese_name) Return a score for matching Japanese name in KANJI ex. 山本 早苗 with a romanized name ex. Yamamoto Sanae @@ -616,7 +616,7 @@ Name | Type | Description | Notes ### Return type -[**RomanizedNameOut**](RomanizedNameOut.md) +[**NameMatchedOut**](NameMatchedOut.md) ### Authorization @@ -630,7 +630,7 @@ 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) # **japanese_name_match_batch** -> BatchNameMatchCandidatesOut japanese_name_match_batch(batch_first_last_name_in=batch_first_last_name_in) +> BatchNameMatchedOut japanese_name_match_batch(batch_match_personal_first_last_name_in=batch_match_personal_first_last_name_in) Return a score for matching a list of Japanese names in KANJI ex. 山本 早苗 with romanized names ex. Yamamoto Sanae @@ -652,11 +652,11 @@ configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY' # create an instance of the API class api_instance = openapi_client.JapaneseApi(openapi_client.ApiClient(configuration)) -batch_first_last_name_in = openapi_client.BatchFirstLastNameIn() # BatchFirstLastNameIn | A list of personal Japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname (optional) +batch_match_personal_first_last_name_in = openapi_client.BatchMatchPersonalFirstLastNameIn() # BatchMatchPersonalFirstLastNameIn | A list of personal Japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname (optional) try: # Return a score for matching a list of Japanese names in KANJI ex. 山本 早苗 with romanized names ex. Yamamoto Sanae - api_response = api_instance.japanese_name_match_batch(batch_first_last_name_in=batch_first_last_name_in) + api_response = api_instance.japanese_name_match_batch(batch_match_personal_first_last_name_in=batch_match_personal_first_last_name_in) pprint(api_response) except ApiException as e: print("Exception when calling JapaneseApi->japanese_name_match_batch: %s\n" % e) @@ -666,11 +666,11 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **batch_first_last_name_in** | [**BatchFirstLastNameIn**](BatchFirstLastNameIn.md)| A list of personal Japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname | [optional] + **batch_match_personal_first_last_name_in** | [**BatchMatchPersonalFirstLastNameIn**](BatchMatchPersonalFirstLastNameIn.md)| A list of personal Japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname | [optional] ### Return type -[**BatchNameMatchCandidatesOut**](BatchNameMatchCandidatesOut.md) +[**BatchNameMatchedOut**](BatchNameMatchedOut.md) ### Authorization @@ -684,7 +684,7 @@ 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) # **japanese_name_match_feedback_loop** -> RomanizedNameOut japanese_name_match_feedback_loop(japanese_surname_latin, japanese_given_name_latin, japanese_name) +> FeedbackLoopOut japanese_name_match_feedback_loop(japanese_surname_latin, japanese_given_name_latin, japanese_name) [CREDITS 1 UNIT] Feedback loop to better perform matching Japanese name in KANJI ex. 山本 早苗 with a romanized name ex. Yamamoto Sanae @@ -728,7 +728,7 @@ Name | Type | Description | Notes ### Return type -[**RomanizedNameOut**](RomanizedNameOut.md) +[**FeedbackLoopOut**](FeedbackLoopOut.md) ### Authorization diff --git a/docs/NameMatchCandidateOut.md b/docs/NameMatchCandidateOut.md index 539ebeb..181fc4b 100644 --- a/docs/NameMatchCandidateOut.md +++ b/docs/NameMatchCandidateOut.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**candidate_name** | **str** | | [optional] -**probability** | **float** | | [optional] -**pred_score_given_name** | **float** | | [optional] -**pred_score_family_name** | **float** | | [optional] +**candidate_name** | **str** | The name matching candidate name | [optional] +**probability** | **float** | The name matching estimated probability. | [optional] +**pred_score_given_name** | **float** | The given name prediction score. | [optional] +**pred_score_family_name** | **float** | The family name prediction score. | [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) diff --git a/docs/NameMatchCandidatesOut.md b/docs/NameMatchCandidatesOut.md index 51c98db..ba7487c 100644 --- a/docs/NameMatchCandidatesOut.md +++ b/docs/NameMatchCandidatesOut.md @@ -5,11 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **script** | **str** | | [optional] **id** | **str** | | [optional] -**first_name** | **str** | | [optional] -**last_name** | **str** | | [optional] -**order_option** | **str** | | [optional] -**match_candidates** | [**list[NameMatchCandidateOut]**](NameMatchCandidateOut.md) | | [optional] -**category** | **str** | | [optional] +**first_name** | **str** | The first name (also known as given name) | [optional] +**last_name** | **str** | The last name (also known as family name, or surname) | [optional] +**order_option** | **str** | The option for ordering | [optional] +**match_candidates** | [**list[NameMatchCandidateOut]**](NameMatchCandidateOut.md) | The ordered list of name matching candidates | [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) diff --git a/docs/NameMatchedOut.md b/docs/NameMatchedOut.md index 6a270dd..774dca8 100644 --- a/docs/NameMatchedOut.md +++ b/docs/NameMatchedOut.md @@ -5,9 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **script** | **str** | | [optional] **id** | **str** | | [optional] -**match_status** | **str** | | [optional] +**match_status** | **str** | The name matching status. | [optional] **score** | **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) diff --git a/docs/PersonalApi.md b/docs/PersonalApi.md index 653b3b5..6d2e47c 100644 --- a/docs/PersonalApi.md +++ b/docs/PersonalApi.md @@ -24,12 +24,10 @@ Method | HTTP request | Description [**parse_name_batch**](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. [**parse_name_geo**](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. [**parse_name_geo_batch**](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. -[**parsed_gender_batch**](PersonalApi.md#parsed_gender_batch) | **POST** /api2/json/parsedGenderBatch | Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. -[**parsed_gender_geo_batch**](PersonalApi.md#parsed_gender_geo_batch) | **POST** /api2/json/parsedGenderGeoBatch | Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. -[**us_race_ethnicity**](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). -[**us_race_ethnicity_batch**](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. -[**us_race_ethnicity_zip5**](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). -[**us_zip_race_ethnicity_batch**](PersonalApi.md#us_zip_race_ethnicity_batch) | **POST** /api2/json/usZipRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. +[**us_race_ethnicity**](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). +[**us_race_ethnicity_batch**](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). +[**us_race_ethnicity_zip5**](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). +[**us_zip_race_ethnicity_batch**](PersonalApi.md#us_zip_race_ethnicity_batch) | **POST** /api2/json/usZipRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. 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). # **corridor** @@ -1138,118 +1136,10 @@ 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) -# **parsed_gender_batch** -> BatchFirstLastNameGenderedOut parsed_gender_batch(batch_parsed_full_name_in=batch_parsed_full_name_in) - -Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. - -### 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.PersonalApi(openapi_client.ApiClient(configuration)) -batch_parsed_full_name_in = openapi_client.BatchParsedFullNameIn() # BatchParsedFullNameIn | A list of personal names (optional) - -try: - # Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. - api_response = api_instance.parsed_gender_batch(batch_parsed_full_name_in=batch_parsed_full_name_in) - pprint(api_response) -except ApiException as e: - print("Exception when calling PersonalApi->parsed_gender_batch: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **batch_parsed_full_name_in** | [**BatchParsedFullNameIn**](BatchParsedFullNameIn.md)| A list of personal names | [optional] - -### Return type - -[**BatchFirstLastNameGenderedOut**](BatchFirstLastNameGenderedOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[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) - -# **parsed_gender_geo_batch** -> BatchFirstLastNameGenderedOut parsed_gender_geo_batch(batch_parsed_full_name_geo_in=batch_parsed_full_name_geo_in) - -Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. - -### 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.PersonalApi(openapi_client.ApiClient(configuration)) -batch_parsed_full_name_geo_in = openapi_client.BatchParsedFullNameGeoIn() # BatchParsedFullNameGeoIn | A list of personal names (optional) - -try: - # Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. - api_response = api_instance.parsed_gender_geo_batch(batch_parsed_full_name_geo_in=batch_parsed_full_name_geo_in) - pprint(api_response) -except ApiException as e: - print("Exception when calling PersonalApi->parsed_gender_geo_batch: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **batch_parsed_full_name_geo_in** | [**BatchParsedFullNameGeoIn**](BatchParsedFullNameGeoIn.md)| A list of personal names | [optional] - -### Return type - -[**BatchFirstLastNameGenderedOut**](BatchFirstLastNameGenderedOut.md) - -### Authorization - -[api_key](../README.md#api_key) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[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) - # **us_race_ethnicity** > FirstLastNameUSRaceEthnicityOut us_race_ethnicity(first_name, last_name) -[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). +[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). ### Example @@ -1273,7 +1163,7 @@ first_name = 'first_name_example' # str | last_name = 'last_name_example' # str | try: - # [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). + # [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). api_response = api_instance.us_race_ethnicity(first_name, last_name) pprint(api_response) except ApiException as e: @@ -1305,7 +1195,7 @@ Name | Type | Description | Notes # **us_race_ethnicity_batch** > BatchFirstLastNameUSRaceEthnicityOut us_race_ethnicity_batch(batch_first_last_name_geo_in=batch_first_last_name_geo_in) -[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. +[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). ### Example @@ -1328,7 +1218,7 @@ api_instance = openapi_client.PersonalApi(openapi_client.ApiClient(configuration batch_first_last_name_geo_in = openapi_client.BatchFirstLastNameGeoIn() # BatchFirstLastNameGeoIn | A list of personal names (optional) try: - # [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. + # [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). api_response = api_instance.us_race_ethnicity_batch(batch_first_last_name_geo_in=batch_first_last_name_geo_in) pprint(api_response) except ApiException as e: @@ -1359,7 +1249,7 @@ Name | Type | Description | Notes # **us_race_ethnicity_zip5** > FirstLastNameUSRaceEthnicityOut us_race_ethnicity_zip5(first_name, last_name, zip5_code) -[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). +[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). ### Example @@ -1384,7 +1274,7 @@ last_name = 'last_name_example' # str | zip5_code = 'zip5_code_example' # str | try: - # [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). + # [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). api_response = api_instance.us_race_ethnicity_zip5(first_name, last_name, zip5_code) pprint(api_response) except ApiException as e: @@ -1417,7 +1307,7 @@ Name | Type | Description | Notes # **us_zip_race_ethnicity_batch** > BatchFirstLastNameUSRaceEthnicityOut us_zip_race_ethnicity_batch(batch_first_last_name_geo_zipped_in=batch_first_last_name_geo_zipped_in) -[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. +[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. 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). ### Example @@ -1440,7 +1330,7 @@ api_instance = openapi_client.PersonalApi(openapi_client.ApiClient(configuration batch_first_last_name_geo_zipped_in = openapi_client.BatchFirstLastNameGeoZippedIn() # BatchFirstLastNameGeoZippedIn | A list of personal names (optional) try: - # [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. + # [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. 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). api_response = api_instance.us_zip_race_ethnicity_batch(batch_first_last_name_geo_zipped_in=batch_first_last_name_geo_zipped_in) pprint(api_response) except ApiException as e: diff --git a/docs/PersonalNameGenderedOut.md b/docs/PersonalNameGenderedOut.md index 04c726f..df6a650 100644 --- a/docs/PersonalNameGenderedOut.md +++ b/docs/PersonalNameGenderedOut.md @@ -5,12 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **script** | **str** | | [optional] **id** | **str** | | [optional] -**name** | **str** | | [optional] +**name** | **str** | The input name | [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] +**score** | **float** | Compatibility to NamSor_v1 Gender score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] +**probability_calibrated** | **float** | The calibrated probability for inferred gender to have been guessed correctly. | [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) diff --git a/docs/PersonalNameGeoOut.md b/docs/PersonalNameGeoOut.md index 150c829..5895269 100644 --- a/docs/PersonalNameGeoOut.md +++ b/docs/PersonalNameGeoOut.md @@ -5,17 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **script** | **str** | | [optional] **id** | **str** | | [optional] -**name** | **str** | | [optional] -**score** | **float** | | [optional] -**country** | **str** | | [optional] -**country_alt** | **str** | | [optional] -**region** | **str** | | [optional] -**top_region** | **str** | | [optional] -**sub_region** | **str** | | [optional] +**name** | **str** | The input name. | [optional] +**score** | **float** | Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] +**country** | **str** | Most likely country | [optional] +**country_alt** | **str** | Second best alternative : country | [optional] +**region** | **str** | Most likely region (based on country ISO2 code) | [optional] +**top_region** | **str** | Most likely top region (based on country ISO2 code) | [optional] +**sub_region** | **str** | Most likely sub region (based on country ISO2 code) | [optional] **countries_top** | **list[str]** | List countries (top 10) | [optional] -**probability_calibrated** | **float** | | [optional] -**probability_alt_calibrated** | **float** | | [optional] -**category** | **str** | | [optional] +**probability_calibrated** | **float** | The calibrated probability for country to have been guessed correctly. | [optional] +**probability_alt_calibrated** | **float** | The calibrated probability for country OR countryAlt to have been guessed correctly. | [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) diff --git a/docs/PersonalNameParsedOut.md b/docs/PersonalNameParsedOut.md index 63fa228..509d9b4 100644 --- a/docs/PersonalNameParsedOut.md +++ b/docs/PersonalNameParsedOut.md @@ -5,12 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **script** | **str** | | [optional] **id** | **str** | | [optional] -**name** | **str** | | [optional] -**name_parser_type** | **str** | | [optional] -**name_parser_type_alt** | **str** | | [optional] +**name** | **str** | The input name | [optional] +**name_parser_type** | **str** | Name parsing is addressed as a classification problem, for example FN1LN1 means a first then last name order. | [optional] +**name_parser_type_alt** | **str** | Second best alternative parsing. Name parsing is addressed as a classification problem, for example FN1LN1 means a first then last name order. | [optional] **first_last_name** | [**FirstLastNameOut**](FirstLastNameOut.md) | | [optional] -**score** | **float** | | [optional] -**category** | **str** | | [optional] +**score** | **float** | Higher score is better, but score is not normalized. Use calibratedProbability if available. | [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) diff --git a/docs/ProperNounCategorizedOut.md b/docs/ProperNounCategorizedOut.md index 49b9d73..0f82d97 100644 --- a/docs/ProperNounCategorizedOut.md +++ b/docs/ProperNounCategorizedOut.md @@ -5,11 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **script** | **str** | | [optional] **id** | **str** | | [optional] -**name** | **str** | | [optional] -**common_type** | **str** | | [optional] -**common_type_alt** | **str** | | [optional] -**score** | **float** | | [optional] -**category** | **str** | | [optional] +**name** | **str** | The input name | [optional] +**common_type** | **str** | The most likely common name type | [optional] +**common_type_alt** | **str** | Best alternative for : The most likely common name type | [optional] +**score** | **float** | Higher score is better, but score is not normalized. Use calibratedProbability if available. | [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) diff --git a/docs/SoftwareVersionOut.md b/docs/SoftwareVersionOut.md index 81dd9fb..719076e 100644 --- a/docs/SoftwareVersionOut.md +++ b/docs/SoftwareVersionOut.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**software_name_and_version** | **str** | | [optional] -**software_version** | **list[int]** | | [optional] +**software_name_and_version** | **str** | The software version | [optional] +**software_version** | **list[int]** | The software version major minor build | [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) diff --git a/openapi_client/__init__.py b/openapi_client/__init__.py index 32135f8..67659d1 100644 --- a/openapi_client/__init__.py +++ b/openapi_client/__init__.py @@ -5,9 +5,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -15,7 +15,7 @@ from __future__ import absolute_import -__version__ = "2.0.13" +__version__ = "2.0.15" # import apis into sdk package from openapi_client.api.admin_api import AdminApi @@ -36,12 +36,11 @@ from openapi_client.models.api_counter_v2_out import APICounterV2Out from openapi_client.models.api_key_out import APIKeyOut from openapi_client.models.api_period_usage_out import APIPeriodUsageOut -from openapi_client.models.api_plan_out import APIPlanOut from openapi_client.models.api_plan_subscription_out import APIPlanSubscriptionOut -from openapi_client.models.api_plans_out import APIPlansOut from openapi_client.models.api_service_out import APIServiceOut from openapi_client.models.api_services_out import APIServicesOut from openapi_client.models.api_usage_aggregated_out import APIUsageAggregatedOut +from openapi_client.models.api_usage_history_out import APIUsageHistoryOut from openapi_client.models.batch_corridor_in import BatchCorridorIn from openapi_client.models.batch_corridor_out import BatchCorridorOut from openapi_client.models.batch_first_last_name_diasporaed_out import BatchFirstLastNameDiasporaedOut @@ -60,22 +59,14 @@ from openapi_client.models.batch_name_in import BatchNameIn from openapi_client.models.batch_name_match_candidates_out import BatchNameMatchCandidatesOut from openapi_client.models.batch_name_matched_out import BatchNameMatchedOut -from openapi_client.models.batch_parsed_full_name_geo_in import BatchParsedFullNameGeoIn -from openapi_client.models.batch_parsed_full_name_in import BatchParsedFullNameIn from openapi_client.models.batch_personal_name_gendered_out import BatchPersonalNameGenderedOut from openapi_client.models.batch_personal_name_geo_in import BatchPersonalNameGeoIn from openapi_client.models.batch_personal_name_geo_out import BatchPersonalNameGeoOut from openapi_client.models.batch_personal_name_in import BatchPersonalNameIn from openapi_client.models.batch_personal_name_parsed_out import BatchPersonalNameParsedOut from openapi_client.models.batch_proper_noun_categorized_out import BatchProperNounCategorizedOut -from openapi_client.models.billing_history_out import BillingHistoryOut -from openapi_client.models.billing_info_in_out import BillingInfoInOut -from openapi_client.models.cache_metrics_out import CacheMetricsOut -from openapi_client.models.classifier_metrics_out import ClassifierMetricsOut from openapi_client.models.corridor_in import CorridorIn from openapi_client.models.corridor_out import CorridorOut -from openapi_client.models.currencies_out import CurrenciesOut -from openapi_client.models.expected_class_metrics_out import ExpectedClassMetricsOut from openapi_client.models.feedback_loop_out import FeedbackLoopOut from openapi_client.models.first_last_name_diasporaed_out import FirstLastNameDiasporaedOut from openapi_client.models.first_last_name_gender_in import FirstLastNameGenderIn @@ -89,29 +80,16 @@ from openapi_client.models.first_last_name_phone_number_geo_in import FirstLastNamePhoneNumberGeoIn from openapi_client.models.first_last_name_phone_number_in import FirstLastNamePhoneNumberIn from openapi_client.models.first_last_name_us_race_ethnicity_out import FirstLastNameUSRaceEthnicityOut -from openapi_client.models.inline_object import InlineObject -from openapi_client.models.invoice_item_out import InvoiceItemOut -from openapi_client.models.invoice_out import InvoiceOut from openapi_client.models.match_personal_first_last_name_in import MatchPersonalFirstLastNameIn -from openapi_client.models.nam_sor_counter_out import NamSorCounterOut from openapi_client.models.name_geo_in import NameGeoIn from openapi_client.models.name_in import NameIn from openapi_client.models.name_match_candidate_out import NameMatchCandidateOut from openapi_client.models.name_match_candidates_out import NameMatchCandidatesOut from openapi_client.models.name_matched_out import NameMatchedOut -from openapi_client.models.parsed_full_name_geo_in import ParsedFullNameGeoIn -from openapi_client.models.parsed_full_name_in import ParsedFullNameIn from openapi_client.models.personal_name_gendered_out import PersonalNameGenderedOut from openapi_client.models.personal_name_geo_in import PersonalNameGeoIn from openapi_client.models.personal_name_geo_out import PersonalNameGeoOut from openapi_client.models.personal_name_in import PersonalNameIn from openapi_client.models.personal_name_parsed_out import PersonalNameParsedOut from openapi_client.models.proper_noun_categorized_out import ProperNounCategorizedOut -from openapi_client.models.romanized_name_out import RomanizedNameOut from openapi_client.models.software_version_out import SoftwareVersionOut -from openapi_client.models.source_detailed_metrics_out import SourceDetailedMetricsOut -from openapi_client.models.source_metrics_out import SourceMetricsOut -from openapi_client.models.stripe_card_out import StripeCardOut -from openapi_client.models.stripe_customer_out import StripeCustomerOut -from openapi_client.models.system_metrics_out import SystemMetricsOut -from openapi_client.models.user_info_out import UserInfoOut diff --git a/openapi_client/api/admin_api.py b/openapi_client/api/admin_api.py index ef0b9f2..8d09cb0 100644 --- a/openapi_client/api/admin_api.py +++ b/openapi_client/api/admin_api.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -33,116 +33,6 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client - def add_credits(self, api_key, usage_credits, user_message, **kwargs): # noqa: E501 - """Add usage credits to an API Key. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.add_credits(api_key, usage_credits, user_message, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str api_key: (required) - :param int usage_credits: (required) - :param str user_message: (required) - :return: SystemMetricsOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.add_credits_with_http_info(api_key, usage_credits, user_message, **kwargs) # noqa: E501 - else: - (data) = self.add_credits_with_http_info(api_key, usage_credits, user_message, **kwargs) # noqa: E501 - return data - - def add_credits_with_http_info(self, api_key, usage_credits, user_message, **kwargs): # noqa: E501 - """Add usage credits to an API Key. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.add_credits_with_http_info(api_key, usage_credits, user_message, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str api_key: (required) - :param int usage_credits: (required) - :param str user_message: (required) - :return: SystemMetricsOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['api_key', 'usage_credits', 'user_message'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method add_credits" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'api_key' is set - if ('api_key' not in local_var_params or - local_var_params['api_key'] is None): - raise ValueError("Missing the required parameter `api_key` when calling `add_credits`") # noqa: E501 - # verify the required parameter 'usage_credits' is set - if ('usage_credits' not in local_var_params or - local_var_params['usage_credits'] is None): - raise ValueError("Missing the required parameter `usage_credits` when calling `add_credits`") # noqa: E501 - # verify the required parameter 'user_message' is set - if ('user_message' not in local_var_params or - local_var_params['user_message'] is None): - raise ValueError("Missing the required parameter `user_message` when calling `add_credits`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'api_key' in local_var_params: - path_params['apiKey'] = local_var_params['api_key'] # noqa: E501 - if 'usage_credits' in local_var_params: - path_params['usageCredits'] = local_var_params['usage_credits'] # noqa: E501 - if 'user_message' in local_var_params: - path_params['userMessage'] = local_var_params['user_message'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/addCredits/{apiKey}/{usageCredits}/{userMessage}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SystemMetricsOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - def anonymize(self, source, anonymized, **kwargs): # noqa: E501 """Activate/deactivate anonymization for a source. # noqa: E501 @@ -242,7 +132,7 @@ def anonymize_with_http_info(self, source, anonymized, **kwargs): # noqa: E501 collection_formats=collection_formats) def api_status(self, **kwargs): # noqa: E501 - """Prints the current status of the classifiers. # noqa: E501 + """Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -250,7 +140,7 @@ def api_status(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :return: APIPlansOut + :return: APIClassifiersStatusOut If the method is called asynchronously, returns the request thread. """ @@ -262,7 +152,7 @@ def api_status(self, **kwargs): # noqa: E501 return data def api_status_with_http_info(self, **kwargs): # noqa: E501 - """Prints the current status of the classifiers. # noqa: E501 + """Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -270,7 +160,7 @@ def api_status_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :return: APIPlansOut + :return: APIClassifiersStatusOut If the method is called asynchronously, returns the request thread. """ @@ -319,7 +209,7 @@ def api_status_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='APIPlansOut', # noqa: E501 + response_type='APIClassifiersStatusOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -422,7 +312,7 @@ def api_usage_history(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :return: APIPeriodUsageOut + :return: APIUsageHistoryOut If the method is called asynchronously, returns the request thread. """ @@ -442,7 +332,7 @@ def api_usage_history_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :return: APIPeriodUsageOut + :return: APIUsageHistoryOut If the method is called asynchronously, returns the request thread. """ @@ -491,7 +381,7 @@ def api_usage_history_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='APIPeriodUsageOut', # noqa: E501 + response_type='APIUsageHistoryOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -508,7 +398,7 @@ def api_usage_history_aggregate(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :return: APIPeriodUsageOut + :return: APIUsageAggregatedOut If the method is called asynchronously, returns the request thread. """ @@ -528,7 +418,7 @@ def api_usage_history_aggregate_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :return: APIPeriodUsageOut + :return: APIUsageAggregatedOut If the method is called asynchronously, returns the request thread. """ @@ -577,101 +467,7 @@ def api_usage_history_aggregate_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='APIPeriodUsageOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _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 - - 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) - >>> 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 - else: - (data) = self.available_plans_with_http_info(token, **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 - - 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) - >>> 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.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method available_plans" % key - ) - 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 = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/availablePlans/{token}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIPlansOut', # noqa: E501 + response_type='APIUsageAggregatedOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -679,36 +475,36 @@ 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_services(self, **kwargs): # noqa: E501 + """List of classification services and usage cost in Units per classification (default is 1=ONE Unit). Some API endpoints (ex. Corridor) combine multiple classifiers. # 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_services(async_req=True) >>> result = thread.get() :param async_req bool - :return: APIPlansOut + :return: APIServicesOut 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_services_with_http_info(**kwargs) # noqa: E501 else: - (data) = self.available_plans1_with_http_info(**kwargs) # noqa: E501 + (data) = self.available_services_with_http_info(**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_services_with_http_info(self, **kwargs): # noqa: E501 + """List of classification services and usage cost in Units per classification (default is 1=ONE Unit). Some API endpoints (ex. Corridor) combine multiple classifiers. # 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_services_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool - :return: APIPlansOut + :return: APIServicesOut If the method is called asynchronously, returns the request thread. """ @@ -725,7 +521,7 @@ def available_plans1_with_http_info(self, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method available_plans1" % key + " to method available_services" % key ) local_var_params[key] = val del local_var_params['kwargs'] @@ -750,14 +546,14 @@ 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/apiServices', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='APIPlansOut', # noqa: E501 + response_type='APIServicesOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -765,43 +561,47 @@ def available_plans1_with_http_info(self, **kwargs): # noqa: E501 _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) - def available_services(self, **kwargs): # noqa: E501 - """List of API services and usage cost in Units (default is 1=ONE Unit). # noqa: E501 + def disable(self, source, disabled, **kwargs): # noqa: E501 + """Activate/deactivate an API Key. # 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_services(async_req=True) + >>> thread = api.disable(source, disabled, async_req=True) >>> result = thread.get() :param async_req bool - :return: APIPlansOut + :param str source: The API Key to set as enabled/disabled. (required) + :param bool disabled: (required) + :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.available_services_with_http_info(**kwargs) # noqa: E501 + return self.disable_with_http_info(source, disabled, **kwargs) # noqa: E501 else: - (data) = self.available_services_with_http_info(**kwargs) # noqa: E501 + (data) = self.disable_with_http_info(source, disabled, **kwargs) # noqa: E501 return data - def available_services_with_http_info(self, **kwargs): # noqa: E501 - """List of API services and usage cost in Units (default is 1=ONE Unit). # noqa: E501 + def disable_with_http_info(self, source, disabled, **kwargs): # noqa: E501 + """Activate/deactivate an API Key. # 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_services_with_http_info(async_req=True) + >>> thread = api.disable_with_http_info(source, disabled, async_req=True) >>> result = thread.get() :param async_req bool - :return: APIPlansOut + :param str source: The API Key to set as enabled/disabled. (required) + :param bool disabled: (required) + :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() - all_params = [] # noqa: E501 + all_params = ['source', 'disabled'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -811,14 +611,26 @@ def available_services_with_http_info(self, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method available_services" % key + " to method disable" % key ) local_var_params[key] = val del local_var_params['kwargs'] + # verify the required parameter 'source' is set + if ('source' not in local_var_params or + local_var_params['source'] is None): + raise ValueError("Missing the required parameter `source` when calling `disable`") # noqa: E501 + # verify the required parameter 'disabled' is set + if ('disabled' not in local_var_params or + local_var_params['disabled'] is None): + raise ValueError("Missing the required parameter `disabled` when calling `disable`") # noqa: E501 collection_formats = {} path_params = {} + if 'source' in local_var_params: + path_params['source'] = local_var_params['source'] # noqa: E501 + if 'disabled' in local_var_params: + path_params['disabled'] = local_var_params['disabled'] # noqa: E501 query_params = [] @@ -828,22 +640,18 @@ def available_services_with_http_info(self, **kwargs): # noqa: E501 local_var_files = {} body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - # Authentication setting auth_settings = ['api_key'] # noqa: E501 return self.api_client.call_api( - '/api2/json/apiServices', 'GET', + '/api2/json/disable/{source}/{disabled}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='APIPlansOut', # noqa: E501 + response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -851,43 +659,47 @@ def available_services_with_http_info(self, **kwargs): # noqa: E501 _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) - def billing_currencies(self, **kwargs): # noqa: E501 - """List possible currency options for billing (USD, EUR, GBP, ...) # noqa: E501 + def learnable(self, source, learnable, **kwargs): # noqa: E501 + """Activate/deactivate learning from a source. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.billing_currencies(async_req=True) + >>> thread = api.learnable(source, learnable, async_req=True) >>> result = thread.get() :param async_req bool - :return: CurrenciesOut + :param str source: The API Key to set as learnable/non learnable. (required) + :param bool learnable: (required) + :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.billing_currencies_with_http_info(**kwargs) # noqa: E501 + return self.learnable_with_http_info(source, learnable, **kwargs) # noqa: E501 else: - (data) = self.billing_currencies_with_http_info(**kwargs) # noqa: E501 + (data) = self.learnable_with_http_info(source, learnable, **kwargs) # noqa: E501 return data - def billing_currencies_with_http_info(self, **kwargs): # noqa: E501 - """List possible currency options for billing (USD, EUR, GBP, ...) # noqa: E501 + def learnable_with_http_info(self, source, learnable, **kwargs): # noqa: E501 + """Activate/deactivate learning from a source. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.billing_currencies_with_http_info(async_req=True) + >>> thread = api.learnable_with_http_info(source, learnable, async_req=True) >>> result = thread.get() :param async_req bool - :return: CurrenciesOut + :param str source: The API Key to set as learnable/non learnable. (required) + :param bool learnable: (required) + :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() - all_params = [] # noqa: E501 + all_params = ['source', 'learnable'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -897,14 +709,26 @@ def billing_currencies_with_http_info(self, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method billing_currencies" % key + " to method learnable" % key ) local_var_params[key] = val del local_var_params['kwargs'] + # verify the required parameter 'source' is set + if ('source' not in local_var_params or + local_var_params['source'] is None): + raise ValueError("Missing the required parameter `source` when calling `learnable`") # noqa: E501 + # verify the required parameter 'learnable' is set + if ('learnable' not in local_var_params or + local_var_params['learnable'] is None): + raise ValueError("Missing the required parameter `learnable` when calling `learnable`") # noqa: E501 collection_formats = {} path_params = {} + if 'source' in local_var_params: + path_params['source'] = local_var_params['source'] # noqa: E501 + if 'learnable' in local_var_params: + path_params['learnable'] = local_var_params['learnable'] # noqa: E501 query_params = [] @@ -914,22 +738,18 @@ def billing_currencies_with_http_info(self, **kwargs): # noqa: E501 local_var_files = {} body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - # Authentication setting auth_settings = ['api_key'] # noqa: E501 return self.api_client.call_api( - '/api2/json/billingCurrencies', 'GET', + '/api2/json/learnable/{source}/{learnable}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='CurrenciesOut', # noqa: E501 + response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -937,45 +757,43 @@ def billing_currencies_with_http_info(self, **kwargs): # noqa: E501 _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) - def billing_history(self, token, **kwargs): # noqa: E501 - """Read the history billing information (invoices paid via Stripe or manually). # noqa: E501 + def software_version(self, **kwargs): # noqa: E501 + """Get the current software version # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.billing_history(token, async_req=True) + >>> thread = api.software_version(async_req=True) >>> result = thread.get() :param async_req bool - :param str token: (required) - :return: BillingHistoryOut + :return: SoftwareVersionOut If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.billing_history_with_http_info(token, **kwargs) # noqa: E501 + return self.software_version_with_http_info(**kwargs) # noqa: E501 else: - (data) = self.billing_history_with_http_info(token, **kwargs) # noqa: E501 + (data) = self.software_version_with_http_info(**kwargs) # noqa: E501 return data - def billing_history_with_http_info(self, token, **kwargs): # noqa: E501 - """Read the history billing information (invoices paid via Stripe or manually). # noqa: E501 + def software_version_with_http_info(self, **kwargs): # noqa: E501 + """Get the current software version # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.billing_history_with_http_info(token, async_req=True) + >>> thread = api.software_version_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool - :param str token: (required) - :return: BillingHistoryOut + :return: SoftwareVersionOut 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') @@ -985,20 +803,14 @@ def billing_history_with_http_info(self, token, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method billing_history" % key + " to method software_version" % key ) 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 `billing_history`") # noqa: E501 collection_formats = {} path_params = {} - if 'token' in local_var_params: - path_params['token'] = local_var_params['token'] # noqa: E501 query_params = [] @@ -1016,14 +828,14 @@ def billing_history_with_http_info(self, token, **kwargs): # noqa: E501 auth_settings = ['api_key'] # noqa: E501 return self.api_client.call_api( - '/api2/json/billingHistory/{token}', 'GET', + '/api2/json/softwareVersion', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='BillingHistoryOut', # noqa: E501 + response_type='SoftwareVersionOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -1031,45 +843,45 @@ def billing_history_with_http_info(self, token, **kwargs): # noqa: E501 _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) - def billing_info(self, token, **kwargs): # noqa: E501 - """Read the billing information (company name, address, phone, vat ID) # noqa: E501 + def taxonomy_classes(self, classifier_name, **kwargs): # noqa: E501 + """Print the taxonomy classes valid for the given classifier. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.billing_info(token, async_req=True) + >>> thread = api.taxonomy_classes(classifier_name, async_req=True) >>> result = thread.get() :param async_req bool - :param str token: (required) - :return: BillingInfoInOut + :param str classifier_name: (required) + :return: APIClassifierTaxonomyOut If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.billing_info_with_http_info(token, **kwargs) # noqa: E501 + return self.taxonomy_classes_with_http_info(classifier_name, **kwargs) # noqa: E501 else: - (data) = self.billing_info_with_http_info(token, **kwargs) # noqa: E501 + (data) = self.taxonomy_classes_with_http_info(classifier_name, **kwargs) # noqa: E501 return data - def billing_info_with_http_info(self, token, **kwargs): # noqa: E501 - """Read the billing information (company name, address, phone, vat ID) # noqa: E501 + def taxonomy_classes_with_http_info(self, classifier_name, **kwargs): # noqa: E501 + """Print the taxonomy classes valid for the given classifier. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.billing_info_with_http_info(token, async_req=True) + >>> thread = api.taxonomy_classes_with_http_info(classifier_name, async_req=True) >>> result = thread.get() :param async_req bool - :param str token: (required) - :return: BillingInfoInOut + :param str classifier_name: (required) + :return: APIClassifierTaxonomyOut If the method is called asynchronously, returns the request thread. """ local_var_params = locals() - all_params = ['token'] # noqa: E501 + all_params = ['classifier_name'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1079,20 +891,20 @@ def billing_info_with_http_info(self, token, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method billing_info" % key + " to method taxonomy_classes" % key ) 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 `billing_info`") # noqa: E501 + # verify the required parameter 'classifier_name' is set + if ('classifier_name' not in local_var_params or + local_var_params['classifier_name'] is None): + raise ValueError("Missing the required parameter `classifier_name` when calling `taxonomy_classes`") # noqa: E501 collection_formats = {} path_params = {} - if 'token' in local_var_params: - path_params['token'] = local_var_params['token'] # noqa: E501 + if 'classifier_name' in local_var_params: + path_params['classifierName'] = local_var_params['classifier_name'] # noqa: E501 query_params = [] @@ -1110,2462 +922,14 @@ def billing_info_with_http_info(self, token, **kwargs): # noqa: E501 auth_settings = ['api_key'] # noqa: E501 return self.api_client.call_api( - '/api2/json/billingInfo/{token}', 'GET', + '/api2/json/taxonomyClasses/{classifierName}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='BillingInfoInOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def charge(self, **kwargs): # noqa: E501 - """Create a Stripe Customer, based on a payment card token (from secure StripeJS) and email. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.charge(async_req=True) - >>> result = thread.get() - - :param async_req bool - :param InlineObject inline_object: - :return: APIKeyOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.charge_with_http_info(**kwargs) # noqa: E501 - else: - (data) = self.charge_with_http_info(**kwargs) # noqa: E501 - return data - - def charge_with_http_info(self, **kwargs): # noqa: E501 - """Create a Stripe Customer, based on a payment card token (from secure StripeJS) and email. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.charge_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool - :param InlineObject inline_object: - :return: APIKeyOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['inline_object'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method charge" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'inline_object' in local_var_params: - body_params = local_var_params['inline_object'] - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/charge', 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIKeyOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def corporate_key(self, api_key, corporate, **kwargs): # noqa: E501 - """Setting an API Key to a corporate status. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.corporate_key(api_key, corporate, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str api_key: (required) - :param bool corporate: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.corporate_key_with_http_info(api_key, corporate, **kwargs) # noqa: E501 - else: - (data) = self.corporate_key_with_http_info(api_key, corporate, **kwargs) # noqa: E501 - return data - - def corporate_key_with_http_info(self, api_key, corporate, **kwargs): # noqa: E501 - """Setting an API Key to a corporate status. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.corporate_key_with_http_info(api_key, corporate, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str api_key: (required) - :param bool corporate: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['api_key', 'corporate'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method corporate_key" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'api_key' is set - if ('api_key' not in local_var_params or - local_var_params['api_key'] is None): - raise ValueError("Missing the required parameter `api_key` when calling `corporate_key`") # noqa: E501 - # verify the required parameter 'corporate' is set - if ('corporate' not in local_var_params or - local_var_params['corporate'] is None): - raise ValueError("Missing the required parameter `corporate` when calling `corporate_key`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'api_key' in local_var_params: - path_params['apiKey'] = local_var_params['api_key'] # noqa: E501 - if 'corporate' in local_var_params: - path_params['corporate'] = local_var_params['corporate'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/corporateKey/{apiKey}/{corporate}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def debug_level(self, logger, level, **kwargs): # noqa: E501 - """Update debug level for a classifier # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.debug_level(logger, level, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str logger: (required) - :param str level: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.debug_level_with_http_info(logger, level, **kwargs) # noqa: E501 - else: - (data) = self.debug_level_with_http_info(logger, level, **kwargs) # noqa: E501 - return data - - def debug_level_with_http_info(self, logger, level, **kwargs): # noqa: E501 - """Update debug level for a classifier # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.debug_level_with_http_info(logger, level, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str logger: (required) - :param str level: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['logger', 'level'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method debug_level" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'logger' is set - if ('logger' not in local_var_params or - local_var_params['logger'] is None): - raise ValueError("Missing the required parameter `logger` when calling `debug_level`") # noqa: E501 - # verify the required parameter 'level' is set - if ('level' not in local_var_params or - local_var_params['level'] is None): - raise ValueError("Missing the required parameter `level` when calling `debug_level`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'logger' in local_var_params: - path_params['logger'] = local_var_params['logger'] # noqa: E501 - if 'level' in local_var_params: - path_params['level'] = local_var_params['level'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/debugLevel/{logger}/{level}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def flush(self, **kwargs): # noqa: E501 - """Flush counters. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.flush(async_req=True) - >>> result = thread.get() - - :param async_req bool - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.flush_with_http_info(**kwargs) # noqa: E501 - else: - (data) = self.flush_with_http_info(**kwargs) # noqa: E501 - return data - - def flush_with_http_info(self, **kwargs): # noqa: E501 - """Flush counters. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.flush_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = [] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method flush" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/flush', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def invalidate_cache(self, **kwargs): # noqa: E501 - """Invalidate system caches. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.invalidate_cache(async_req=True) - >>> result = thread.get() - - :param async_req bool - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.invalidate_cache_with_http_info(**kwargs) # noqa: E501 - else: - (data) = self.invalidate_cache_with_http_info(**kwargs) # noqa: E501 - return data - - def invalidate_cache_with_http_info(self, **kwargs): # noqa: E501 - """Invalidate system caches. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.invalidate_cache_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = [] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method invalidate_cache" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/invalidateCache', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def learnable(self, source, learnable, **kwargs): # noqa: E501 - """Activate/deactivate learning from a source. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.learnable(source, learnable, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str source: (required) - :param bool learnable: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.learnable_with_http_info(source, learnable, **kwargs) # noqa: E501 - else: - (data) = self.learnable_with_http_info(source, learnable, **kwargs) # noqa: E501 - return data - - def learnable_with_http_info(self, source, learnable, **kwargs): # noqa: E501 - """Activate/deactivate learning from a source. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.learnable_with_http_info(source, learnable, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str source: (required) - :param bool learnable: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['source', 'learnable'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method learnable" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'source' is set - if ('source' not in local_var_params or - local_var_params['source'] is None): - raise ValueError("Missing the required parameter `source` when calling `learnable`") # noqa: E501 - # verify the required parameter 'learnable' is set - if ('learnable' not in local_var_params or - local_var_params['learnable'] is None): - raise ValueError("Missing the required parameter `learnable` when calling `learnable`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'source' in local_var_params: - path_params['source'] = local_var_params['source'] # noqa: E501 - if 'learnable' in local_var_params: - path_params['learnable'] = local_var_params['learnable'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/learnable/{source}/{learnable}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def namsor_counter(self, **kwargs): # noqa: E501 - """Get the overall API counter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.namsor_counter(async_req=True) - >>> result = thread.get() - - :param async_req bool - :return: SoftwareVersionOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.namsor_counter_with_http_info(**kwargs) # noqa: E501 - else: - (data) = self.namsor_counter_with_http_info(**kwargs) # noqa: E501 - return data - - def namsor_counter_with_http_info(self, **kwargs): # noqa: E501 - """Get the overall API counter # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.namsor_counter_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool - :return: SoftwareVersionOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = [] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method namsor_counter" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/namsorCounter', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SoftwareVersionOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def payment_info(self, token, **kwargs): # noqa: E501 - """Get the Stripe payment information associated with the current google auth session token. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.payment_info(token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str token: (required) - :return: APIKeyOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.payment_info_with_http_info(token, **kwargs) # noqa: E501 - else: - (data) = self.payment_info_with_http_info(token, **kwargs) # noqa: E501 - return data - - def payment_info_with_http_info(self, token, **kwargs): # noqa: E501 - """Get the Stripe payment information associated with the current google auth session token. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.payment_info_with_http_info(token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str token: (required) - :return: APIKeyOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['token'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method payment_info" % key - ) - 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 `payment_info`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'token' in local_var_params: - path_params['token'] = local_var_params['token'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/paymentInfo/{token}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIKeyOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def procure_key(self, token, **kwargs): # noqa: E501 - """Procure an API Key (sent via Email), based on an auth token. Keep your API Key secret. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.procure_key(token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str token: (required) - :return: APIKeyOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.procure_key_with_http_info(token, **kwargs) # noqa: E501 - else: - (data) = self.procure_key_with_http_info(token, **kwargs) # noqa: E501 - return data - - def procure_key_with_http_info(self, token, **kwargs): # noqa: E501 - """Procure an API Key (sent via Email), based on an auth token. Keep your API Key secret. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.procure_key_with_http_info(token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str token: (required) - :return: APIKeyOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['token'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method procure_key" % key - ) - 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 `procure_key`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'token' in local_var_params: - path_params['token'] = local_var_params['token'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/procureKey/{token}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIKeyOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def remove_user_account(self, token, **kwargs): # noqa: E501 - """Remove the user account. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.remove_user_account(token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str token: (required) - :return: APIPlanSubscriptionOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.remove_user_account_with_http_info(token, **kwargs) # noqa: E501 - else: - (data) = self.remove_user_account_with_http_info(token, **kwargs) # noqa: E501 - return data - - def remove_user_account_with_http_info(self, token, **kwargs): # noqa: E501 - """Remove the user account. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.remove_user_account_with_http_info(token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str token: (required) - :return: APIPlanSubscriptionOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['token'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method remove_user_account" % key - ) - 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 `remove_user_account`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'token' in local_var_params: - path_params['token'] = local_var_params['token'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/removeUserAccount/{token}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIPlanSubscriptionOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def remove_user_account_on_behalf(self, api_key, **kwargs): # noqa: E501 - """Remove (on behalf) a user account. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.remove_user_account_on_behalf(api_key, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str api_key: (required) - :return: APIPlanSubscriptionOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.remove_user_account_on_behalf_with_http_info(api_key, **kwargs) # noqa: E501 - else: - (data) = self.remove_user_account_on_behalf_with_http_info(api_key, **kwargs) # noqa: E501 - return data - - def remove_user_account_on_behalf_with_http_info(self, api_key, **kwargs): # noqa: E501 - """Remove (on behalf) a user account. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.remove_user_account_on_behalf_with_http_info(api_key, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str api_key: (required) - :return: APIPlanSubscriptionOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['api_key'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method remove_user_account_on_behalf" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'api_key' is set - if ('api_key' not in local_var_params or - local_var_params['api_key'] is None): - raise ValueError("Missing the required parameter `api_key` when calling `remove_user_account_on_behalf`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'api_key' in local_var_params: - path_params['apiKey'] = local_var_params['api_key'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/removeUserAccountOnBehalf/{apiKey}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIPlanSubscriptionOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def shutdown(self, **kwargs): # noqa: E501 - """Stop learning and shutdown system. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.shutdown(async_req=True) - >>> result = thread.get() - - :param async_req bool - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.shutdown_with_http_info(**kwargs) # noqa: E501 - else: - (data) = self.shutdown_with_http_info(**kwargs) # noqa: E501 - return data - - def shutdown_with_http_info(self, **kwargs): # noqa: E501 - """Stop learning and shutdown system. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.shutdown_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = [] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method shutdown" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/shutdown', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def software_version(self, **kwargs): # noqa: E501 - """Get the current software version # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.software_version(async_req=True) - >>> result = thread.get() - - :param async_req bool - :return: SoftwareVersionOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.software_version_with_http_info(**kwargs) # noqa: E501 - else: - (data) = self.software_version_with_http_info(**kwargs) # noqa: E501 - return data - - def software_version_with_http_info(self, **kwargs): # noqa: E501 - """Get the current software version # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.software_version_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool - :return: SoftwareVersionOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = [] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method software_version" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/softwareVersion', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SoftwareVersionOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def source_stats(self, source, **kwargs): # noqa: E501 - """Print basic source statistics. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.source_stats(source, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str source: (required) - :return: SystemMetricsOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.source_stats_with_http_info(source, **kwargs) # noqa: E501 - else: - (data) = self.source_stats_with_http_info(source, **kwargs) # noqa: E501 - return data - - def source_stats_with_http_info(self, source, **kwargs): # noqa: E501 - """Print basic source statistics. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.source_stats_with_http_info(source, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str source: (required) - :return: SystemMetricsOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['source'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method source_stats" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'source' is set - if ('source' not in local_var_params or - local_var_params['source'] is None): - raise ValueError("Missing the required parameter `source` when calling `source_stats`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'source' in local_var_params: - path_params['source'] = local_var_params['source'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/sourceStats/{source}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SystemMetricsOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def stats(self, **kwargs): # noqa: E501 - """Print basic system statistics. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.stats(async_req=True) - >>> result = thread.get() - - :param async_req bool - :return: SystemMetricsOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.stats_with_http_info(**kwargs) # noqa: E501 - else: - (data) = self.stats_with_http_info(**kwargs) # noqa: E501 - return data - - def stats_with_http_info(self, **kwargs): # noqa: E501 - """Print basic system statistics. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.stats_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool - :return: SystemMetricsOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = [] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method stats" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/stats', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SystemMetricsOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def stripe_connect(self, **kwargs): # noqa: E501 - """Connects a Stripe Account. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.stripe_connect(async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str scope: - :param str code: - :param str error: - :param str error_description: - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.stripe_connect_with_http_info(**kwargs) # noqa: E501 - else: - (data) = self.stripe_connect_with_http_info(**kwargs) # noqa: E501 - return data - - def stripe_connect_with_http_info(self, **kwargs): # noqa: E501 - """Connects a Stripe Account. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.stripe_connect_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str scope: - :param str code: - :param str error: - :param str error_description: - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['scope', 'code', 'error', 'error_description'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method stripe_connect" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - if 'scope' in local_var_params: - query_params.append(('scope', local_var_params['scope'])) # noqa: E501 - if 'code' in local_var_params: - query_params.append(('code', local_var_params['code'])) # noqa: E501 - if 'error' in local_var_params: - query_params.append(('error', local_var_params['error'])) # noqa: E501 - if 'error_description' in local_var_params: - query_params.append(('error_description', local_var_params['error_description'])) # noqa: E501 - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/stripeConnect', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def subscribe_plan(self, plan_name, token, **kwargs): # noqa: E501 - """Subscribe to a give API plan, using the user's preferred or default 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.subscribe_plan(plan_name, token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str plan_name: (required) - :param str token: (required) - :return: APIPlanSubscriptionOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.subscribe_plan_with_http_info(plan_name, token, **kwargs) # noqa: E501 - else: - (data) = self.subscribe_plan_with_http_info(plan_name, token, **kwargs) # noqa: E501 - return data - - def subscribe_plan_with_http_info(self, plan_name, token, **kwargs): # noqa: E501 - """Subscribe to a give API plan, using the user's preferred or default 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.subscribe_plan_with_http_info(plan_name, token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str plan_name: (required) - :param str token: (required) - :return: APIPlanSubscriptionOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['plan_name', 'token'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method subscribe_plan" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'plan_name' is set - if ('plan_name' not in local_var_params or - local_var_params['plan_name'] is None): - raise ValueError("Missing the required parameter `plan_name` when calling `subscribe_plan`") # noqa: E501 - # 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 `subscribe_plan`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'plan_name' in local_var_params: - path_params['planName'] = local_var_params['plan_name'] # noqa: E501 - if 'token' in local_var_params: - path_params['token'] = local_var_params['token'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/subscribePlan/{planName}/{token}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIPlanSubscriptionOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def subscribe_plan_on_behalf(self, plan_name, api_key, **kwargs): # noqa: E501 - """Subscribe to a give API plan, using the user's preferred or default currency (admin only). # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.subscribe_plan_on_behalf(plan_name, api_key, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str plan_name: (required) - :param str api_key: (required) - :return: APIPlanSubscriptionOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.subscribe_plan_on_behalf_with_http_info(plan_name, api_key, **kwargs) # noqa: E501 - else: - (data) = self.subscribe_plan_on_behalf_with_http_info(plan_name, api_key, **kwargs) # noqa: E501 - return data - - def subscribe_plan_on_behalf_with_http_info(self, plan_name, api_key, **kwargs): # noqa: E501 - """Subscribe to a give API plan, using the user's preferred or default currency (admin only). # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.subscribe_plan_on_behalf_with_http_info(plan_name, api_key, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str plan_name: (required) - :param str api_key: (required) - :return: APIPlanSubscriptionOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['plan_name', 'api_key'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method subscribe_plan_on_behalf" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'plan_name' is set - if ('plan_name' not in local_var_params or - local_var_params['plan_name'] is None): - raise ValueError("Missing the required parameter `plan_name` when calling `subscribe_plan_on_behalf`") # noqa: E501 - # verify the required parameter 'api_key' is set - if ('api_key' not in local_var_params or - local_var_params['api_key'] is None): - raise ValueError("Missing the required parameter `api_key` when calling `subscribe_plan_on_behalf`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'plan_name' in local_var_params: - path_params['planName'] = local_var_params['plan_name'] # noqa: E501 - if 'api_key' in local_var_params: - path_params['apiKey'] = local_var_params['api_key'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/subscribePlanOnBehalf/{planName}/{apiKey}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIPlanSubscriptionOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def taxonomy_classes(self, classifier_name, **kwargs): # noqa: E501 - """Print the taxonomy classes valid for the given classifier. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.taxonomy_classes(classifier_name, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str classifier_name: (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.taxonomy_classes_with_http_info(classifier_name, **kwargs) # noqa: E501 - else: - (data) = self.taxonomy_classes_with_http_info(classifier_name, **kwargs) # noqa: E501 - return data - - def taxonomy_classes_with_http_info(self, classifier_name, **kwargs): # noqa: E501 - """Print the taxonomy classes valid for the given classifier. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.taxonomy_classes_with_http_info(classifier_name, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str classifier_name: (required) - :return: APIPlansOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['classifier_name'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method taxonomy_classes" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'classifier_name' is set - if ('classifier_name' not in local_var_params or - local_var_params['classifier_name'] is None): - raise ValueError("Missing the required parameter `classifier_name` when calling `taxonomy_classes`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'classifier_name' in local_var_params: - path_params['classifierName'] = local_var_params['classifier_name'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/taxonomyClasses/{classifierName}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIPlansOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def update_billing_info(self, token, **kwargs): # noqa: E501 - """Sets or update the billing information (company name, address, phone, vat ID) # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_billing_info(token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str token: (required) - :param BillingInfoInOut billing_info_in_out: - :return: BillingInfoInOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.update_billing_info_with_http_info(token, **kwargs) # noqa: E501 - else: - (data) = self.update_billing_info_with_http_info(token, **kwargs) # noqa: E501 - return data - - def update_billing_info_with_http_info(self, token, **kwargs): # noqa: E501 - """Sets or update the billing information (company name, address, phone, vat ID) # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_billing_info_with_http_info(token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str token: (required) - :param BillingInfoInOut billing_info_in_out: - :return: BillingInfoInOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['token', 'billing_info_in_out'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_billing_info" % key - ) - 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 `update_billing_info`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'token' in local_var_params: - path_params['token'] = local_var_params['token'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'billing_info_in_out' in local_var_params: - body_params = local_var_params['billing_info_in_out'] - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 - ['application/json;charset=UTF-8']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/updateBillingInfo/{token}', 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='BillingInfoInOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def update_limit(self, usage_limit, hard_or_soft, token, **kwargs): # noqa: E501 - """Modifies the hard/soft limit on the API plan's overages (default is 0$ soft limit). # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_limit(usage_limit, hard_or_soft, token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param int usage_limit: (required) - :param bool hard_or_soft: (required) - :param str token: (required) - :return: APIPeriodUsageOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.update_limit_with_http_info(usage_limit, hard_or_soft, token, **kwargs) # noqa: E501 - else: - (data) = self.update_limit_with_http_info(usage_limit, hard_or_soft, token, **kwargs) # noqa: E501 - return data - - def update_limit_with_http_info(self, usage_limit, hard_or_soft, token, **kwargs): # noqa: E501 - """Modifies the hard/soft limit on the API plan's overages (default is 0$ soft limit). # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_limit_with_http_info(usage_limit, hard_or_soft, token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param int usage_limit: (required) - :param bool hard_or_soft: (required) - :param str token: (required) - :return: APIPeriodUsageOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['usage_limit', 'hard_or_soft', 'token'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_limit" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'usage_limit' is set - if ('usage_limit' not in local_var_params or - local_var_params['usage_limit'] is None): - raise ValueError("Missing the required parameter `usage_limit` when calling `update_limit`") # noqa: E501 - # verify the required parameter 'hard_or_soft' is set - if ('hard_or_soft' not in local_var_params or - local_var_params['hard_or_soft'] is None): - raise ValueError("Missing the required parameter `hard_or_soft` when calling `update_limit`") # noqa: E501 - # 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 `update_limit`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'usage_limit' in local_var_params: - path_params['usageLimit'] = local_var_params['usage_limit'] # noqa: E501 - if 'hard_or_soft' in local_var_params: - path_params['hardOrSoft'] = local_var_params['hard_or_soft'] # noqa: E501 - if 'token' in local_var_params: - path_params['token'] = local_var_params['token'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/updateLimit/{usageLimit}/{hardOrSoft}/{token}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIPeriodUsageOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def update_payment_default(self, defaut_source_id, token, **kwargs): # noqa: E501 - """Update the default Stripe card associated with the current google auth session token. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_payment_default(defaut_source_id, token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str defaut_source_id: (required) - :param str token: (required) - :return: APIKeyOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.update_payment_default_with_http_info(defaut_source_id, token, **kwargs) # noqa: E501 - else: - (data) = self.update_payment_default_with_http_info(defaut_source_id, token, **kwargs) # noqa: E501 - return data - - def update_payment_default_with_http_info(self, defaut_source_id, token, **kwargs): # noqa: E501 - """Update the default Stripe card associated with the current google auth session token. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_payment_default_with_http_info(defaut_source_id, token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str defaut_source_id: (required) - :param str token: (required) - :return: APIKeyOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['defaut_source_id', 'token'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_payment_default" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'defaut_source_id' is set - if ('defaut_source_id' not in local_var_params or - local_var_params['defaut_source_id'] is None): - raise ValueError("Missing the required parameter `defaut_source_id` when calling `update_payment_default`") # noqa: E501 - # 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 `update_payment_default`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'defaut_source_id' in local_var_params: - path_params['defautSourceId'] = local_var_params['defaut_source_id'] # noqa: E501 - if 'token' in local_var_params: - path_params['token'] = local_var_params['token'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/updatePaymentDefault/{defautSourceId}/{token}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIKeyOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def user_info(self, token, **kwargs): # noqa: E501 - """Get the user profile associated with the current google auth session token. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.user_info(token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str token: (required) - :return: APIKeyOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.user_info_with_http_info(token, **kwargs) # noqa: E501 - else: - (data) = self.user_info_with_http_info(token, **kwargs) # noqa: E501 - return data - - def user_info_with_http_info(self, token, **kwargs): # noqa: E501 - """Get the user profile associated with the current google auth session token. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.user_info_with_http_info(token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str token: (required) - :return: APIKeyOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['token'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method user_info" % key - ) - 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 `user_info`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'token' in local_var_params: - path_params['token'] = local_var_params['token'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/userInfo/{token}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIKeyOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def verify_email(self, email_token, **kwargs): # noqa: E501 - """Verifies an email, based on token sent to that email # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.verify_email(email_token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str email_token: (required) - :return: APIKeyOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.verify_email_with_http_info(email_token, **kwargs) # noqa: E501 - else: - (data) = self.verify_email_with_http_info(email_token, **kwargs) # noqa: E501 - return data - - def verify_email_with_http_info(self, email_token, **kwargs): # noqa: E501 - """Verifies an email, based on token sent to that email # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.verify_email_with_http_info(email_token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str email_token: (required) - :return: APIKeyOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['email_token'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method verify_email" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'email_token' is set - if ('email_token' not in local_var_params or - local_var_params['email_token'] is None): - raise ValueError("Missing the required parameter `email_token` when calling `verify_email`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'email_token' in local_var_params: - path_params['emailToken'] = local_var_params['email_token'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/verifyEmail/{emailToken}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIKeyOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def verify_remove_email(self, email_token, **kwargs): # noqa: E501 - """Verifies an email, based on token sent to that email # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.verify_remove_email(email_token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str email_token: (required) - :return: APIKeyOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.verify_remove_email_with_http_info(email_token, **kwargs) # noqa: E501 - else: - (data) = self.verify_remove_email_with_http_info(email_token, **kwargs) # noqa: E501 - return data - - def verify_remove_email_with_http_info(self, email_token, **kwargs): # noqa: E501 - """Verifies an email, based on token sent to that email # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.verify_remove_email_with_http_info(email_token, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str email_token: (required) - :return: APIKeyOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['email_token'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method verify_remove_email" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'email_token' is set - if ('email_token' not in local_var_params or - local_var_params['email_token'] is None): - raise ValueError("Missing the required parameter `email_token` when calling `verify_remove_email`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'email_token' in local_var_params: - path_params['emailToken'] = local_var_params['email_token'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/verifyRemoveEmail/{emailToken}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIKeyOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def vet(self, source, vetted, **kwargs): # noqa: E501 - """Vetting of a source. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.vet(source, vetted, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str source: (required) - :param bool vetted: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.vet_with_http_info(source, vetted, **kwargs) # noqa: E501 - else: - (data) = self.vet_with_http_info(source, vetted, **kwargs) # noqa: E501 - return data - - def vet_with_http_info(self, source, vetted, **kwargs): # noqa: E501 - """Vetting of a source. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.vet_with_http_info(source, vetted, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str source: (required) - :param bool vetted: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['source', 'vetted'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method vet" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'source' is set - if ('source' not in local_var_params or - local_var_params['source'] is None): - raise ValueError("Missing the required parameter `source` when calling `vet`") # noqa: E501 - # verify the required parameter 'vetted' is set - if ('vetted' not in local_var_params or - local_var_params['vetted'] is None): - raise ValueError("Missing the required parameter `vetted` when calling `vet`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'source' in local_var_params: - path_params['source'] = local_var_params['source'] # noqa: E501 - if 'vetted' in local_var_params: - path_params['vetted'] = local_var_params['vetted'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/vetting/{source}/{vetted}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, # noqa: E501 + response_type='APIClassifierTaxonomyOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 diff --git a/openapi_client/api/chinese_api.py b/openapi_client/api/chinese_api.py index b950b62..34c5f64 100644 --- a/openapi_client/api/chinese_api.py +++ b/openapi_client/api/chinese_api.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -44,7 +44,7 @@ def chinese_name_candidates(self, chinese_surname_latin, chinese_given_name_lati :param async_req bool :param str chinese_surname_latin: (required) :param str chinese_given_name_latin: (required) - :return: RomanizedNameOut + :return: NameMatchCandidatesOut If the method is called asynchronously, returns the request thread. """ @@ -66,7 +66,7 @@ def chinese_name_candidates_with_http_info(self, chinese_surname_latin, chinese_ :param async_req bool :param str chinese_surname_latin: (required) :param str chinese_given_name_latin: (required) - :return: RomanizedNameOut + :return: NameMatchCandidatesOut If the method is called asynchronously, returns the request thread. """ @@ -127,7 +127,7 @@ def chinese_name_candidates_with_http_info(self, chinese_surname_latin, chinese_ body=body_params, post_params=form_params, files=local_var_files, - response_type='RomanizedNameOut', # noqa: E501 + response_type='NameMatchCandidatesOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -238,7 +238,7 @@ def chinese_name_candidates_gender_batch(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :param BatchFirstLastNameIn batch_first_last_name_in: A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname + :param BatchFirstLastNameGenderIn batch_first_last_name_gender_in: A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname :return: BatchNameMatchCandidatesOut If the method is called asynchronously, returns the request thread. @@ -259,7 +259,7 @@ def chinese_name_candidates_gender_batch_with_http_info(self, **kwargs): # noqa >>> result = thread.get() :param async_req bool - :param BatchFirstLastNameIn batch_first_last_name_in: A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname + :param BatchFirstLastNameGenderIn batch_first_last_name_gender_in: A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname :return: BatchNameMatchCandidatesOut If the method is called asynchronously, returns the request thread. @@ -267,7 +267,7 @@ def chinese_name_candidates_gender_batch_with_http_info(self, **kwargs): # noqa local_var_params = locals() - all_params = ['batch_first_last_name_in'] # noqa: E501 + all_params = ['batch_first_last_name_gender_in'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -294,8 +294,8 @@ def chinese_name_candidates_gender_batch_with_http_info(self, **kwargs): # noqa local_var_files = {} body_params = None - if 'batch_first_last_name_in' in local_var_params: - body_params = local_var_params['batch_first_last_name_in'] + if 'batch_first_last_name_gender_in' in local_var_params: + body_params = local_var_params['batch_first_last_name_gender_in'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 @@ -335,7 +335,7 @@ def chinese_name_gender_candidates(self, chinese_surname_latin, chinese_given_na :param str chinese_surname_latin: (required) :param str chinese_given_name_latin: (required) :param str known_gender: (required) - :return: RomanizedNameOut + :return: NameMatchCandidatesOut If the method is called asynchronously, returns the request thread. """ @@ -358,7 +358,7 @@ def chinese_name_gender_candidates_with_http_info(self, chinese_surname_latin, c :param str chinese_surname_latin: (required) :param str chinese_given_name_latin: (required) :param str known_gender: (required) - :return: RomanizedNameOut + :return: NameMatchCandidatesOut If the method is called asynchronously, returns the request thread. """ @@ -425,7 +425,7 @@ def chinese_name_gender_candidates_with_http_info(self, chinese_surname_latin, c body=body_params, post_params=form_params, files=local_var_files, - response_type='RomanizedNameOut', # noqa: E501 + response_type='NameMatchCandidatesOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -445,7 +445,7 @@ def chinese_name_match(self, chinese_surname_latin, chinese_given_name_latin, ch :param str chinese_surname_latin: (required) :param str chinese_given_name_latin: (required) :param str chinese_name: (required) - :return: RomanizedNameOut + :return: NameMatchedOut If the method is called asynchronously, returns the request thread. """ @@ -468,7 +468,7 @@ def chinese_name_match_with_http_info(self, chinese_surname_latin, chinese_given :param str chinese_surname_latin: (required) :param str chinese_given_name_latin: (required) :param str chinese_name: (required) - :return: RomanizedNameOut + :return: NameMatchedOut If the method is called asynchronously, returns the request thread. """ @@ -535,7 +535,7 @@ def chinese_name_match_with_http_info(self, chinese_surname_latin, chinese_given body=body_params, post_params=form_params, files=local_var_files, - response_type='RomanizedNameOut', # noqa: E501 + response_type='NameMatchedOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -552,8 +552,8 @@ def chinese_name_match_batch(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :param BatchFirstLastNameIn batch_first_last_name_in: A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname - :return: BatchNameMatchCandidatesOut + :param BatchMatchPersonalFirstLastNameIn batch_match_personal_first_last_name_in: A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname + :return: BatchNameMatchedOut If the method is called asynchronously, returns the request thread. """ @@ -573,15 +573,15 @@ def chinese_name_match_batch_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :param BatchFirstLastNameIn batch_first_last_name_in: A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname - :return: BatchNameMatchCandidatesOut + :param BatchMatchPersonalFirstLastNameIn batch_match_personal_first_last_name_in: A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname + :return: BatchNameMatchedOut If the method is called asynchronously, returns the request thread. """ local_var_params = locals() - all_params = ['batch_first_last_name_in'] # noqa: E501 + all_params = ['batch_match_personal_first_last_name_in'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -608,8 +608,8 @@ def chinese_name_match_batch_with_http_info(self, **kwargs): # noqa: E501 local_var_files = {} body_params = None - if 'batch_first_last_name_in' in local_var_params: - body_params = local_var_params['batch_first_last_name_in'] + if 'batch_match_personal_first_last_name_in' in local_var_params: + body_params = local_var_params['batch_match_personal_first_last_name_in'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 @@ -629,7 +629,7 @@ def chinese_name_match_batch_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='BatchNameMatchCandidatesOut', # noqa: E501 + response_type='BatchNameMatchedOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 diff --git a/openapi_client/api/general_api.py b/openapi_client/api/general_api.py index dbd3060..1ee7e2e 100644 --- a/openapi_client/api/general_api.py +++ b/openapi_client/api/general_api.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/api/japanese_api.py b/openapi_client/api/japanese_api.py index 5da6b1d..275fc82 100644 --- a/openapi_client/api/japanese_api.py +++ b/openapi_client/api/japanese_api.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -426,7 +426,7 @@ def japanese_name_gender_kanji_candidates_batch(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :param BatchFirstLastNameIn batch_first_last_name_in: A list of personal japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname and known gender + :param BatchFirstLastNameGenderIn batch_first_last_name_gender_in: A list of personal japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname and known gender :return: BatchNameMatchCandidatesOut If the method is called asynchronously, returns the request thread. @@ -447,7 +447,7 @@ def japanese_name_gender_kanji_candidates_batch_with_http_info(self, **kwargs): >>> result = thread.get() :param async_req bool - :param BatchFirstLastNameIn batch_first_last_name_in: A list of personal japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname and known gender + :param BatchFirstLastNameGenderIn batch_first_last_name_gender_in: A list of personal japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname and known gender :return: BatchNameMatchCandidatesOut If the method is called asynchronously, returns the request thread. @@ -455,7 +455,7 @@ def japanese_name_gender_kanji_candidates_batch_with_http_info(self, **kwargs): local_var_params = locals() - all_params = ['batch_first_last_name_in'] # noqa: E501 + all_params = ['batch_first_last_name_gender_in'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -482,8 +482,8 @@ def japanese_name_gender_kanji_candidates_batch_with_http_info(self, **kwargs): local_var_files = {} body_params = None - if 'batch_first_last_name_in' in local_var_params: - body_params = local_var_params['batch_first_last_name_in'] + if 'batch_first_last_name_gender_in' in local_var_params: + body_params = local_var_params['batch_first_last_name_gender_in'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 @@ -523,7 +523,7 @@ def japanese_name_kanji_candidates(self, japanese_surname_latin, japanese_given_ :param str japanese_surname_latin: (required) :param str japanese_given_name_latin: (required) :param str known_gender: (required) - :return: RomanizedNameOut + :return: NameMatchCandidatesOut If the method is called asynchronously, returns the request thread. """ @@ -546,7 +546,7 @@ def japanese_name_kanji_candidates_with_http_info(self, japanese_surname_latin, :param str japanese_surname_latin: (required) :param str japanese_given_name_latin: (required) :param str known_gender: (required) - :return: RomanizedNameOut + :return: NameMatchCandidatesOut If the method is called asynchronously, returns the request thread. """ @@ -613,7 +613,7 @@ def japanese_name_kanji_candidates_with_http_info(self, japanese_surname_latin, body=body_params, post_params=form_params, files=local_var_files, - response_type='RomanizedNameOut', # noqa: E501 + response_type='NameMatchCandidatesOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -632,7 +632,7 @@ def japanese_name_kanji_candidates1(self, japanese_surname_latin, japanese_given :param async_req bool :param str japanese_surname_latin: (required) :param str japanese_given_name_latin: (required) - :return: RomanizedNameOut + :return: NameMatchCandidatesOut If the method is called asynchronously, returns the request thread. """ @@ -654,7 +654,7 @@ def japanese_name_kanji_candidates1_with_http_info(self, japanese_surname_latin, :param async_req bool :param str japanese_surname_latin: (required) :param str japanese_given_name_latin: (required) - :return: RomanizedNameOut + :return: NameMatchCandidatesOut If the method is called asynchronously, returns the request thread. """ @@ -715,7 +715,7 @@ def japanese_name_kanji_candidates1_with_http_info(self, japanese_surname_latin, body=body_params, post_params=form_params, files=local_var_files, - response_type='RomanizedNameOut', # noqa: E501 + response_type='NameMatchCandidatesOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -828,7 +828,7 @@ def japanese_name_latin_candidates(self, japanese_surname_kanji, japanese_given_ :param async_req bool :param str japanese_surname_kanji: (required) :param str japanese_given_name_kanji: (required) - :return: RomanizedNameOut + :return: NameMatchCandidatesOut If the method is called asynchronously, returns the request thread. """ @@ -850,7 +850,7 @@ def japanese_name_latin_candidates_with_http_info(self, japanese_surname_kanji, :param async_req bool :param str japanese_surname_kanji: (required) :param str japanese_given_name_kanji: (required) - :return: RomanizedNameOut + :return: NameMatchCandidatesOut If the method is called asynchronously, returns the request thread. """ @@ -911,7 +911,7 @@ def japanese_name_latin_candidates_with_http_info(self, japanese_surname_kanji, body=body_params, post_params=form_params, files=local_var_files, - response_type='RomanizedNameOut', # noqa: E501 + response_type='NameMatchCandidatesOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -1025,7 +1025,7 @@ def japanese_name_match(self, japanese_surname_latin, japanese_given_name_latin, :param str japanese_surname_latin: (required) :param str japanese_given_name_latin: (required) :param str japanese_name: (required) - :return: RomanizedNameOut + :return: NameMatchedOut If the method is called asynchronously, returns the request thread. """ @@ -1048,7 +1048,7 @@ def japanese_name_match_with_http_info(self, japanese_surname_latin, japanese_gi :param str japanese_surname_latin: (required) :param str japanese_given_name_latin: (required) :param str japanese_name: (required) - :return: RomanizedNameOut + :return: NameMatchedOut If the method is called asynchronously, returns the request thread. """ @@ -1115,7 +1115,7 @@ def japanese_name_match_with_http_info(self, japanese_surname_latin, japanese_gi body=body_params, post_params=form_params, files=local_var_files, - response_type='RomanizedNameOut', # noqa: E501 + response_type='NameMatchedOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -1132,8 +1132,8 @@ def japanese_name_match_batch(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :param BatchFirstLastNameIn batch_first_last_name_in: A list of personal Japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname - :return: BatchNameMatchCandidatesOut + :param BatchMatchPersonalFirstLastNameIn batch_match_personal_first_last_name_in: A list of personal Japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname + :return: BatchNameMatchedOut If the method is called asynchronously, returns the request thread. """ @@ -1153,15 +1153,15 @@ def japanese_name_match_batch_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :param BatchFirstLastNameIn batch_first_last_name_in: A list of personal Japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname - :return: BatchNameMatchCandidatesOut + :param BatchMatchPersonalFirstLastNameIn batch_match_personal_first_last_name_in: A list of personal Japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname + :return: BatchNameMatchedOut If the method is called asynchronously, returns the request thread. """ local_var_params = locals() - all_params = ['batch_first_last_name_in'] # noqa: E501 + all_params = ['batch_match_personal_first_last_name_in'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1188,8 +1188,8 @@ def japanese_name_match_batch_with_http_info(self, **kwargs): # noqa: E501 local_var_files = {} body_params = None - if 'batch_first_last_name_in' in local_var_params: - body_params = local_var_params['batch_first_last_name_in'] + if 'batch_match_personal_first_last_name_in' in local_var_params: + body_params = local_var_params['batch_match_personal_first_last_name_in'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 @@ -1209,7 +1209,7 @@ def japanese_name_match_batch_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='BatchNameMatchCandidatesOut', # noqa: E501 + response_type='BatchNameMatchedOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -1229,7 +1229,7 @@ def japanese_name_match_feedback_loop(self, japanese_surname_latin, japanese_giv :param str japanese_surname_latin: (required) :param str japanese_given_name_latin: (required) :param str japanese_name: (required) - :return: RomanizedNameOut + :return: FeedbackLoopOut If the method is called asynchronously, returns the request thread. """ @@ -1252,7 +1252,7 @@ def japanese_name_match_feedback_loop_with_http_info(self, japanese_surname_lati :param str japanese_surname_latin: (required) :param str japanese_given_name_latin: (required) :param str japanese_name: (required) - :return: RomanizedNameOut + :return: FeedbackLoopOut If the method is called asynchronously, returns the request thread. """ @@ -1319,7 +1319,7 @@ def japanese_name_match_feedback_loop_with_http_info(self, japanese_surname_lati body=body_params, post_params=form_params, files=local_var_files, - response_type='RomanizedNameOut', # noqa: E501 + response_type='FeedbackLoopOut', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 diff --git a/openapi_client/api/personal_api.py b/openapi_client/api/personal_api.py index 2182461..cbdf825 100644 --- a/openapi_client/api/personal_api.py +++ b/openapi_client/api/personal_api.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -2017,196 +2017,8 @@ def parse_name_geo_batch_with_http_info(self, **kwargs): # noqa: E501 _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) - def parsed_gender_batch(self, **kwargs): # noqa: E501 - """Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.parsed_gender_batch(async_req=True) - >>> result = thread.get() - - :param async_req bool - :param BatchParsedFullNameIn batch_parsed_full_name_in: A list of personal names - :return: BatchFirstLastNameGenderedOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.parsed_gender_batch_with_http_info(**kwargs) # noqa: E501 - else: - (data) = self.parsed_gender_batch_with_http_info(**kwargs) # noqa: E501 - return data - - def parsed_gender_batch_with_http_info(self, **kwargs): # noqa: E501 - """Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.parsed_gender_batch_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool - :param BatchParsedFullNameIn batch_parsed_full_name_in: A list of personal names - :return: BatchFirstLastNameGenderedOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['batch_parsed_full_name_in'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method parsed_gender_batch" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'batch_parsed_full_name_in' in local_var_params: - body_params = local_var_params['batch_parsed_full_name_in'] - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/parsedGenderBatch', 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='BatchFirstLastNameGenderedOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def parsed_gender_geo_batch(self, **kwargs): # noqa: E501 - """Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.parsed_gender_geo_batch(async_req=True) - >>> result = thread.get() - - :param async_req bool - :param BatchParsedFullNameGeoIn batch_parsed_full_name_geo_in: A list of personal names - :return: BatchFirstLastNameGenderedOut - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.parsed_gender_geo_batch_with_http_info(**kwargs) # noqa: E501 - else: - (data) = self.parsed_gender_geo_batch_with_http_info(**kwargs) # noqa: E501 - return data - - def parsed_gender_geo_batch_with_http_info(self, **kwargs): # noqa: E501 - """Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.parsed_gender_geo_batch_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool - :param BatchParsedFullNameGeoIn batch_parsed_full_name_geo_in: A list of personal names - :return: BatchFirstLastNameGenderedOut - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = ['batch_parsed_full_name_geo_in'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method parsed_gender_geo_batch" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'batch_parsed_full_name_geo_in' in local_var_params: - body_params = local_var_params['batch_parsed_full_name_geo_in'] - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['api_key'] # noqa: E501 - - return self.api_client.call_api( - '/api2/json/parsedGenderGeoBatch', 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='BatchFirstLastNameGenderedOut', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - def us_race_ethnicity(self, first_name, last_name, **kwargs): # noqa: E501 - """[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). # noqa: E501 + """[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). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2228,7 +2040,7 @@ def us_race_ethnicity(self, first_name, last_name, **kwargs): # noqa: E501 return data def us_race_ethnicity_with_http_info(self, first_name, last_name, **kwargs): # noqa: E501 - """[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). # noqa: E501 + """[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). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2308,7 +2120,7 @@ def us_race_ethnicity_with_http_info(self, first_name, last_name, **kwargs): # collection_formats=collection_formats) def us_race_ethnicity_batch(self, **kwargs): # noqa: E501 - """[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. # noqa: E501 + """[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). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2329,7 +2141,7 @@ def us_race_ethnicity_batch(self, **kwargs): # noqa: E501 return data def us_race_ethnicity_batch_with_http_info(self, **kwargs): # noqa: E501 - """[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. # noqa: E501 + """[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). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2402,7 +2214,7 @@ def us_race_ethnicity_batch_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def us_race_ethnicity_zip5(self, first_name, last_name, zip5_code, **kwargs): # noqa: E501 - """[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). # noqa: E501 + """[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). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2425,7 +2237,7 @@ def us_race_ethnicity_zip5(self, first_name, last_name, zip5_code, **kwargs): # return data def us_race_ethnicity_zip5_with_http_info(self, first_name, last_name, zip5_code, **kwargs): # noqa: E501 - """[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). # noqa: E501 + """[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). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2512,7 +2324,7 @@ def us_race_ethnicity_zip5_with_http_info(self, first_name, last_name, zip5_code collection_formats=collection_formats) def us_zip_race_ethnicity_batch(self, **kwargs): # noqa: E501 - """[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. # noqa: E501 + """[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. 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). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2533,7 +2345,7 @@ def us_zip_race_ethnicity_batch(self, **kwargs): # noqa: E501 return data def us_zip_race_ethnicity_batch_with_http_info(self, **kwargs): # noqa: E501 - """[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. # noqa: E501 + """[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. 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). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/openapi_client/api/social_api.py b/openapi_client/api/social_api.py index 966c375..f50a617 100644 --- a/openapi_client/api/social_api.py +++ b/openapi_client/api/social_api.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/api_client.py b/openapi_client/api_client.py index 1cd4d40..618cb76 100644 --- a/openapi_client/api_client.py +++ b/openapi_client/api_client.py @@ -2,9 +2,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/2.0.13/python' + self.user_agent = 'OpenAPI-Generator/2.0.15/python' def __del__(self): if self._pool: diff --git a/openapi_client/configuration.py b/openapi_client/configuration.py index 7d92ca5..c3e7935 100644 --- a/openapi_client/configuration.py +++ b/openapi_client/configuration.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -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.13\n"\ - "SDK Package Version: 2.0.13".\ + "Version of the API: 2.0.15\n"\ + "SDK Package Version: 2.0.15".\ format(env=sys.platform, pyversion=sys.version) diff --git a/openapi_client/models/__init__.py b/openapi_client/models/__init__.py index 34ce0d1..fd168bc 100644 --- a/openapi_client/models/__init__.py +++ b/openapi_client/models/__init__.py @@ -4,9 +4,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -22,12 +22,11 @@ from openapi_client.models.api_counter_v2_out import APICounterV2Out from openapi_client.models.api_key_out import APIKeyOut from openapi_client.models.api_period_usage_out import APIPeriodUsageOut -from openapi_client.models.api_plan_out import APIPlanOut from openapi_client.models.api_plan_subscription_out import APIPlanSubscriptionOut -from openapi_client.models.api_plans_out import APIPlansOut from openapi_client.models.api_service_out import APIServiceOut from openapi_client.models.api_services_out import APIServicesOut from openapi_client.models.api_usage_aggregated_out import APIUsageAggregatedOut +from openapi_client.models.api_usage_history_out import APIUsageHistoryOut from openapi_client.models.batch_corridor_in import BatchCorridorIn from openapi_client.models.batch_corridor_out import BatchCorridorOut from openapi_client.models.batch_first_last_name_diasporaed_out import BatchFirstLastNameDiasporaedOut @@ -46,22 +45,14 @@ from openapi_client.models.batch_name_in import BatchNameIn from openapi_client.models.batch_name_match_candidates_out import BatchNameMatchCandidatesOut from openapi_client.models.batch_name_matched_out import BatchNameMatchedOut -from openapi_client.models.batch_parsed_full_name_geo_in import BatchParsedFullNameGeoIn -from openapi_client.models.batch_parsed_full_name_in import BatchParsedFullNameIn from openapi_client.models.batch_personal_name_gendered_out import BatchPersonalNameGenderedOut from openapi_client.models.batch_personal_name_geo_in import BatchPersonalNameGeoIn from openapi_client.models.batch_personal_name_geo_out import BatchPersonalNameGeoOut from openapi_client.models.batch_personal_name_in import BatchPersonalNameIn from openapi_client.models.batch_personal_name_parsed_out import BatchPersonalNameParsedOut from openapi_client.models.batch_proper_noun_categorized_out import BatchProperNounCategorizedOut -from openapi_client.models.billing_history_out import BillingHistoryOut -from openapi_client.models.billing_info_in_out import BillingInfoInOut -from openapi_client.models.cache_metrics_out import CacheMetricsOut -from openapi_client.models.classifier_metrics_out import ClassifierMetricsOut from openapi_client.models.corridor_in import CorridorIn from openapi_client.models.corridor_out import CorridorOut -from openapi_client.models.currencies_out import CurrenciesOut -from openapi_client.models.expected_class_metrics_out import ExpectedClassMetricsOut from openapi_client.models.feedback_loop_out import FeedbackLoopOut from openapi_client.models.first_last_name_diasporaed_out import FirstLastNameDiasporaedOut from openapi_client.models.first_last_name_gender_in import FirstLastNameGenderIn @@ -75,29 +66,16 @@ from openapi_client.models.first_last_name_phone_number_geo_in import FirstLastNamePhoneNumberGeoIn from openapi_client.models.first_last_name_phone_number_in import FirstLastNamePhoneNumberIn from openapi_client.models.first_last_name_us_race_ethnicity_out import FirstLastNameUSRaceEthnicityOut -from openapi_client.models.inline_object import InlineObject -from openapi_client.models.invoice_item_out import InvoiceItemOut -from openapi_client.models.invoice_out import InvoiceOut from openapi_client.models.match_personal_first_last_name_in import MatchPersonalFirstLastNameIn -from openapi_client.models.nam_sor_counter_out import NamSorCounterOut from openapi_client.models.name_geo_in import NameGeoIn from openapi_client.models.name_in import NameIn from openapi_client.models.name_match_candidate_out import NameMatchCandidateOut from openapi_client.models.name_match_candidates_out import NameMatchCandidatesOut from openapi_client.models.name_matched_out import NameMatchedOut -from openapi_client.models.parsed_full_name_geo_in import ParsedFullNameGeoIn -from openapi_client.models.parsed_full_name_in import ParsedFullNameIn from openapi_client.models.personal_name_gendered_out import PersonalNameGenderedOut from openapi_client.models.personal_name_geo_in import PersonalNameGeoIn from openapi_client.models.personal_name_geo_out import PersonalNameGeoOut from openapi_client.models.personal_name_in import PersonalNameIn from openapi_client.models.personal_name_parsed_out import PersonalNameParsedOut from openapi_client.models.proper_noun_categorized_out import ProperNounCategorizedOut -from openapi_client.models.romanized_name_out import RomanizedNameOut from openapi_client.models.software_version_out import SoftwareVersionOut -from openapi_client.models.source_detailed_metrics_out import SourceDetailedMetricsOut -from openapi_client.models.source_metrics_out import SourceMetricsOut -from openapi_client.models.stripe_card_out import StripeCardOut -from openapi_client.models.stripe_customer_out import StripeCustomerOut -from openapi_client.models.system_metrics_out import SystemMetricsOut -from openapi_client.models.user_info_out import UserInfoOut diff --git a/openapi_client/models/api_billing_period_usage_out.py b/openapi_client/models/api_billing_period_usage_out.py index 14b7a6b..3cc1e06 100644 --- a/openapi_client/models/api_billing_period_usage_out.py +++ b/openapi_client/models/api_billing_period_usage_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -97,6 +97,7 @@ def __init__(self, api_key=None, subscription_started=None, period_started=None, def api_key(self): """Gets the api_key of this APIBillingPeriodUsageOut. # noqa: E501 + User API Key. # noqa: E501 :return: The api_key of this APIBillingPeriodUsageOut. # noqa: E501 :rtype: str @@ -107,6 +108,7 @@ def api_key(self): def api_key(self, api_key): """Sets the api_key of this APIBillingPeriodUsageOut. + User API Key. # noqa: E501 :param api_key: The api_key of this APIBillingPeriodUsageOut. # noqa: E501 :type: str @@ -118,6 +120,7 @@ def api_key(self, api_key): def subscription_started(self): """Gets the subscription_started of this APIBillingPeriodUsageOut. # noqa: E501 + Datetime when the user subscribed to the plan. # noqa: E501 :return: The subscription_started of this APIBillingPeriodUsageOut. # noqa: E501 :rtype: int @@ -128,6 +131,7 @@ def subscription_started(self): def subscription_started(self, subscription_started): """Sets the subscription_started of this APIBillingPeriodUsageOut. + Datetime when the user subscribed to the plan. # noqa: E501 :param subscription_started: The subscription_started of this APIBillingPeriodUsageOut. # noqa: E501 :type: int @@ -139,6 +143,7 @@ def subscription_started(self, subscription_started): def period_started(self): """Gets the period_started of this APIBillingPeriodUsageOut. # noqa: E501 + Datetime when the the plan's current period started. # noqa: E501 :return: The period_started of this APIBillingPeriodUsageOut. # noqa: E501 :rtype: int @@ -149,6 +154,7 @@ def period_started(self): def period_started(self, period_started): """Sets the period_started of this APIBillingPeriodUsageOut. + Datetime when the the plan's current period started. # noqa: E501 :param period_started: The period_started of this APIBillingPeriodUsageOut. # noqa: E501 :type: int @@ -160,6 +166,7 @@ def period_started(self, period_started): def period_ended(self): """Gets the period_ended of this APIBillingPeriodUsageOut. # noqa: E501 + Datetime when the the plan's current period endend. # noqa: E501 :return: The period_ended of this APIBillingPeriodUsageOut. # noqa: E501 :rtype: int @@ -170,6 +177,7 @@ def period_ended(self): def period_ended(self, period_ended): """Sets the period_ended of this APIBillingPeriodUsageOut. + Datetime when the the plan's current period endend. # noqa: E501 :param period_ended: The period_ended of this APIBillingPeriodUsageOut. # noqa: E501 :type: int @@ -181,6 +189,7 @@ def period_ended(self, period_ended): def stripe_current_period_end(self): """Gets the stripe_current_period_end of this APIBillingPeriodUsageOut. # noqa: E501 + Datetime when the the plan's current period endend (in Stripe). Internal and Stripe periodicity should ~coincide. # noqa: E501 :return: The stripe_current_period_end of this APIBillingPeriodUsageOut. # noqa: E501 :rtype: int @@ -191,6 +200,7 @@ def stripe_current_period_end(self): def stripe_current_period_end(self, stripe_current_period_end): """Sets the stripe_current_period_end of this APIBillingPeriodUsageOut. + Datetime when the the plan's current period endend (in Stripe). Internal and Stripe periodicity should ~coincide. # noqa: E501 :param stripe_current_period_end: The stripe_current_period_end of this APIBillingPeriodUsageOut. # noqa: E501 :type: int @@ -202,6 +212,7 @@ def stripe_current_period_end(self, stripe_current_period_end): def stripe_current_period_start(self): """Gets the stripe_current_period_start of this APIBillingPeriodUsageOut. # noqa: E501 + Datetime when the the plan's current period started (in Stripe). Internal and Stripe periodicity should ~coincide. # noqa: E501 :return: The stripe_current_period_start of this APIBillingPeriodUsageOut. # noqa: E501 :rtype: int @@ -212,6 +223,7 @@ def stripe_current_period_start(self): def stripe_current_period_start(self, stripe_current_period_start): """Sets the stripe_current_period_start of this APIBillingPeriodUsageOut. + Datetime when the the plan's current period started (in Stripe). Internal and Stripe periodicity should ~coincide. # noqa: E501 :param stripe_current_period_start: The stripe_current_period_start of this APIBillingPeriodUsageOut. # noqa: E501 :type: int @@ -223,6 +235,7 @@ def stripe_current_period_start(self, stripe_current_period_start): def billing_status(self): """Gets the billing_status of this APIBillingPeriodUsageOut. # noqa: E501 + Current period billing status ex OPEN. # noqa: E501 :return: The billing_status of this APIBillingPeriodUsageOut. # noqa: E501 :rtype: str @@ -233,6 +246,7 @@ def billing_status(self): def billing_status(self, billing_status): """Sets the billing_status of this APIBillingPeriodUsageOut. + Current period billing status ex OPEN. # noqa: E501 :param billing_status: The billing_status of this APIBillingPeriodUsageOut. # noqa: E501 :type: str @@ -244,6 +258,7 @@ def billing_status(self, billing_status): def usage(self): """Gets the usage of this APIBillingPeriodUsageOut. # noqa: E501 + Current period usage in units (NB some API endpoints use more than one unit). # noqa: E501 :return: The usage of this APIBillingPeriodUsageOut. # noqa: E501 :rtype: int @@ -254,6 +269,7 @@ def usage(self): def usage(self, usage): """Sets the usage of this APIBillingPeriodUsageOut. + Current period usage in units (NB some API endpoints use more than one unit). # noqa: E501 :param usage: The usage of this APIBillingPeriodUsageOut. # noqa: E501 :type: int @@ -265,6 +281,7 @@ def usage(self, usage): def soft_limit(self): """Gets the soft_limit of this APIBillingPeriodUsageOut. # noqa: E501 + Current period soft limit (reaching the limit sends an email notification). # noqa: E501 :return: The soft_limit of this APIBillingPeriodUsageOut. # noqa: E501 :rtype: int @@ -275,6 +292,7 @@ def soft_limit(self): def soft_limit(self, soft_limit): """Sets the soft_limit of this APIBillingPeriodUsageOut. + Current period soft limit (reaching the limit sends an email notification). # noqa: E501 :param soft_limit: The soft_limit of this APIBillingPeriodUsageOut. # noqa: E501 :type: int @@ -286,6 +304,7 @@ def soft_limit(self, soft_limit): def hard_limit(self): """Gets the hard_limit of this APIBillingPeriodUsageOut. # noqa: E501 + Current period hard limit (reaching the limit sends an email notification and blocks the API Key). # noqa: E501 :return: The hard_limit of this APIBillingPeriodUsageOut. # noqa: E501 :rtype: int @@ -296,6 +315,7 @@ def hard_limit(self): def hard_limit(self, hard_limit): """Sets the hard_limit of this APIBillingPeriodUsageOut. + Current period hard limit (reaching the limit sends an email notification and blocks the API Key). # noqa: E501 :param hard_limit: The hard_limit of this APIBillingPeriodUsageOut. # noqa: E501 :type: int diff --git a/openapi_client/models/api_classifier_out.py b/openapi_client/models/api_classifier_out.py index 6affae2..9bf9d79 100644 --- a/openapi_client/models/api_classifier_out.py +++ b/openapi_client/models/api_classifier_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -72,6 +72,7 @@ def __init__(self, classifier_name=None, serving=None, learning=None, shutting_d def classifier_name(self): """Gets the classifier_name of this APIClassifierOut. # noqa: E501 + The classifier name # noqa: E501 :return: The classifier_name of this APIClassifierOut. # noqa: E501 :rtype: str @@ -82,6 +83,7 @@ def classifier_name(self): def classifier_name(self, classifier_name): """Sets the classifier_name of this APIClassifierOut. + The classifier name # noqa: E501 :param classifier_name: The classifier_name of this APIClassifierOut. # noqa: E501 :type: str @@ -93,6 +95,7 @@ def classifier_name(self, classifier_name): def serving(self): """Gets the serving of this APIClassifierOut. # noqa: E501 + True if the classifier is serving requests (has reached minimal learning, is not shutting down) # noqa: E501 :return: The serving of this APIClassifierOut. # noqa: E501 :rtype: bool @@ -103,6 +106,7 @@ def serving(self): def serving(self, serving): """Sets the serving of this APIClassifierOut. + True if the classifier is serving requests (has reached minimal learning, is not shutting down) # noqa: E501 :param serving: The serving of this APIClassifierOut. # noqa: E501 :type: bool @@ -114,6 +118,7 @@ def serving(self, serving): def learning(self): """Gets the learning of this APIClassifierOut. # noqa: E501 + True if the classifier is learning # noqa: E501 :return: The learning of this APIClassifierOut. # noqa: E501 :rtype: bool @@ -124,6 +129,7 @@ def learning(self): def learning(self, learning): """Sets the learning of this APIClassifierOut. + True if the classifier is learning # noqa: E501 :param learning: The learning of this APIClassifierOut. # noqa: E501 :type: bool @@ -135,6 +141,7 @@ def learning(self, learning): def shutting_down(self): """Gets the shutting_down of this APIClassifierOut. # noqa: E501 + True if the classifier is shutting down # noqa: E501 :return: The shutting_down of this APIClassifierOut. # noqa: E501 :rtype: bool @@ -145,6 +152,7 @@ def shutting_down(self): def shutting_down(self, shutting_down): """Sets the shutting_down of this APIClassifierOut. + True if the classifier is shutting down # noqa: E501 :param shutting_down: The shutting_down of this APIClassifierOut. # noqa: E501 :type: bool @@ -156,6 +164,7 @@ def shutting_down(self, shutting_down): def probability_calibrated(self): """Gets the probability_calibrated of this APIClassifierOut. # noqa: E501 + True if the classifier has finished the initial learning and calibrated probabilities (meanwhile, during initial learning, probabilities will be equal to -1) # noqa: E501 :return: The probability_calibrated of this APIClassifierOut. # noqa: E501 :rtype: bool @@ -166,6 +175,7 @@ def probability_calibrated(self): def probability_calibrated(self, probability_calibrated): """Sets the probability_calibrated of this APIClassifierOut. + True if the classifier has finished the initial learning and calibrated probabilities (meanwhile, during initial learning, probabilities will be equal to -1) # noqa: E501 :param probability_calibrated: The probability_calibrated of this APIClassifierOut. # noqa: E501 :type: bool diff --git a/openapi_client/models/api_classifier_taxonomy_out.py b/openapi_client/models/api_classifier_taxonomy_out.py index fa48b31..7c44e18 100644 --- a/openapi_client/models/api_classifier_taxonomy_out.py +++ b/openapi_client/models/api_classifier_taxonomy_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -57,6 +57,7 @@ def __init__(self, classifier_name=None, taxonomy_classes=None): # noqa: E501 def classifier_name(self): """Gets the classifier_name of this APIClassifierTaxonomyOut. # noqa: E501 + Name of the classifier as per apiStatus (corresponds also to the name of the service in apiServices) # noqa: E501 :return: The classifier_name of this APIClassifierTaxonomyOut. # noqa: E501 :rtype: str @@ -67,6 +68,7 @@ def classifier_name(self): def classifier_name(self, classifier_name): """Sets the classifier_name of this APIClassifierTaxonomyOut. + Name of the classifier as per apiStatus (corresponds also to the name of the service in apiServices) # noqa: E501 :param classifier_name: The classifier_name of this APIClassifierTaxonomyOut. # noqa: E501 :type: str @@ -78,6 +80,7 @@ def classifier_name(self, classifier_name): def taxonomy_classes(self): """Gets the taxonomy_classes of this APIClassifierTaxonomyOut. # noqa: E501 + The taxonomy classes this classifier classifies to # noqa: E501 :return: The taxonomy_classes of this APIClassifierTaxonomyOut. # noqa: E501 :rtype: list[str] @@ -88,6 +91,7 @@ def taxonomy_classes(self): def taxonomy_classes(self, taxonomy_classes): """Sets the taxonomy_classes of this APIClassifierTaxonomyOut. + The taxonomy classes this classifier classifies to # noqa: E501 :param taxonomy_classes: The taxonomy_classes of this APIClassifierTaxonomyOut. # noqa: E501 :type: list[str] diff --git a/openapi_client/models/api_classifiers_status_out.py b/openapi_client/models/api_classifiers_status_out.py index 891c0a6..0051b61 100644 --- a/openapi_client/models/api_classifiers_status_out.py +++ b/openapi_client/models/api_classifiers_status_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -78,6 +78,7 @@ def software_version(self, software_version): def classifiers(self): """Gets the classifiers of this APIClassifiersStatusOut. # noqa: E501 + The list of classifiers and versions. # noqa: E501 :return: The classifiers of this APIClassifiersStatusOut. # noqa: E501 :rtype: list[APIClassifierOut] @@ -88,6 +89,7 @@ def classifiers(self): def classifiers(self, classifiers): """Sets the classifiers of this APIClassifiersStatusOut. + The list of classifiers and versions. # noqa: E501 :param classifiers: The classifiers of this APIClassifiersStatusOut. # noqa: E501 :type: list[APIClassifierOut] diff --git a/openapi_client/models/api_counter_v2_out.py b/openapi_client/models/api_counter_v2_out.py index 560b7d0..c254fc5 100644 --- a/openapi_client/models/api_counter_v2_out.py +++ b/openapi_client/models/api_counter_v2_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -103,6 +103,7 @@ def api_key(self, api_key): def api_service(self): """Gets the api_service of this APICounterV2Out. # noqa: E501 + The apiService corresponds to the classifier name. # noqa: E501 :return: The api_service of this APICounterV2Out. # noqa: E501 :rtype: str @@ -113,6 +114,7 @@ def api_service(self): def api_service(self, api_service): """Sets the api_service of this APICounterV2Out. + The apiService corresponds to the classifier name. # noqa: E501 :param api_service: The api_service of this APICounterV2Out. # noqa: E501 :type: str @@ -124,6 +126,7 @@ def api_service(self, api_service): def created_date_time(self): """Gets the created_date_time of this APICounterV2Out. # noqa: E501 + The create datetime of the counter. # noqa: E501 :return: The created_date_time of this APICounterV2Out. # noqa: E501 :rtype: int @@ -134,6 +137,7 @@ def created_date_time(self): def created_date_time(self, created_date_time): """Sets the created_date_time of this APICounterV2Out. + The create datetime of the counter. # noqa: E501 :param created_date_time: The created_date_time of this APICounterV2Out. # noqa: E501 :type: int @@ -145,6 +149,7 @@ def created_date_time(self, created_date_time): def total_usage(self): """Gets the total_usage of this APICounterV2Out. # noqa: E501 + The usage of the counter. # noqa: E501 :return: The total_usage of this APICounterV2Out. # noqa: E501 :rtype: int @@ -155,6 +160,7 @@ def total_usage(self): def total_usage(self, total_usage): """Sets the total_usage of this APICounterV2Out. + The usage of the counter. # noqa: E501 :param total_usage: The total_usage of this APICounterV2Out. # noqa: E501 :type: int @@ -166,6 +172,7 @@ def total_usage(self, total_usage): def last_flushed_date_time(self): """Gets the last_flushed_date_time of this APICounterV2Out. # noqa: E501 + The flush datetime of the counter. # noqa: E501 :return: The last_flushed_date_time of this APICounterV2Out. # noqa: E501 :rtype: int @@ -176,6 +183,7 @@ def last_flushed_date_time(self): def last_flushed_date_time(self, last_flushed_date_time): """Sets the last_flushed_date_time of this APICounterV2Out. + The flush datetime of the counter. # noqa: E501 :param last_flushed_date_time: The last_flushed_date_time of this APICounterV2Out. # noqa: E501 :type: int @@ -187,6 +195,7 @@ def last_flushed_date_time(self, last_flushed_date_time): def last_used_date_time(self): """Gets the last_used_date_time of this APICounterV2Out. # noqa: E501 + The last usage datetime of the counter. # noqa: E501 :return: The last_used_date_time of this APICounterV2Out. # noqa: E501 :rtype: int @@ -197,6 +206,7 @@ def last_used_date_time(self): def last_used_date_time(self, last_used_date_time): """Sets the last_used_date_time of this APICounterV2Out. + The last usage datetime of the counter. # noqa: E501 :param last_used_date_time: The last_used_date_time of this APICounterV2Out. # noqa: E501 :type: int @@ -208,6 +218,7 @@ def last_used_date_time(self, last_used_date_time): def service_features_usage(self): """Gets the service_features_usage of this APICounterV2Out. # noqa: E501 + Usage of special features, such as Chinese, Japanese. # noqa: E501 :return: The service_features_usage of this APICounterV2Out. # noqa: E501 :rtype: dict(str, int) @@ -218,6 +229,7 @@ def service_features_usage(self): def service_features_usage(self, service_features_usage): """Sets the service_features_usage of this APICounterV2Out. + Usage of special features, such as Chinese, Japanese. # noqa: E501 :param service_features_usage: The service_features_usage of this APICounterV2Out. # noqa: E501 :type: dict(str, int) diff --git a/openapi_client/models/api_key_out.py b/openapi_client/models/api_key_out.py index d3a89c8..bdce05e 100644 --- a/openapi_client/models/api_key_out.py +++ b/openapi_client/models/api_key_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -97,6 +97,7 @@ def __init__(self, api_key=None, user_id=None, admin=None, vetted=None, learnabl def api_key(self): """Gets the api_key of this APIKeyOut. # noqa: E501 + The user API Key. # noqa: E501 :return: The api_key of this APIKeyOut. # noqa: E501 :rtype: str @@ -107,6 +108,7 @@ def api_key(self): def api_key(self, api_key): """Sets the api_key of this APIKeyOut. + The user API Key. # noqa: E501 :param api_key: The api_key of this APIKeyOut. # noqa: E501 :type: str @@ -118,6 +120,7 @@ def api_key(self, api_key): def user_id(self): """Gets the user_id of this APIKeyOut. # noqa: E501 + The user identifier. # noqa: E501 :return: The user_id of this APIKeyOut. # noqa: E501 :rtype: str @@ -128,6 +131,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this APIKeyOut. + The user identifier. # noqa: E501 :param user_id: The user_id of this APIKeyOut. # noqa: E501 :type: str @@ -139,6 +143,7 @@ def user_id(self, user_id): def admin(self): """Gets the admin of this APIKeyOut. # noqa: E501 + The API Key has admin role. # noqa: E501 :return: The admin of this APIKeyOut. # noqa: E501 :rtype: bool @@ -149,6 +154,7 @@ def admin(self): def admin(self, admin): """Sets the admin of this APIKeyOut. + The API Key has admin role. # noqa: E501 :param admin: The admin of this APIKeyOut. # noqa: E501 :type: bool @@ -160,6 +166,7 @@ def admin(self, admin): def vetted(self): """Gets the vetted of this APIKeyOut. # noqa: E501 + The API Key is vetted (assumed truthful) for machine learning. # noqa: E501 :return: The vetted of this APIKeyOut. # noqa: E501 :rtype: bool @@ -170,6 +177,7 @@ def vetted(self): def vetted(self, vetted): """Sets the vetted of this APIKeyOut. + The API Key is vetted (assumed truthful) for machine learning. # noqa: E501 :param vetted: The vetted of this APIKeyOut. # noqa: E501 :type: bool @@ -181,6 +189,7 @@ def vetted(self, vetted): def learnable(self): """Gets the learnable of this APIKeyOut. # noqa: E501 + The API Key is learnable (without assuming truthfulness) for machine learning. Set learnable=false and anonymized=true for highest privacy (ie. to forget data as it's processed). # noqa: E501 :return: The learnable of this APIKeyOut. # noqa: E501 :rtype: bool @@ -191,6 +200,7 @@ def learnable(self): def learnable(self, learnable): """Sets the learnable of this APIKeyOut. + The API Key is learnable (without assuming truthfulness) for machine learning. Set learnable=false and anonymized=true for highest privacy (ie. to forget data as it's processed). # noqa: E501 :param learnable: The learnable of this APIKeyOut. # noqa: E501 :type: bool @@ -202,6 +212,7 @@ def learnable(self, learnable): def anonymized(self): """Gets the anonymized of this APIKeyOut. # noqa: E501 + The API Key is anonymized (using SHA-252 digest for logging). Set learnable=false and anonymized=true for highest privacy (ie. to forget data as it's processed). # noqa: E501 :return: The anonymized of this APIKeyOut. # noqa: E501 :rtype: bool @@ -212,6 +223,7 @@ def anonymized(self): def anonymized(self, anonymized): """Sets the anonymized of this APIKeyOut. + The API Key is anonymized (using SHA-252 digest for logging). Set learnable=false and anonymized=true for highest privacy (ie. to forget data as it's processed). # noqa: E501 :param anonymized: The anonymized of this APIKeyOut. # noqa: E501 :type: bool @@ -223,6 +235,7 @@ def anonymized(self, anonymized): def partner(self): """Gets the partner of this APIKeyOut. # noqa: E501 + The API Key has partner role. # noqa: E501 :return: The partner of this APIKeyOut. # noqa: E501 :rtype: bool @@ -233,6 +246,7 @@ def partner(self): def partner(self, partner): """Sets the partner of this APIKeyOut. + The API Key has partner role. # noqa: E501 :param partner: The partner of this APIKeyOut. # noqa: E501 :type: bool @@ -244,6 +258,7 @@ def partner(self, partner): def striped(self): """Gets the striped of this APIKeyOut. # noqa: E501 + The API Key is associated to a valid Stripe account. # noqa: E501 :return: The striped of this APIKeyOut. # noqa: E501 :rtype: bool @@ -254,6 +269,7 @@ def striped(self): def striped(self, striped): """Sets the striped of this APIKeyOut. + The API Key is associated to a valid Stripe account. # noqa: E501 :param striped: The striped of this APIKeyOut. # noqa: E501 :type: bool @@ -265,6 +281,7 @@ def striped(self, striped): def corporate(self): """Gets the corporate of this APIKeyOut. # noqa: E501 + The API Key has role corporate (ex SWIFT payments instead of Stripe payments). # noqa: E501 :return: The corporate of this APIKeyOut. # noqa: E501 :rtype: bool @@ -275,6 +292,7 @@ def corporate(self): def corporate(self, corporate): """Sets the corporate of this APIKeyOut. + The API Key has role corporate (ex SWIFT payments instead of Stripe payments). # noqa: E501 :param corporate: The corporate of this APIKeyOut. # noqa: E501 :type: bool @@ -286,6 +304,7 @@ def corporate(self, corporate): def disabled(self): """Gets the disabled of this APIKeyOut. # noqa: E501 + The API Key is temporarily or permanently disabled. # noqa: E501 :return: The disabled of this APIKeyOut. # noqa: E501 :rtype: bool @@ -296,6 +315,7 @@ def disabled(self): def disabled(self, disabled): """Sets the disabled of this APIKeyOut. + The API Key is temporarily or permanently disabled. # noqa: E501 :param disabled: The disabled of this APIKeyOut. # noqa: E501 :type: bool diff --git a/openapi_client/models/api_period_usage_out.py b/openapi_client/models/api_period_usage_out.py index 4af5b69..1aeb840 100644 --- a/openapi_client/models/api_period_usage_out.py +++ b/openapi_client/models/api_period_usage_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -119,6 +119,7 @@ def billing_period(self, billing_period): def overage_excl_tax(self): """Gets the overage_excl_tax of this APIPeriodUsageOut. # noqa: E501 + Overage amount including any tax. # noqa: E501 :return: The overage_excl_tax of this APIPeriodUsageOut. # noqa: E501 :rtype: float @@ -129,6 +130,7 @@ def overage_excl_tax(self): def overage_excl_tax(self, overage_excl_tax): """Sets the overage_excl_tax of this APIPeriodUsageOut. + Overage amount including any tax. # noqa: E501 :param overage_excl_tax: The overage_excl_tax of this APIPeriodUsageOut. # noqa: E501 :type: float @@ -140,6 +142,7 @@ def overage_excl_tax(self, overage_excl_tax): def overage_incl_tax(self): """Gets the overage_incl_tax of this APIPeriodUsageOut. # noqa: E501 + Overage amount including tax (if applicable). # noqa: E501 :return: The overage_incl_tax of this APIPeriodUsageOut. # noqa: E501 :rtype: float @@ -150,6 +153,7 @@ def overage_incl_tax(self): def overage_incl_tax(self, overage_incl_tax): """Sets the overage_incl_tax of this APIPeriodUsageOut. + Overage amount including tax (if applicable). # noqa: E501 :param overage_incl_tax: The overage_incl_tax of this APIPeriodUsageOut. # noqa: E501 :type: float @@ -161,6 +165,7 @@ def overage_incl_tax(self, overage_incl_tax): def overage_currency(self): """Gets the overage_currency of this APIPeriodUsageOut. # noqa: E501 + Currency of the overage amount. # noqa: E501 :return: The overage_currency of this APIPeriodUsageOut. # noqa: E501 :rtype: str @@ -171,6 +176,7 @@ def overage_currency(self): def overage_currency(self, overage_currency): """Sets the overage_currency of this APIPeriodUsageOut. + Currency of the overage amount. # noqa: E501 :param overage_currency: The overage_currency of this APIPeriodUsageOut. # noqa: E501 :type: str @@ -182,6 +188,7 @@ def overage_currency(self, overage_currency): def overage_quantity(self): """Gets the overage_quantity of this APIPeriodUsageOut. # noqa: E501 + Quantity above monthly quota of the current subscritpion, in units. # noqa: E501 :return: The overage_quantity of this APIPeriodUsageOut. # noqa: E501 :rtype: int @@ -192,6 +199,7 @@ def overage_quantity(self): def overage_quantity(self, overage_quantity): """Sets the overage_quantity of this APIPeriodUsageOut. + Quantity above monthly quota of the current subscritpion, in units. # noqa: E501 :param overage_quantity: The overage_quantity of this APIPeriodUsageOut. # noqa: E501 :type: int diff --git a/openapi_client/models/api_plan_subscription_out.py b/openapi_client/models/api_plan_subscription_out.py index 37f415b..0d5beb8 100644 --- a/openapi_client/models/api_plan_subscription_out.py +++ b/openapi_client/models/api_plan_subscription_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -142,6 +142,7 @@ def __init__(self, api_key=None, plan_started=None, prior_plan_started=None, pla def api_key(self): """Gets the api_key of this APIPlanSubscriptionOut. # noqa: E501 + User API Key. # noqa: E501 :return: The api_key of this APIPlanSubscriptionOut. # noqa: E501 :rtype: str @@ -152,6 +153,7 @@ def api_key(self): def api_key(self, api_key): """Sets the api_key of this APIPlanSubscriptionOut. + User API Key. # noqa: E501 :param api_key: The api_key of this APIPlanSubscriptionOut. # noqa: E501 :type: str @@ -163,6 +165,7 @@ def api_key(self, api_key): def plan_started(self): """Gets the plan_started of this APIPlanSubscriptionOut. # noqa: E501 + Datetime when the user subscribed to the current plan. # noqa: E501 :return: The plan_started of this APIPlanSubscriptionOut. # noqa: E501 :rtype: int @@ -173,6 +176,7 @@ def plan_started(self): def plan_started(self, plan_started): """Sets the plan_started of this APIPlanSubscriptionOut. + Datetime when the user subscribed to the current plan. # noqa: E501 :param plan_started: The plan_started of this APIPlanSubscriptionOut. # noqa: E501 :type: int @@ -184,6 +188,7 @@ def plan_started(self, plan_started): def prior_plan_started(self): """Gets the prior_plan_started of this APIPlanSubscriptionOut. # noqa: E501 + Datetime when the user subscribed to the prior plan. # noqa: E501 :return: The prior_plan_started of this APIPlanSubscriptionOut. # noqa: E501 :rtype: int @@ -194,6 +199,7 @@ def prior_plan_started(self): def prior_plan_started(self, prior_plan_started): """Sets the prior_plan_started of this APIPlanSubscriptionOut. + Datetime when the user subscribed to the prior plan. # noqa: E501 :param prior_plan_started: The prior_plan_started of this APIPlanSubscriptionOut. # noqa: E501 :type: int @@ -205,6 +211,7 @@ def prior_plan_started(self, prior_plan_started): def plan_ended(self): """Gets the plan_ended of this APIPlanSubscriptionOut. # noqa: E501 + Datetime when the user ended the plan. # noqa: E501 :return: The plan_ended of this APIPlanSubscriptionOut. # noqa: E501 :rtype: int @@ -215,6 +222,7 @@ def plan_ended(self): def plan_ended(self, plan_ended): """Sets the plan_ended of this APIPlanSubscriptionOut. + Datetime when the user ended the plan. # noqa: E501 :param plan_ended: The plan_ended of this APIPlanSubscriptionOut. # noqa: E501 :type: int @@ -226,6 +234,7 @@ def plan_ended(self, plan_ended): def tax_rate(self): """Gets the tax_rate of this APIPlanSubscriptionOut. # noqa: E501 + Applicable tax rate for the plan. # noqa: E501 :return: The tax_rate of this APIPlanSubscriptionOut. # noqa: E501 :rtype: float @@ -236,6 +245,7 @@ def tax_rate(self): def tax_rate(self, tax_rate): """Sets the tax_rate of this APIPlanSubscriptionOut. + Applicable tax rate for the plan. # noqa: E501 :param tax_rate: The tax_rate of this APIPlanSubscriptionOut. # noqa: E501 :type: float @@ -247,6 +257,7 @@ def tax_rate(self, tax_rate): def plan_name(self): """Gets the plan_name of this APIPlanSubscriptionOut. # noqa: E501 + Current plan name. # noqa: E501 :return: The plan_name of this APIPlanSubscriptionOut. # noqa: E501 :rtype: str @@ -257,6 +268,7 @@ def plan_name(self): def plan_name(self, plan_name): """Sets the plan_name of this APIPlanSubscriptionOut. + Current plan name. # noqa: E501 :param plan_name: The plan_name of this APIPlanSubscriptionOut. # noqa: E501 :type: str @@ -268,6 +280,7 @@ def plan_name(self, plan_name): def plan_base_fees_key(self): """Gets the plan_base_fees_key of this APIPlanSubscriptionOut. # noqa: E501 + Current plan key (as in Stripe product). # noqa: E501 :return: The plan_base_fees_key of this APIPlanSubscriptionOut. # noqa: E501 :rtype: str @@ -278,6 +291,7 @@ def plan_base_fees_key(self): def plan_base_fees_key(self, plan_base_fees_key): """Sets the plan_base_fees_key of this APIPlanSubscriptionOut. + Current plan key (as in Stripe product). # noqa: E501 :param plan_base_fees_key: The plan_base_fees_key of this APIPlanSubscriptionOut. # noqa: E501 :type: str @@ -289,6 +303,7 @@ def plan_base_fees_key(self, plan_base_fees_key): def plan_status(self): """Gets the plan_status of this APIPlanSubscriptionOut. # noqa: E501 + Plan status. # noqa: E501 :return: The plan_status of this APIPlanSubscriptionOut. # noqa: E501 :rtype: str @@ -299,6 +314,7 @@ def plan_status(self): def plan_status(self, plan_status): """Sets the plan_status of this APIPlanSubscriptionOut. + Plan status. # noqa: E501 :param plan_status: The plan_status of this APIPlanSubscriptionOut. # noqa: E501 :type: str @@ -310,6 +326,7 @@ def plan_status(self, plan_status): def plan_quota(self): """Gets the plan_quota of this APIPlanSubscriptionOut. # noqa: E501 + Current plan quota in quantity of units (NB: some API use several units per name). # noqa: E501 :return: The plan_quota of this APIPlanSubscriptionOut. # noqa: E501 :rtype: int @@ -320,6 +337,7 @@ def plan_quota(self): def plan_quota(self, plan_quota): """Sets the plan_quota of this APIPlanSubscriptionOut. + Current plan quota in quantity of units (NB: some API use several units per name). # noqa: E501 :param plan_quota: The plan_quota of this APIPlanSubscriptionOut. # noqa: E501 :type: int @@ -331,6 +349,7 @@ def plan_quota(self, plan_quota): def price_usd(self): """Gets the price_usd of this APIPlanSubscriptionOut. # noqa: E501 + Current plan monthly price expressed in USD (includes a free quota). # noqa: E501 :return: The price_usd of this APIPlanSubscriptionOut. # noqa: E501 :rtype: float @@ -341,6 +360,7 @@ def price_usd(self): def price_usd(self, price_usd): """Sets the price_usd of this APIPlanSubscriptionOut. + Current plan monthly price expressed in USD (includes a free quota). # noqa: E501 :param price_usd: The price_usd of this APIPlanSubscriptionOut. # noqa: E501 :type: float @@ -352,6 +372,7 @@ def price_usd(self, price_usd): def price_overage_usd(self): """Gets the price_overage_usd of this APIPlanSubscriptionOut. # noqa: E501 + Current plan price for overages expressed in USD (extra price per unit above the free quota). # noqa: E501 :return: The price_overage_usd of this APIPlanSubscriptionOut. # noqa: E501 :rtype: float @@ -362,6 +383,7 @@ def price_overage_usd(self): def price_overage_usd(self, price_overage_usd): """Sets the price_overage_usd of this APIPlanSubscriptionOut. + Current plan price for overages expressed in USD (extra price per unit above the free quota). # noqa: E501 :param price_overage_usd: The price_overage_usd of this APIPlanSubscriptionOut. # noqa: E501 :type: float @@ -373,6 +395,7 @@ def price_overage_usd(self, price_overage_usd): def price(self): """Gets the price of this APIPlanSubscriptionOut. # noqa: E501 + Current plan price for overages expressed in Currency (extra price per unit above the free quota). # noqa: E501 :return: The price of this APIPlanSubscriptionOut. # noqa: E501 :rtype: float @@ -383,6 +406,7 @@ def price(self): def price(self, price): """Sets the price of this APIPlanSubscriptionOut. + Current plan price for overages expressed in Currency (extra price per unit above the free quota). # noqa: E501 :param price: The price of this APIPlanSubscriptionOut. # noqa: E501 :type: float @@ -394,6 +418,7 @@ def price(self, price): def price_overage(self): """Gets the price_overage of this APIPlanSubscriptionOut. # noqa: E501 + Current plan price for overages expressed in Currency (extra price per unit above the free quota). # noqa: E501 :return: The price_overage of this APIPlanSubscriptionOut. # noqa: E501 :rtype: float @@ -404,6 +429,7 @@ def price_overage(self): def price_overage(self, price_overage): """Sets the price_overage of this APIPlanSubscriptionOut. + Current plan price for overages expressed in Currency (extra price per unit above the free quota). # noqa: E501 :param price_overage: The price_overage of this APIPlanSubscriptionOut. # noqa: E501 :type: float @@ -415,6 +441,7 @@ def price_overage(self, price_overage): def currency(self): """Gets the currency of this APIPlanSubscriptionOut. # noqa: E501 + Current plan Currency for prices. # noqa: E501 :return: The currency of this APIPlanSubscriptionOut. # noqa: E501 :rtype: str @@ -425,6 +452,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this APIPlanSubscriptionOut. + Current plan Currency for prices. # noqa: E501 :param currency: The currency of this APIPlanSubscriptionOut. # noqa: E501 :type: str @@ -436,6 +464,7 @@ def currency(self, currency): def currency_factor(self): """Gets the currency_factor of this APIPlanSubscriptionOut. # noqa: E501 + For USD, GBP, EUR - the factor is 1. # noqa: E501 :return: The currency_factor of this APIPlanSubscriptionOut. # noqa: E501 :rtype: float @@ -446,6 +475,7 @@ def currency_factor(self): def currency_factor(self, currency_factor): """Sets the currency_factor of this APIPlanSubscriptionOut. + For USD, GBP, EUR - the factor is 1. # noqa: E501 :param currency_factor: The currency_factor of this APIPlanSubscriptionOut. # noqa: E501 :type: float @@ -457,6 +487,7 @@ def currency_factor(self, currency_factor): def stripe_customer_id(self): """Gets the stripe_customer_id of this APIPlanSubscriptionOut. # noqa: E501 + Stripe customer identifier. # noqa: E501 :return: The stripe_customer_id of this APIPlanSubscriptionOut. # noqa: E501 :rtype: str @@ -467,6 +498,7 @@ def stripe_customer_id(self): def stripe_customer_id(self, stripe_customer_id): """Sets the stripe_customer_id of this APIPlanSubscriptionOut. + Stripe customer identifier. # noqa: E501 :param stripe_customer_id: The stripe_customer_id of this APIPlanSubscriptionOut. # noqa: E501 :type: str @@ -478,6 +510,7 @@ def stripe_customer_id(self, stripe_customer_id): def stripe_status(self): """Gets the stripe_status of this APIPlanSubscriptionOut. # noqa: E501 + Stripe status ex active. # noqa: E501 :return: The stripe_status of this APIPlanSubscriptionOut. # noqa: E501 :rtype: str @@ -488,6 +521,7 @@ def stripe_status(self): def stripe_status(self, stripe_status): """Sets the stripe_status of this APIPlanSubscriptionOut. + Stripe status ex active. # noqa: E501 :param stripe_status: The stripe_status of this APIPlanSubscriptionOut. # noqa: E501 :type: str @@ -499,6 +533,7 @@ def stripe_status(self, stripe_status): def stripe_subscription(self): """Gets the stripe_subscription of this APIPlanSubscriptionOut. # noqa: E501 + Stripe subscription identifier. # noqa: E501 :return: The stripe_subscription of this APIPlanSubscriptionOut. # noqa: E501 :rtype: str @@ -509,6 +544,7 @@ def stripe_subscription(self): def stripe_subscription(self, stripe_subscription): """Sets the stripe_subscription of this APIPlanSubscriptionOut. + Stripe subscription identifier. # noqa: E501 :param stripe_subscription: The stripe_subscription of this APIPlanSubscriptionOut. # noqa: E501 :type: str @@ -520,6 +556,7 @@ def stripe_subscription(self, stripe_subscription): def user_id(self): """Gets the user_id of this APIPlanSubscriptionOut. # noqa: E501 + Internal user identifier. # noqa: E501 :return: The user_id of this APIPlanSubscriptionOut. # noqa: E501 :rtype: str @@ -530,6 +567,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this APIPlanSubscriptionOut. + Internal user identifier. # noqa: E501 :param user_id: The user_id of this APIPlanSubscriptionOut. # noqa: E501 :type: str diff --git a/openapi_client/models/api_service_out.py b/openapi_client/models/api_service_out.py index af9c85e..70ae200 100644 --- a/openapi_client/models/api_service_out.py +++ b/openapi_client/models/api_service_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -62,6 +62,7 @@ def __init__(self, service_name=None, service_group=None, cost_in_units=None): def service_name(self): """Gets the service_name of this APIServiceOut. # noqa: E501 + A service name corresponds to classifier name in apiStatus (ex. personalname_gender or personalfullname_gender) # noqa: E501 :return: The service_name of this APIServiceOut. # noqa: E501 :rtype: str @@ -72,6 +73,7 @@ def service_name(self): def service_name(self, service_name): """Sets the service_name of this APIServiceOut. + A service name corresponds to classifier name in apiStatus (ex. personalname_gender or personalfullname_gender) # noqa: E501 :param service_name: The service_name of this APIServiceOut. # noqa: E501 :type: str @@ -83,6 +85,7 @@ def service_name(self, service_name): def service_group(self): """Gets the service_group of this APIServiceOut. # noqa: E501 + Groups together classifiers providing a similar service (ex. gender groups personalname_gender and personalfullname_gender) # noqa: E501 :return: The service_group of this APIServiceOut. # noqa: E501 :rtype: str @@ -93,6 +96,7 @@ def service_group(self): def service_group(self, service_group): """Sets the service_group of this APIServiceOut. + Groups together classifiers providing a similar service (ex. gender groups personalname_gender and personalfullname_gender) # noqa: E501 :param service_group: The service_group of this APIServiceOut. # noqa: E501 :type: str @@ -104,6 +108,7 @@ def service_group(self, service_group): def cost_in_units(self): """Gets the cost_in_units of this APIServiceOut. # noqa: E501 + Indicates how many units per call this service costs (ex. the number of units per name) # noqa: E501 :return: The cost_in_units of this APIServiceOut. # noqa: E501 :rtype: int @@ -114,6 +119,7 @@ def cost_in_units(self): def cost_in_units(self, cost_in_units): """Sets the cost_in_units of this APIServiceOut. + Indicates how many units per call this service costs (ex. the number of units per name) # noqa: E501 :param cost_in_units: The cost_in_units of this APIServiceOut. # noqa: E501 :type: int diff --git a/openapi_client/models/api_services_out.py b/openapi_client/models/api_services_out.py index 544f487..0e24377 100644 --- a/openapi_client/models/api_services_out.py +++ b/openapi_client/models/api_services_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -52,6 +52,7 @@ def __init__(self, api_services=None): # noqa: E501 def api_services(self): """Gets the api_services of this APIServicesOut. # noqa: E501 + List of API Services # noqa: E501 :return: The api_services of this APIServicesOut. # noqa: E501 :rtype: list[APIServiceOut] @@ -62,6 +63,7 @@ def api_services(self): def api_services(self, api_services): """Sets the api_services of this APIServicesOut. + List of API Services # noqa: E501 :param api_services: The api_services of this APIServicesOut. # noqa: E501 :type: list[APIServiceOut] diff --git a/openapi_client/models/api_usage_aggregated_out.py b/openapi_client/models/api_usage_aggregated_out.py index 846f21e..8e2b1de 100644 --- a/openapi_client/models/api_usage_aggregated_out.py +++ b/openapi_client/models/api_usage_aggregated_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -87,6 +87,7 @@ def __init__(self, time_unit=None, period_start=None, period_end=None, total_usa def time_unit(self): """Gets the time_unit of this APIUsageAggregatedOut. # noqa: E501 + Time unit is DAY, WEEK or MONTH depending on prior usage # noqa: E501 :return: The time_unit of this APIUsageAggregatedOut. # noqa: E501 :rtype: str @@ -97,6 +98,7 @@ def time_unit(self): def time_unit(self, time_unit): """Sets the time_unit of this APIUsageAggregatedOut. + Time unit is DAY, WEEK or MONTH depending on prior usage # noqa: E501 :param time_unit: The time_unit of this APIUsageAggregatedOut. # noqa: E501 :type: str @@ -108,6 +110,7 @@ def time_unit(self, time_unit): def period_start(self): """Gets the period_start of this APIUsageAggregatedOut. # noqa: E501 + Start datetime of the reporting period # noqa: E501 :return: The period_start of this APIUsageAggregatedOut. # noqa: E501 :rtype: int @@ -118,6 +121,7 @@ def period_start(self): def period_start(self, period_start): """Sets the period_start of this APIUsageAggregatedOut. + Start datetime of the reporting period # noqa: E501 :param period_start: The period_start of this APIUsageAggregatedOut. # noqa: E501 :type: int @@ -129,6 +133,7 @@ def period_start(self, period_start): def period_end(self): """Gets the period_end of this APIUsageAggregatedOut. # noqa: E501 + End datetime of the reporting period # noqa: E501 :return: The period_end of this APIUsageAggregatedOut. # noqa: E501 :rtype: int @@ -139,6 +144,7 @@ def period_end(self): def period_end(self, period_end): """Sets the period_end of this APIUsageAggregatedOut. + End datetime of the reporting period # noqa: E501 :param period_end: The period_end of this APIUsageAggregatedOut. # noqa: E501 :type: int @@ -150,6 +156,7 @@ def period_end(self, period_end): def total_usage(self): """Gets the total_usage of this APIUsageAggregatedOut. # noqa: E501 + Total usage in the current period # noqa: E501 :return: The total_usage of this APIUsageAggregatedOut. # noqa: E501 :rtype: int @@ -160,6 +167,7 @@ def total_usage(self): def total_usage(self, total_usage): """Sets the total_usage of this APIUsageAggregatedOut. + Total usage in the current period # noqa: E501 :param total_usage: The total_usage of this APIUsageAggregatedOut. # noqa: E501 :type: int @@ -171,6 +179,7 @@ def total_usage(self, total_usage): def history_truncated(self): """Gets the history_truncated of this APIUsageAggregatedOut. # noqa: E501 + If the history was truncaded due to data limit # noqa: E501 :return: The history_truncated of this APIUsageAggregatedOut. # noqa: E501 :rtype: bool @@ -181,6 +190,7 @@ def history_truncated(self): def history_truncated(self, history_truncated): """Sets the history_truncated of this APIUsageAggregatedOut. + If the history was truncaded due to data limit # noqa: E501 :param history_truncated: The history_truncated of this APIUsageAggregatedOut. # noqa: E501 :type: bool @@ -192,6 +202,7 @@ def history_truncated(self, history_truncated): def data(self): """Gets the data of this APIUsageAggregatedOut. # noqa: E501 + Data points : usage per DAY, WEEK or MONTH and per apiService # noqa: E501 :return: The data of this APIUsageAggregatedOut. # noqa: E501 :rtype: list[list[int]] @@ -202,6 +213,7 @@ def data(self): def data(self, data): """Sets the data of this APIUsageAggregatedOut. + Data points : usage per DAY, WEEK or MONTH and per apiService # noqa: E501 :param data: The data of this APIUsageAggregatedOut. # noqa: E501 :type: list[list[int]] @@ -213,6 +225,7 @@ def data(self, data): def col_headers(self): """Gets the col_headers of this APIUsageAggregatedOut. # noqa: E501 + apiServices as column headers # noqa: E501 :return: The col_headers of this APIUsageAggregatedOut. # noqa: E501 :rtype: list[str] @@ -223,6 +236,7 @@ def col_headers(self): def col_headers(self, col_headers): """Sets the col_headers of this APIUsageAggregatedOut. + apiServices as column headers # noqa: E501 :param col_headers: The col_headers of this APIUsageAggregatedOut. # noqa: E501 :type: list[str] @@ -234,6 +248,7 @@ def col_headers(self, col_headers): def row_headers(self): """Gets the row_headers of this APIUsageAggregatedOut. # noqa: E501 + dates as row headers # noqa: E501 :return: The row_headers of this APIUsageAggregatedOut. # noqa: E501 :rtype: list[str] @@ -244,6 +259,7 @@ def row_headers(self): def row_headers(self, row_headers): """Sets the row_headers of this APIUsageAggregatedOut. + dates as row headers # noqa: E501 :param row_headers: The row_headers of this APIUsageAggregatedOut. # noqa: E501 :type: list[str] diff --git a/openapi_client/models/api_usage_history_out.py b/openapi_client/models/api_usage_history_out.py new file mode 100644 index 0000000..28bb107 --- /dev/null +++ b/openapi_client/models/api_usage_history_out.py @@ -0,0 +1,115 @@ +# coding: utf-8 + +""" + NamSor API v2 + + 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.15 + Contact: contact@namsor.com + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + + +class APIUsageHistoryOut(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'detailed_usage': 'list[APICounterV2Out]' + } + + attribute_map = { + 'detailed_usage': 'detailedUsage' + } + + def __init__(self, detailed_usage=None): # noqa: E501 + """APIUsageHistoryOut - a model defined in OpenAPI""" # noqa: E501 + + self._detailed_usage = None + self.discriminator = None + + if detailed_usage is not None: + self.detailed_usage = detailed_usage + + @property + def detailed_usage(self): + """Gets the detailed_usage of this APIUsageHistoryOut. # noqa: E501 + + Detailed usage as reported by the deduplicating API counter. # noqa: E501 + + :return: The detailed_usage of this APIUsageHistoryOut. # noqa: E501 + :rtype: list[APICounterV2Out] + """ + return self._detailed_usage + + @detailed_usage.setter + def detailed_usage(self, detailed_usage): + """Sets the detailed_usage of this APIUsageHistoryOut. + + Detailed usage as reported by the deduplicating API counter. # noqa: E501 + + :param detailed_usage: The detailed_usage of this APIUsageHistoryOut. # noqa: E501 + :type: list[APICounterV2Out] + """ + + self._detailed_usage = detailed_usage + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, APIUsageHistoryOut): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/openapi_client/models/batch_corridor_in.py b/openapi_client/models/batch_corridor_in.py index 87d432b..1fd2c07 100644 --- a/openapi_client/models/batch_corridor_in.py +++ b/openapi_client/models/batch_corridor_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/batch_corridor_out.py b/openapi_client/models/batch_corridor_out.py index fd38510..16ae9cd 100644 --- a/openapi_client/models/batch_corridor_out.py +++ b/openapi_client/models/batch_corridor_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -52,6 +52,7 @@ def __init__(self, corridor_from_to=None): # noqa: E501 def corridor_from_to(self): """Gets the corridor_from_to of this BatchCorridorOut. # noqa: E501 + Classified corridors # noqa: E501 :return: The corridor_from_to of this BatchCorridorOut. # noqa: E501 :rtype: list[CorridorOut] @@ -62,6 +63,7 @@ def corridor_from_to(self): def corridor_from_to(self, corridor_from_to): """Sets the corridor_from_to of this BatchCorridorOut. + Classified corridors # noqa: E501 :param corridor_from_to: The corridor_from_to of this BatchCorridorOut. # noqa: E501 :type: list[CorridorOut] diff --git a/openapi_client/models/batch_first_last_name_diasporaed_out.py b/openapi_client/models/batch_first_last_name_diasporaed_out.py index 95d573e..8bf6b29 100644 --- a/openapi_client/models/batch_first_last_name_diasporaed_out.py +++ b/openapi_client/models/batch_first_last_name_diasporaed_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -52,6 +52,7 @@ def __init__(self, personal_names=None): # noqa: E501 def personal_names(self): """Gets the personal_names of this BatchFirstLastNameDiasporaedOut. # noqa: E501 + Classified diaspora names # noqa: E501 :return: The personal_names of this BatchFirstLastNameDiasporaedOut. # noqa: E501 :rtype: list[FirstLastNameDiasporaedOut] @@ -62,6 +63,7 @@ def personal_names(self): def personal_names(self, personal_names): """Sets the personal_names of this BatchFirstLastNameDiasporaedOut. + Classified diaspora names # noqa: E501 :param personal_names: The personal_names of this BatchFirstLastNameDiasporaedOut. # noqa: E501 :type: list[FirstLastNameDiasporaedOut] diff --git a/openapi_client/models/batch_first_last_name_gender_in.py b/openapi_client/models/batch_first_last_name_gender_in.py index 2b738b5..03baf48 100644 --- a/openapi_client/models/batch_first_last_name_gender_in.py +++ b/openapi_client/models/batch_first_last_name_gender_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/batch_first_last_name_gendered_out.py b/openapi_client/models/batch_first_last_name_gendered_out.py index 5ccdd73..851eb90 100644 --- a/openapi_client/models/batch_first_last_name_gendered_out.py +++ b/openapi_client/models/batch_first_last_name_gendered_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -52,6 +52,7 @@ def __init__(self, personal_names=None): # noqa: E501 def personal_names(self): """Gets the personal_names of this BatchFirstLastNameGenderedOut. # noqa: E501 + Classified genderized names # noqa: E501 :return: The personal_names of this BatchFirstLastNameGenderedOut. # noqa: E501 :rtype: list[FirstLastNameGenderedOut] @@ -62,6 +63,7 @@ def personal_names(self): def personal_names(self, personal_names): """Sets the personal_names of this BatchFirstLastNameGenderedOut. + Classified genderized names # noqa: E501 :param personal_names: The personal_names of this BatchFirstLastNameGenderedOut. # noqa: E501 :type: list[FirstLastNameGenderedOut] diff --git a/openapi_client/models/batch_first_last_name_geo_in.py b/openapi_client/models/batch_first_last_name_geo_in.py index 61f58dd..d53bcab 100644 --- a/openapi_client/models/batch_first_last_name_geo_in.py +++ b/openapi_client/models/batch_first_last_name_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/batch_first_last_name_geo_zipped_in.py b/openapi_client/models/batch_first_last_name_geo_zipped_in.py index be84fb5..75272aa 100644 --- a/openapi_client/models/batch_first_last_name_geo_zipped_in.py +++ b/openapi_client/models/batch_first_last_name_geo_zipped_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/batch_first_last_name_in.py b/openapi_client/models/batch_first_last_name_in.py index d008d35..3f18490 100644 --- a/openapi_client/models/batch_first_last_name_in.py +++ b/openapi_client/models/batch_first_last_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/batch_first_last_name_origined_out.py b/openapi_client/models/batch_first_last_name_origined_out.py index 374d608..e921292 100644 --- a/openapi_client/models/batch_first_last_name_origined_out.py +++ b/openapi_client/models/batch_first_last_name_origined_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -52,6 +52,7 @@ def __init__(self, personal_names=None): # noqa: E501 def personal_names(self): """Gets the personal_names of this BatchFirstLastNameOriginedOut. # noqa: E501 + Classified origined names # noqa: E501 :return: The personal_names of this BatchFirstLastNameOriginedOut. # noqa: E501 :rtype: list[FirstLastNameOriginedOut] @@ -62,6 +63,7 @@ def personal_names(self): def personal_names(self, personal_names): """Sets the personal_names of this BatchFirstLastNameOriginedOut. + Classified origined names # noqa: E501 :param personal_names: The personal_names of this BatchFirstLastNameOriginedOut. # noqa: E501 :type: list[FirstLastNameOriginedOut] diff --git a/openapi_client/models/batch_first_last_name_phone_coded_out.py b/openapi_client/models/batch_first_last_name_phone_coded_out.py index 1fb6b74..5079d62 100644 --- a/openapi_client/models/batch_first_last_name_phone_coded_out.py +++ b/openapi_client/models/batch_first_last_name_phone_coded_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -52,6 +52,7 @@ def __init__(self, personal_names_with_phone_numbers=None): # noqa: E501 def personal_names_with_phone_numbers(self): """Gets the personal_names_with_phone_numbers of this BatchFirstLastNamePhoneCodedOut. # noqa: E501 + Classified phone-coded names # noqa: E501 :return: The personal_names_with_phone_numbers of this BatchFirstLastNamePhoneCodedOut. # noqa: E501 :rtype: list[FirstLastNamePhoneCodedOut] @@ -62,6 +63,7 @@ def personal_names_with_phone_numbers(self): def personal_names_with_phone_numbers(self, personal_names_with_phone_numbers): """Sets the personal_names_with_phone_numbers of this BatchFirstLastNamePhoneCodedOut. + Classified phone-coded names # noqa: E501 :param personal_names_with_phone_numbers: The personal_names_with_phone_numbers of this BatchFirstLastNamePhoneCodedOut. # noqa: E501 :type: list[FirstLastNamePhoneCodedOut] diff --git a/openapi_client/models/batch_first_last_name_phone_number_geo_in.py b/openapi_client/models/batch_first_last_name_phone_number_geo_in.py index eb676af..37e5bce 100644 --- a/openapi_client/models/batch_first_last_name_phone_number_geo_in.py +++ b/openapi_client/models/batch_first_last_name_phone_number_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/batch_first_last_name_phone_number_in.py b/openapi_client/models/batch_first_last_name_phone_number_in.py index 9fb8b88..866d584 100644 --- a/openapi_client/models/batch_first_last_name_phone_number_in.py +++ b/openapi_client/models/batch_first_last_name_phone_number_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/batch_first_last_name_us_race_ethnicity_out.py b/openapi_client/models/batch_first_last_name_us_race_ethnicity_out.py index 0958c58..8ceb152 100644 --- a/openapi_client/models/batch_first_last_name_us_race_ethnicity_out.py +++ b/openapi_client/models/batch_first_last_name_us_race_ethnicity_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -52,6 +52,7 @@ def __init__(self, personal_names=None): # noqa: E501 def personal_names(self): """Gets the personal_names of this BatchFirstLastNameUSRaceEthnicityOut. # noqa: E501 + Classified US 'race'/ethnicized names # noqa: E501 :return: The personal_names of this BatchFirstLastNameUSRaceEthnicityOut. # noqa: E501 :rtype: list[FirstLastNameUSRaceEthnicityOut] @@ -62,6 +63,7 @@ def personal_names(self): def personal_names(self, personal_names): """Sets the personal_names of this BatchFirstLastNameUSRaceEthnicityOut. + Classified US 'race'/ethnicized names # noqa: E501 :param personal_names: The personal_names of this BatchFirstLastNameUSRaceEthnicityOut. # noqa: E501 :type: list[FirstLastNameUSRaceEthnicityOut] diff --git a/openapi_client/models/batch_match_personal_first_last_name_in.py b/openapi_client/models/batch_match_personal_first_last_name_in.py index 5a75c5a..9d46e95 100644 --- a/openapi_client/models/batch_match_personal_first_last_name_in.py +++ b/openapi_client/models/batch_match_personal_first_last_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/batch_name_geo_in.py b/openapi_client/models/batch_name_geo_in.py index 438398c..cb4b4c6 100644 --- a/openapi_client/models/batch_name_geo_in.py +++ b/openapi_client/models/batch_name_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/batch_name_in.py b/openapi_client/models/batch_name_in.py index 81c25f9..fd38bbb 100644 --- a/openapi_client/models/batch_name_in.py +++ b/openapi_client/models/batch_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/batch_name_match_candidates_out.py b/openapi_client/models/batch_name_match_candidates_out.py index e1640b4..dc08cd1 100644 --- a/openapi_client/models/batch_name_match_candidates_out.py +++ b/openapi_client/models/batch_name_match_candidates_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -52,6 +52,7 @@ def __init__(self, names_and_match_candidates=None): # noqa: E501 def names_and_match_candidates(self): """Gets the names_and_match_candidates of this BatchNameMatchCandidatesOut. # noqa: E501 + Classified matched names # noqa: E501 :return: The names_and_match_candidates of this BatchNameMatchCandidatesOut. # noqa: E501 :rtype: list[NameMatchCandidatesOut] @@ -62,6 +63,7 @@ def names_and_match_candidates(self): def names_and_match_candidates(self, names_and_match_candidates): """Sets the names_and_match_candidates of this BatchNameMatchCandidatesOut. + Classified matched names # noqa: E501 :param names_and_match_candidates: The names_and_match_candidates of this BatchNameMatchCandidatesOut. # noqa: E501 :type: list[NameMatchCandidatesOut] diff --git a/openapi_client/models/batch_name_matched_out.py b/openapi_client/models/batch_name_matched_out.py index 6aca761..8f3147a 100644 --- a/openapi_client/models/batch_name_matched_out.py +++ b/openapi_client/models/batch_name_matched_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -52,6 +52,7 @@ def __init__(self, matched_names=None): # noqa: E501 def matched_names(self): """Gets the matched_names of this BatchNameMatchedOut. # noqa: E501 + Classified matched names # noqa: E501 :return: The matched_names of this BatchNameMatchedOut. # noqa: E501 :rtype: list[NameMatchedOut] @@ -62,6 +63,7 @@ def matched_names(self): def matched_names(self, matched_names): """Sets the matched_names of this BatchNameMatchedOut. + Classified matched names # noqa: E501 :param matched_names: The matched_names of this BatchNameMatchedOut. # noqa: E501 :type: list[NameMatchedOut] diff --git a/openapi_client/models/batch_personal_name_gendered_out.py b/openapi_client/models/batch_personal_name_gendered_out.py index 33d3cc9..99a8dd8 100644 --- a/openapi_client/models/batch_personal_name_gendered_out.py +++ b/openapi_client/models/batch_personal_name_gendered_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -52,6 +52,7 @@ def __init__(self, personal_names=None): # noqa: E501 def personal_names(self): """Gets the personal_names of this BatchPersonalNameGenderedOut. # noqa: E501 + Classified genderized names # noqa: E501 :return: The personal_names of this BatchPersonalNameGenderedOut. # noqa: E501 :rtype: list[PersonalNameGenderedOut] @@ -62,6 +63,7 @@ def personal_names(self): def personal_names(self, personal_names): """Sets the personal_names of this BatchPersonalNameGenderedOut. + Classified genderized names # noqa: E501 :param personal_names: The personal_names of this BatchPersonalNameGenderedOut. # noqa: E501 :type: list[PersonalNameGenderedOut] diff --git a/openapi_client/models/batch_personal_name_geo_in.py b/openapi_client/models/batch_personal_name_geo_in.py index 5fd5581..dd23637 100644 --- a/openapi_client/models/batch_personal_name_geo_in.py +++ b/openapi_client/models/batch_personal_name_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/batch_personal_name_geo_out.py b/openapi_client/models/batch_personal_name_geo_out.py index a8189b9..96f0894 100644 --- a/openapi_client/models/batch_personal_name_geo_out.py +++ b/openapi_client/models/batch_personal_name_geo_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -52,6 +52,7 @@ def __init__(self, personal_names=None): # noqa: E501 def personal_names(self): """Gets the personal_names of this BatchPersonalNameGeoOut. # noqa: E501 + Classified geo names # noqa: E501 :return: The personal_names of this BatchPersonalNameGeoOut. # noqa: E501 :rtype: list[PersonalNameGeoOut] @@ -62,6 +63,7 @@ def personal_names(self): def personal_names(self, personal_names): """Sets the personal_names of this BatchPersonalNameGeoOut. + Classified geo names # noqa: E501 :param personal_names: The personal_names of this BatchPersonalNameGeoOut. # noqa: E501 :type: list[PersonalNameGeoOut] diff --git a/openapi_client/models/batch_personal_name_in.py b/openapi_client/models/batch_personal_name_in.py index 5d6317d..71d40f2 100644 --- a/openapi_client/models/batch_personal_name_in.py +++ b/openapi_client/models/batch_personal_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/batch_personal_name_parsed_out.py b/openapi_client/models/batch_personal_name_parsed_out.py index e44031b..6a17f20 100644 --- a/openapi_client/models/batch_personal_name_parsed_out.py +++ b/openapi_client/models/batch_personal_name_parsed_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -52,6 +52,7 @@ def __init__(self, personal_names=None): # noqa: E501 def personal_names(self): """Gets the personal_names of this BatchPersonalNameParsedOut. # noqa: E501 + Classified parsed names # noqa: E501 :return: The personal_names of this BatchPersonalNameParsedOut. # noqa: E501 :rtype: list[PersonalNameParsedOut] @@ -62,6 +63,7 @@ def personal_names(self): def personal_names(self, personal_names): """Sets the personal_names of this BatchPersonalNameParsedOut. + Classified parsed names # noqa: E501 :param personal_names: The personal_names of this BatchPersonalNameParsedOut. # noqa: E501 :type: list[PersonalNameParsedOut] diff --git a/openapi_client/models/batch_proper_noun_categorized_out.py b/openapi_client/models/batch_proper_noun_categorized_out.py index e182a5b..4d2603c 100644 --- a/openapi_client/models/batch_proper_noun_categorized_out.py +++ b/openapi_client/models/batch_proper_noun_categorized_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -52,6 +52,7 @@ def __init__(self, proper_nouns=None): # noqa: E501 def proper_nouns(self): """Gets the proper_nouns of this BatchProperNounCategorizedOut. # noqa: E501 + Classified typed proper names # noqa: E501 :return: The proper_nouns of this BatchProperNounCategorizedOut. # noqa: E501 :rtype: list[ProperNounCategorizedOut] @@ -62,6 +63,7 @@ def proper_nouns(self): def proper_nouns(self, proper_nouns): """Sets the proper_nouns of this BatchProperNounCategorizedOut. + Classified typed proper names # noqa: E501 :param proper_nouns: The proper_nouns of this BatchProperNounCategorizedOut. # noqa: E501 :type: list[ProperNounCategorizedOut] diff --git a/openapi_client/models/corridor_in.py b/openapi_client/models/corridor_in.py index bd8362c..0ae0abe 100644 --- a/openapi_client/models/corridor_in.py +++ b/openapi_client/models/corridor_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/corridor_out.py b/openapi_client/models/corridor_out.py index 5d7436d..a3f78dd 100644 --- a/openapi_client/models/corridor_out.py +++ b/openapi_client/models/corridor_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -36,8 +36,7 @@ class CorridorOut(object): 'first_last_name_gendered_out': 'FirstLastNameGenderedOut', 'first_last_name_origined_out': 'FirstLastNameOriginedOut', 'first_last_name_diasporaed_out': 'FirstLastNameDiasporaedOut', - 'script': 'str', - 'category': 'str' + 'script': 'str' } attribute_map = { @@ -45,11 +44,10 @@ class CorridorOut(object): 'first_last_name_gendered_out': 'FirstLastNameGenderedOut', 'first_last_name_origined_out': 'FirstLastNameOriginedOut', 'first_last_name_diasporaed_out': 'FirstLastNameDiasporaedOut', - 'script': 'script', - 'category': 'category' + 'script': 'script' } - def __init__(self, id=None, first_last_name_gendered_out=None, first_last_name_origined_out=None, first_last_name_diasporaed_out=None, script=None, category=None): # noqa: E501 + def __init__(self, id=None, first_last_name_gendered_out=None, first_last_name_origined_out=None, first_last_name_diasporaed_out=None, script=None): # noqa: E501 """CorridorOut - a model defined in OpenAPI""" # noqa: E501 self._id = None @@ -57,7 +55,6 @@ def __init__(self, id=None, first_last_name_gendered_out=None, first_last_name_o self._first_last_name_origined_out = None self._first_last_name_diasporaed_out = None self._script = None - self._category = None self.discriminator = None if id is not None: @@ -70,8 +67,6 @@ def __init__(self, id=None, first_last_name_gendered_out=None, first_last_name_o self.first_last_name_diasporaed_out = first_last_name_diasporaed_out if script is not None: self.script = script - if category is not None: - self.category = category @property def id(self): @@ -178,27 +173,6 @@ def script(self, script): self._script = script - @property - def category(self): - """Gets the category of this CorridorOut. # noqa: E501 - - - :return: The category of this CorridorOut. # noqa: E501 - :rtype: str - """ - return self._category - - @category.setter - def category(self, category): - """Sets the category of this CorridorOut. - - - :param category: The category of this CorridorOut. # noqa: E501 - :type: str - """ - - self._category = category - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/openapi_client/models/feedback_loop_out.py b/openapi_client/models/feedback_loop_out.py index d331339..d3cb357 100644 --- a/openapi_client/models/feedback_loop_out.py +++ b/openapi_client/models/feedback_loop_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -52,6 +52,7 @@ def __init__(self, feedback_credits=None): # noqa: E501 def feedback_credits(self): """Gets the feedback_credits of this FeedbackLoopOut. # noqa: E501 + Number of units recredited as per feedback loop successful classification # noqa: E501 :return: The feedback_credits of this FeedbackLoopOut. # noqa: E501 :rtype: int @@ -62,6 +63,7 @@ def feedback_credits(self): def feedback_credits(self, feedback_credits): """Sets the feedback_credits of this FeedbackLoopOut. + Number of units recredited as per feedback loop successful classification # noqa: E501 :param feedback_credits: The feedback_credits of this FeedbackLoopOut. # noqa: E501 :type: int diff --git a/openapi_client/models/first_last_name_diasporaed_out.py b/openapi_client/models/first_last_name_diasporaed_out.py index f2c363e..ee75c3d 100644 --- a/openapi_client/models/first_last_name_diasporaed_out.py +++ b/openapi_client/models/first_last_name_diasporaed_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -41,8 +41,7 @@ class FirstLastNameDiasporaedOut(object): 'ethnicity': 'str', 'lifted': 'bool', 'country_iso2': 'str', - 'ethnicities_top': 'list[str]', - 'category': 'str' + 'ethnicities_top': 'list[str]' } attribute_map = { @@ -55,11 +54,10 @@ class FirstLastNameDiasporaedOut(object): 'ethnicity': 'ethnicity', 'lifted': 'lifted', 'country_iso2': 'countryIso2', - 'ethnicities_top': 'ethnicitiesTop', - 'category': 'category' + 'ethnicities_top': 'ethnicitiesTop' } - def __init__(self, script=None, id=None, first_name=None, last_name=None, score=None, ethnicity_alt=None, ethnicity=None, lifted=None, country_iso2=None, ethnicities_top=None, category=None): # noqa: E501 + def __init__(self, script=None, id=None, first_name=None, last_name=None, score=None, ethnicity_alt=None, ethnicity=None, lifted=None, country_iso2=None, ethnicities_top=None): # noqa: E501 """FirstLastNameDiasporaedOut - a model defined in OpenAPI""" # noqa: E501 self._script = None @@ -72,7 +70,6 @@ def __init__(self, script=None, id=None, first_name=None, last_name=None, score= self._lifted = None self._country_iso2 = None self._ethnicities_top = None - self._category = None self.discriminator = None if script is not None: @@ -95,8 +92,6 @@ def __init__(self, script=None, id=None, first_name=None, last_name=None, score= self.country_iso2 = country_iso2 if ethnicities_top is not None: self.ethnicities_top = ethnicities_top - if category is not None: - self.category = category @property def script(self): @@ -144,6 +139,7 @@ def id(self, id): def first_name(self): """Gets the first_name of this FirstLastNameDiasporaedOut. # noqa: E501 + The first name (also known as given name) # noqa: E501 :return: The first_name of this FirstLastNameDiasporaedOut. # noqa: E501 :rtype: str @@ -154,6 +150,7 @@ def first_name(self): def first_name(self, first_name): """Sets the first_name of this FirstLastNameDiasporaedOut. + The first name (also known as given name) # noqa: E501 :param first_name: The first_name of this FirstLastNameDiasporaedOut. # noqa: E501 :type: str @@ -165,6 +162,7 @@ def first_name(self, first_name): def last_name(self): """Gets the last_name of this FirstLastNameDiasporaedOut. # noqa: E501 + The last name (also known as family name, or surname) # noqa: E501 :return: The last_name of this FirstLastNameDiasporaedOut. # noqa: E501 :rtype: str @@ -175,6 +173,7 @@ def last_name(self): def last_name(self, last_name): """Sets the last_name of this FirstLastNameDiasporaedOut. + The last name (also known as family name, or surname) # noqa: E501 :param last_name: The last_name of this FirstLastNameDiasporaedOut. # noqa: E501 :type: str @@ -186,7 +185,7 @@ def last_name(self, last_name): def score(self): """Gets the score of this FirstLastNameDiasporaedOut. # noqa: E501 - Compatibility to NamSor_v1 Origin score value # noqa: E501 + Compatibility to NamSor_v1 Diaspora score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :return: The score of this FirstLastNameDiasporaedOut. # noqa: E501 :rtype: float @@ -197,11 +196,15 @@ def score(self): def score(self, score): """Sets the score of this FirstLastNameDiasporaedOut. - Compatibility to NamSor_v1 Origin score value # noqa: E501 + Compatibility to NamSor_v1 Diaspora score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :param score: The score of this FirstLastNameDiasporaedOut. # noqa: E501 :type: float """ + if score is not None and score > 100: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value less than or equal to `100`") # noqa: E501 + if score is not None and score < 0: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value greater than or equal to `0`") # noqa: E501 self._score = score @@ -209,6 +212,7 @@ def score(self, score): def ethnicity_alt(self): """Gets the ethnicity_alt of this FirstLastNameDiasporaedOut. # noqa: E501 + The second best alternative ethnicity # noqa: E501 :return: The ethnicity_alt of this FirstLastNameDiasporaedOut. # noqa: E501 :rtype: str @@ -219,6 +223,7 @@ def ethnicity_alt(self): def ethnicity_alt(self, ethnicity_alt): """Sets the ethnicity_alt of this FirstLastNameDiasporaedOut. + The second best alternative ethnicity # noqa: E501 :param ethnicity_alt: The ethnicity_alt of this FirstLastNameDiasporaedOut. # noqa: E501 :type: str @@ -230,6 +235,7 @@ def ethnicity_alt(self, ethnicity_alt): def ethnicity(self): """Gets the ethnicity of this FirstLastNameDiasporaedOut. # noqa: E501 + The most likely ethnicity # noqa: E501 :return: The ethnicity of this FirstLastNameDiasporaedOut. # noqa: E501 :rtype: str @@ -240,6 +246,7 @@ def ethnicity(self): def ethnicity(self, ethnicity): """Sets the ethnicity of this FirstLastNameDiasporaedOut. + The most likely ethnicity # noqa: E501 :param ethnicity: The ethnicity of this FirstLastNameDiasporaedOut. # noqa: E501 :type: str @@ -251,6 +258,7 @@ def ethnicity(self, ethnicity): def lifted(self): """Gets the lifted of this FirstLastNameDiasporaedOut. # noqa: E501 + Indicates if the output ethnicity is based on machine learning only, or further lifted as a known fact by a country-specific rule. Let us know if you believe ethnicity is incorrect on a specific case where lifted is true. # noqa: E501 :return: The lifted of this FirstLastNameDiasporaedOut. # noqa: E501 :rtype: bool @@ -261,6 +269,7 @@ def lifted(self): def lifted(self, lifted): """Sets the lifted of this FirstLastNameDiasporaedOut. + Indicates if the output ethnicity is based on machine learning only, or further lifted as a known fact by a country-specific rule. Let us know if you believe ethnicity is incorrect on a specific case where lifted is true. # noqa: E501 :param lifted: The lifted of this FirstLastNameDiasporaedOut. # noqa: E501 :type: bool @@ -272,6 +281,7 @@ def lifted(self, lifted): def country_iso2(self): """Gets the country_iso2 of this FirstLastNameDiasporaedOut. # noqa: E501 + From input data, the countryIso2 of geographic context (US,CA etc.) # noqa: E501 :return: The country_iso2 of this FirstLastNameDiasporaedOut. # noqa: E501 :rtype: str @@ -282,6 +292,7 @@ def country_iso2(self): def country_iso2(self, country_iso2): """Sets the country_iso2 of this FirstLastNameDiasporaedOut. + From input data, the countryIso2 of geographic context (US,CA etc.) # noqa: E501 :param country_iso2: The country_iso2 of this FirstLastNameDiasporaedOut. # noqa: E501 :type: str @@ -293,7 +304,7 @@ def country_iso2(self, country_iso2): def ethnicities_top(self): """Gets the ethnicities_top of this FirstLastNameDiasporaedOut. # noqa: E501 - List ethnicities (top 10) # noqa: E501 + List most likely ethnicities (top 10) # noqa: E501 :return: The ethnicities_top of this FirstLastNameDiasporaedOut. # noqa: E501 :rtype: list[str] @@ -304,7 +315,7 @@ def ethnicities_top(self): def ethnicities_top(self, ethnicities_top): """Sets the ethnicities_top of this FirstLastNameDiasporaedOut. - List ethnicities (top 10) # noqa: E501 + List most likely ethnicities (top 10) # noqa: E501 :param ethnicities_top: The ethnicities_top of this FirstLastNameDiasporaedOut. # noqa: E501 :type: list[str] @@ -312,27 +323,6 @@ def ethnicities_top(self, ethnicities_top): self._ethnicities_top = ethnicities_top - @property - def category(self): - """Gets the category of this FirstLastNameDiasporaedOut. # noqa: E501 - - - :return: The category of this FirstLastNameDiasporaedOut. # noqa: E501 - :rtype: str - """ - return self._category - - @category.setter - def category(self, category): - """Sets the category of this FirstLastNameDiasporaedOut. - - - :param category: The category of this FirstLastNameDiasporaedOut. # noqa: E501 - :type: str - """ - - self._category = category - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/openapi_client/models/first_last_name_gender_in.py b/openapi_client/models/first_last_name_gender_in.py index 2a452b6..de195b6 100644 --- a/openapi_client/models/first_last_name_gender_in.py +++ b/openapi_client/models/first_last_name_gender_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -130,6 +130,7 @@ def last_name(self, last_name): def gender(self): """Gets the gender of this FirstLastNameGenderIn. # noqa: E501 + The known gender of the name # noqa: E501 :return: The gender of this FirstLastNameGenderIn. # noqa: E501 :rtype: str @@ -140,6 +141,7 @@ def gender(self): def gender(self, gender): """Sets the gender of this FirstLastNameGenderIn. + The known gender of the name # noqa: E501 :param gender: The gender of this FirstLastNameGenderIn. # noqa: E501 :type: str diff --git a/openapi_client/models/first_last_name_gendered_out.py b/openapi_client/models/first_last_name_gendered_out.py index 7eda357..0acafa5 100644 --- a/openapi_client/models/first_last_name_gendered_out.py +++ b/openapi_client/models/first_last_name_gendered_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -39,8 +39,7 @@ class FirstLastNameGenderedOut(object): 'likely_gender': 'str', 'gender_scale': 'float', 'score': 'float', - 'probability_calibrated': 'float', - 'category': 'str' + 'probability_calibrated': 'float' } attribute_map = { @@ -51,11 +50,10 @@ class FirstLastNameGenderedOut(object): 'likely_gender': 'likelyGender', 'gender_scale': 'genderScale', 'score': 'score', - 'probability_calibrated': 'probabilityCalibrated', - 'category': 'category' + 'probability_calibrated': 'probabilityCalibrated' } - def __init__(self, script=None, id=None, first_name=None, last_name=None, likely_gender=None, gender_scale=None, score=None, probability_calibrated=None, category=None): # noqa: E501 + def __init__(self, script=None, id=None, first_name=None, last_name=None, likely_gender=None, gender_scale=None, score=None, probability_calibrated=None): # noqa: E501 """FirstLastNameGenderedOut - a model defined in OpenAPI""" # noqa: E501 self._script = None @@ -66,7 +64,6 @@ def __init__(self, script=None, id=None, first_name=None, last_name=None, likely self._gender_scale = None self._score = None self._probability_calibrated = None - self._category = None self.discriminator = None if script is not None: @@ -85,8 +82,6 @@ def __init__(self, script=None, id=None, first_name=None, last_name=None, likely self.score = score if probability_calibrated is not None: self.probability_calibrated = probability_calibrated - if category is not None: - self.category = category @property def script(self): @@ -134,6 +129,7 @@ def id(self, id): def first_name(self): """Gets the first_name of this FirstLastNameGenderedOut. # noqa: E501 + The first name (also known as given name) # noqa: E501 :return: The first_name of this FirstLastNameGenderedOut. # noqa: E501 :rtype: str @@ -144,6 +140,7 @@ def first_name(self): def first_name(self, first_name): """Sets the first_name of this FirstLastNameGenderedOut. + The first name (also known as given name) # noqa: E501 :param first_name: The first_name of this FirstLastNameGenderedOut. # noqa: E501 :type: str @@ -155,6 +152,7 @@ def first_name(self, first_name): def last_name(self): """Gets the last_name of this FirstLastNameGenderedOut. # noqa: E501 + The last name (also known as family name, or surname) # noqa: E501 :return: The last_name of this FirstLastNameGenderedOut. # noqa: E501 :rtype: str @@ -165,6 +163,7 @@ def last_name(self): def last_name(self, last_name): """Sets the last_name of this FirstLastNameGenderedOut. + The last name (also known as family name, or surname) # noqa: E501 :param last_name: The last_name of this FirstLastNameGenderedOut. # noqa: E501 :type: str @@ -228,6 +227,7 @@ def gender_scale(self, gender_scale): def score(self): """Gets the score of this FirstLastNameGenderedOut. # noqa: E501 + Compatibility to NamSor_v1 Gender score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :return: The score of this FirstLastNameGenderedOut. # noqa: E501 :rtype: float @@ -238,10 +238,15 @@ def score(self): def score(self, score): """Sets the score of this FirstLastNameGenderedOut. + Compatibility to NamSor_v1 Gender score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :param score: The score of this FirstLastNameGenderedOut. # noqa: E501 :type: float """ + if score is not None and score > 100: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value less than or equal to `100`") # noqa: E501 + if score is not None and score < 0: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value greater than or equal to `0`") # noqa: E501 self._score = score @@ -249,6 +254,7 @@ def score(self, score): def probability_calibrated(self): """Gets the probability_calibrated of this FirstLastNameGenderedOut. # noqa: E501 + The calibrated probability for inferred gender to have been guessed correctly. # noqa: E501 :return: The probability_calibrated of this FirstLastNameGenderedOut. # noqa: E501 :rtype: float @@ -259,6 +265,7 @@ def probability_calibrated(self): def probability_calibrated(self, probability_calibrated): """Sets the probability_calibrated of this FirstLastNameGenderedOut. + The calibrated probability for inferred gender to have been guessed correctly. # noqa: E501 :param probability_calibrated: The probability_calibrated of this FirstLastNameGenderedOut. # noqa: E501 :type: float @@ -266,27 +273,6 @@ def probability_calibrated(self, probability_calibrated): self._probability_calibrated = probability_calibrated - @property - def category(self): - """Gets the category of this FirstLastNameGenderedOut. # noqa: E501 - - - :return: The category of this FirstLastNameGenderedOut. # noqa: E501 - :rtype: str - """ - return self._category - - @category.setter - def category(self, category): - """Sets the category of this FirstLastNameGenderedOut. - - - :param category: The category of this FirstLastNameGenderedOut. # noqa: E501 - :type: str - """ - - self._category = category - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/openapi_client/models/first_last_name_geo_in.py b/openapi_client/models/first_last_name_geo_in.py index fc102cb..d56131d 100644 --- a/openapi_client/models/first_last_name_geo_in.py +++ b/openapi_client/models/first_last_name_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/first_last_name_geo_zipped_in.py b/openapi_client/models/first_last_name_geo_zipped_in.py index 240451d..95340ca 100644 --- a/openapi_client/models/first_last_name_geo_zipped_in.py +++ b/openapi_client/models/first_last_name_geo_zipped_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/first_last_name_in.py b/openapi_client/models/first_last_name_in.py index 2ce14dc..0a65dbb 100644 --- a/openapi_client/models/first_last_name_in.py +++ b/openapi_client/models/first_last_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/first_last_name_origined_out.py b/openapi_client/models/first_last_name_origined_out.py index e7a233f..0546d9f 100644 --- a/openapi_client/models/first_last_name_origined_out.py +++ b/openapi_client/models/first_last_name_origined_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -44,8 +44,7 @@ class FirstLastNameOriginedOut(object): 'top_region_origin': 'str', 'sub_region_origin': 'str', 'probability_calibrated': 'float', - 'probability_alt_calibrated': 'float', - 'category': 'str' + 'probability_alt_calibrated': 'float' } attribute_map = { @@ -61,11 +60,10 @@ class FirstLastNameOriginedOut(object): 'top_region_origin': 'topRegionOrigin', 'sub_region_origin': 'subRegionOrigin', 'probability_calibrated': 'probabilityCalibrated', - 'probability_alt_calibrated': 'probabilityAltCalibrated', - 'category': 'category' + 'probability_alt_calibrated': 'probabilityAltCalibrated' } - def __init__(self, script=None, id=None, first_name=None, last_name=None, country_origin=None, country_origin_alt=None, countries_origin_top=None, score=None, region_origin=None, top_region_origin=None, sub_region_origin=None, probability_calibrated=None, probability_alt_calibrated=None, category=None): # noqa: E501 + def __init__(self, script=None, id=None, first_name=None, last_name=None, country_origin=None, country_origin_alt=None, countries_origin_top=None, score=None, region_origin=None, top_region_origin=None, sub_region_origin=None, probability_calibrated=None, probability_alt_calibrated=None): # noqa: E501 """FirstLastNameOriginedOut - a model defined in OpenAPI""" # noqa: E501 self._script = None @@ -81,7 +79,6 @@ def __init__(self, script=None, id=None, first_name=None, last_name=None, countr self._sub_region_origin = None self._probability_calibrated = None self._probability_alt_calibrated = None - self._category = None self.discriminator = None if script is not None: @@ -110,8 +107,6 @@ def __init__(self, script=None, id=None, first_name=None, last_name=None, countr self.probability_calibrated = probability_calibrated if probability_alt_calibrated is not None: self.probability_alt_calibrated = probability_alt_calibrated - if category is not None: - self.category = category @property def script(self): @@ -159,6 +154,7 @@ def id(self, id): def first_name(self): """Gets the first_name of this FirstLastNameOriginedOut. # noqa: E501 + The first name (also known as given name) # noqa: E501 :return: The first_name of this FirstLastNameOriginedOut. # noqa: E501 :rtype: str @@ -169,6 +165,7 @@ def first_name(self): def first_name(self, first_name): """Sets the first_name of this FirstLastNameOriginedOut. + The first name (also known as given name) # noqa: E501 :param first_name: The first_name of this FirstLastNameOriginedOut. # noqa: E501 :type: str @@ -180,6 +177,7 @@ def first_name(self, first_name): def last_name(self): """Gets the last_name of this FirstLastNameOriginedOut. # noqa: E501 + The last name (also known as family name, or surname) # noqa: E501 :return: The last_name of this FirstLastNameOriginedOut. # noqa: E501 :rtype: str @@ -190,6 +188,7 @@ def last_name(self): def last_name(self, last_name): """Sets the last_name of this FirstLastNameOriginedOut. + The last name (also known as family name, or surname) # noqa: E501 :param last_name: The last_name of this FirstLastNameOriginedOut. # noqa: E501 :type: str @@ -270,7 +269,7 @@ def countries_origin_top(self, countries_origin_top): def score(self): """Gets the score of this FirstLastNameOriginedOut. # noqa: E501 - Compatibility to NamSor_v1 Origin score value # noqa: E501 + Compatibility to NamSor_v1 Origin score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :return: The score of this FirstLastNameOriginedOut. # noqa: E501 :rtype: float @@ -281,11 +280,15 @@ def score(self): def score(self, score): """Sets the score of this FirstLastNameOriginedOut. - Compatibility to NamSor_v1 Origin score value # noqa: E501 + Compatibility to NamSor_v1 Origin score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :param score: The score of this FirstLastNameOriginedOut. # noqa: E501 :type: float """ + if score is not None and score > 100: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value less than or equal to `100`") # noqa: E501 + if score is not None and score < 0: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value greater than or equal to `0`") # noqa: E501 self._score = score @@ -316,7 +319,7 @@ def region_origin(self, region_origin): def top_region_origin(self): """Gets the top_region_origin of this FirstLastNameOriginedOut. # noqa: E501 - Most likely region of Origin (based on countryOrigin ISO2 code) # noqa: E501 + Most likely top region of Origin (based on countryOrigin ISO2 code) # noqa: E501 :return: The top_region_origin of this FirstLastNameOriginedOut. # noqa: E501 :rtype: str @@ -327,7 +330,7 @@ def top_region_origin(self): def top_region_origin(self, top_region_origin): """Sets the top_region_origin of this FirstLastNameOriginedOut. - Most likely region of Origin (based on countryOrigin ISO2 code) # noqa: E501 + Most likely top region of Origin (based on countryOrigin ISO2 code) # noqa: E501 :param top_region_origin: The top_region_origin of this FirstLastNameOriginedOut. # noqa: E501 :type: str @@ -339,7 +342,7 @@ def top_region_origin(self, top_region_origin): def sub_region_origin(self): """Gets the sub_region_origin of this FirstLastNameOriginedOut. # noqa: E501 - Most likely region of Origin (based on countryOrigin ISO2 code) # noqa: E501 + Most likely sub region of Origin (based on countryOrigin ISO2 code) # noqa: E501 :return: The sub_region_origin of this FirstLastNameOriginedOut. # noqa: E501 :rtype: str @@ -350,7 +353,7 @@ def sub_region_origin(self): def sub_region_origin(self, sub_region_origin): """Sets the sub_region_origin of this FirstLastNameOriginedOut. - Most likely region of Origin (based on countryOrigin ISO2 code) # noqa: E501 + Most likely sub region of Origin (based on countryOrigin ISO2 code) # noqa: E501 :param sub_region_origin: The sub_region_origin of this FirstLastNameOriginedOut. # noqa: E501 :type: str @@ -362,6 +365,7 @@ def sub_region_origin(self, sub_region_origin): def probability_calibrated(self): """Gets the probability_calibrated of this FirstLastNameOriginedOut. # noqa: E501 + The calibrated probability for countryOrigin to have been guessed correctly. # noqa: E501 :return: The probability_calibrated of this FirstLastNameOriginedOut. # noqa: E501 :rtype: float @@ -372,6 +376,7 @@ def probability_calibrated(self): def probability_calibrated(self, probability_calibrated): """Sets the probability_calibrated of this FirstLastNameOriginedOut. + The calibrated probability for countryOrigin to have been guessed correctly. # noqa: E501 :param probability_calibrated: The probability_calibrated of this FirstLastNameOriginedOut. # noqa: E501 :type: float @@ -383,6 +388,7 @@ def probability_calibrated(self, probability_calibrated): def probability_alt_calibrated(self): """Gets the probability_alt_calibrated of this FirstLastNameOriginedOut. # noqa: E501 + The calibrated probability for countryOrigin OR countryOriginAlt to have been guessed correctly. # noqa: E501 :return: The probability_alt_calibrated of this FirstLastNameOriginedOut. # noqa: E501 :rtype: float @@ -393,6 +399,7 @@ def probability_alt_calibrated(self): def probability_alt_calibrated(self, probability_alt_calibrated): """Sets the probability_alt_calibrated of this FirstLastNameOriginedOut. + The calibrated probability for countryOrigin OR countryOriginAlt to have been guessed correctly. # noqa: E501 :param probability_alt_calibrated: The probability_alt_calibrated of this FirstLastNameOriginedOut. # noqa: E501 :type: float @@ -400,27 +407,6 @@ def probability_alt_calibrated(self, probability_alt_calibrated): self._probability_alt_calibrated = probability_alt_calibrated - @property - def category(self): - """Gets the category of this FirstLastNameOriginedOut. # noqa: E501 - - - :return: The category of this FirstLastNameOriginedOut. # noqa: E501 - :rtype: str - """ - return self._category - - @category.setter - def category(self, category): - """Sets the category of this FirstLastNameOriginedOut. - - - :param category: The category of this FirstLastNameOriginedOut. # noqa: E501 - :type: str - """ - - self._category = category - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/openapi_client/models/first_last_name_out.py b/openapi_client/models/first_last_name_out.py index e8ff03b..4cf8a70 100644 --- a/openapi_client/models/first_last_name_out.py +++ b/openapi_client/models/first_last_name_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -35,26 +35,23 @@ class FirstLastNameOut(object): 'script': 'str', 'id': 'str', 'first_name': 'str', - 'last_name': 'str', - 'category': 'str' + 'last_name': 'str' } attribute_map = { 'script': 'script', 'id': 'id', 'first_name': 'firstName', - 'last_name': 'lastName', - 'category': 'category' + 'last_name': 'lastName' } - def __init__(self, script=None, id=None, first_name=None, last_name=None, category=None): # noqa: E501 + def __init__(self, script=None, id=None, first_name=None, last_name=None): # noqa: E501 """FirstLastNameOut - a model defined in OpenAPI""" # noqa: E501 self._script = None self._id = None self._first_name = None self._last_name = None - self._category = None self.discriminator = None if script is not None: @@ -65,8 +62,6 @@ def __init__(self, script=None, id=None, first_name=None, last_name=None, catego self.first_name = first_name if last_name is not None: self.last_name = last_name - if category is not None: - self.category = category @property def script(self): @@ -114,6 +109,7 @@ def id(self, id): def first_name(self): """Gets the first_name of this FirstLastNameOut. # noqa: E501 + The first name (also known as given name) # noqa: E501 :return: The first_name of this FirstLastNameOut. # noqa: E501 :rtype: str @@ -124,6 +120,7 @@ def first_name(self): def first_name(self, first_name): """Sets the first_name of this FirstLastNameOut. + The first name (also known as given name) # noqa: E501 :param first_name: The first_name of this FirstLastNameOut. # noqa: E501 :type: str @@ -135,6 +132,7 @@ def first_name(self, first_name): def last_name(self): """Gets the last_name of this FirstLastNameOut. # noqa: E501 + The last name (also known as family name, or surname) # noqa: E501 :return: The last_name of this FirstLastNameOut. # noqa: E501 :rtype: str @@ -145,6 +143,7 @@ def last_name(self): def last_name(self, last_name): """Sets the last_name of this FirstLastNameOut. + The last name (also known as family name, or surname) # noqa: E501 :param last_name: The last_name of this FirstLastNameOut. # noqa: E501 :type: str @@ -152,27 +151,6 @@ def last_name(self, last_name): self._last_name = last_name - @property - def category(self): - """Gets the category of this FirstLastNameOut. # noqa: E501 - - - :return: The category of this FirstLastNameOut. # noqa: E501 - :rtype: str - """ - return self._category - - @category.setter - def category(self, category): - """Sets the category of this FirstLastNameOut. - - - :param category: The category of this FirstLastNameOut. # noqa: E501 - :type: str - """ - - self._category = category - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/openapi_client/models/first_last_name_phone_coded_out.py b/openapi_client/models/first_last_name_phone_coded_out.py index 35a793b..b0b7740 100644 --- a/openapi_client/models/first_last_name_phone_coded_out.py +++ b/openapi_client/models/first_last_name_phone_coded_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -47,8 +47,7 @@ class FirstLastNamePhoneCodedOut(object): 'phone_number': 'str', 'verified': 'bool', 'score': 'float', - 'country_iso2': 'str', - 'category': 'str' + 'country_iso2': 'str' } attribute_map = { @@ -67,11 +66,10 @@ class FirstLastNamePhoneCodedOut(object): 'phone_number': 'phoneNumber', 'verified': 'verified', 'score': 'score', - 'country_iso2': 'countryIso2', - 'category': 'category' + 'country_iso2': 'countryIso2' } - def __init__(self, script=None, id=None, first_name=None, last_name=None, international_phone_number_verified=None, phone_country_iso2_verified=None, phone_country_code=None, phone_country_code_alt=None, phone_country_iso2=None, phone_country_iso2_alt=None, origin_country_iso2=None, origin_country_iso2_alt=None, phone_number=None, verified=None, score=None, country_iso2=None, category=None): # noqa: E501 + def __init__(self, script=None, id=None, first_name=None, last_name=None, international_phone_number_verified=None, phone_country_iso2_verified=None, phone_country_code=None, phone_country_code_alt=None, phone_country_iso2=None, phone_country_iso2_alt=None, origin_country_iso2=None, origin_country_iso2_alt=None, phone_number=None, verified=None, score=None, country_iso2=None): # noqa: E501 """FirstLastNamePhoneCodedOut - a model defined in OpenAPI""" # noqa: E501 self._script = None @@ -90,7 +88,6 @@ def __init__(self, script=None, id=None, first_name=None, last_name=None, intern self._verified = None self._score = None self._country_iso2 = None - self._category = None self.discriminator = None if script is not None: @@ -125,8 +122,6 @@ def __init__(self, script=None, id=None, first_name=None, last_name=None, intern self.score = score if country_iso2 is not None: self.country_iso2 = country_iso2 - if category is not None: - self.category = category @property def script(self): @@ -174,6 +169,7 @@ def id(self, id): def first_name(self): """Gets the first_name of this FirstLastNamePhoneCodedOut. # noqa: E501 + The first name (also known as given name) # noqa: E501 :return: The first_name of this FirstLastNamePhoneCodedOut. # noqa: E501 :rtype: str @@ -184,6 +180,7 @@ def first_name(self): def first_name(self, first_name): """Sets the first_name of this FirstLastNamePhoneCodedOut. + The first name (also known as given name) # noqa: E501 :param first_name: The first_name of this FirstLastNamePhoneCodedOut. # noqa: E501 :type: str @@ -195,6 +192,7 @@ def first_name(self, first_name): def last_name(self): """Gets the last_name of this FirstLastNamePhoneCodedOut. # noqa: E501 + The last name (also known as family name, or surname) # noqa: E501 :return: The last_name of this FirstLastNamePhoneCodedOut. # noqa: E501 :rtype: str @@ -205,6 +203,7 @@ def last_name(self): def last_name(self, last_name): """Sets the last_name of this FirstLastNamePhoneCodedOut. + The last name (also known as family name, or surname) # noqa: E501 :param last_name: The last_name of this FirstLastNamePhoneCodedOut. # noqa: E501 :type: str @@ -216,6 +215,7 @@ def last_name(self, last_name): def international_phone_number_verified(self): """Gets the international_phone_number_verified of this FirstLastNamePhoneCodedOut. # noqa: E501 + The normalized phone number, verified using libphonenumber. # noqa: E501 :return: The international_phone_number_verified of this FirstLastNamePhoneCodedOut. # noqa: E501 :rtype: str @@ -226,6 +226,7 @@ def international_phone_number_verified(self): def international_phone_number_verified(self, international_phone_number_verified): """Sets the international_phone_number_verified of this FirstLastNamePhoneCodedOut. + The normalized phone number, verified using libphonenumber. # noqa: E501 :param international_phone_number_verified: The international_phone_number_verified of this FirstLastNamePhoneCodedOut. # noqa: E501 :type: str @@ -237,6 +238,7 @@ def international_phone_number_verified(self, international_phone_number_verifie def phone_country_iso2_verified(self): """Gets the phone_country_iso2_verified of this FirstLastNamePhoneCodedOut. # noqa: E501 + The phone ISO2 country code, verified using libphonenumber. # noqa: E501 :return: The phone_country_iso2_verified of this FirstLastNamePhoneCodedOut. # noqa: E501 :rtype: str @@ -247,6 +249,7 @@ def phone_country_iso2_verified(self): def phone_country_iso2_verified(self, phone_country_iso2_verified): """Sets the phone_country_iso2_verified of this FirstLastNamePhoneCodedOut. + The phone ISO2 country code, verified using libphonenumber. # noqa: E501 :param phone_country_iso2_verified: The phone_country_iso2_verified of this FirstLastNamePhoneCodedOut. # noqa: E501 :type: str @@ -258,6 +261,7 @@ def phone_country_iso2_verified(self, phone_country_iso2_verified): def phone_country_code(self): """Gets the phone_country_code of this FirstLastNamePhoneCodedOut. # noqa: E501 + The phone country code of the phone number, verified using libphonenumber. # noqa: E501 :return: The phone_country_code of this FirstLastNamePhoneCodedOut. # noqa: E501 :rtype: int @@ -268,6 +272,7 @@ def phone_country_code(self): def phone_country_code(self, phone_country_code): """Sets the phone_country_code of this FirstLastNamePhoneCodedOut. + The phone country code of the phone number, verified using libphonenumber. # noqa: E501 :param phone_country_code: The phone_country_code of this FirstLastNamePhoneCodedOut. # noqa: E501 :type: int @@ -279,6 +284,7 @@ def phone_country_code(self, phone_country_code): def phone_country_code_alt(self): """Gets the phone_country_code_alt of this FirstLastNamePhoneCodedOut. # noqa: E501 + The best alternative phone country code of the phone number. # noqa: E501 :return: The phone_country_code_alt of this FirstLastNamePhoneCodedOut. # noqa: E501 :rtype: int @@ -289,6 +295,7 @@ def phone_country_code_alt(self): def phone_country_code_alt(self, phone_country_code_alt): """Sets the phone_country_code_alt of this FirstLastNamePhoneCodedOut. + The best alternative phone country code of the phone number. # noqa: E501 :param phone_country_code_alt: The phone_country_code_alt of this FirstLastNamePhoneCodedOut. # noqa: E501 :type: int @@ -300,6 +307,7 @@ def phone_country_code_alt(self, phone_country_code_alt): def phone_country_iso2(self): """Gets the phone_country_iso2 of this FirstLastNamePhoneCodedOut. # noqa: E501 + The likely country of the phone number. # noqa: E501 :return: The phone_country_iso2 of this FirstLastNamePhoneCodedOut. # noqa: E501 :rtype: str @@ -310,6 +318,7 @@ def phone_country_iso2(self): def phone_country_iso2(self, phone_country_iso2): """Sets the phone_country_iso2 of this FirstLastNamePhoneCodedOut. + The likely country of the phone number. # noqa: E501 :param phone_country_iso2: The phone_country_iso2 of this FirstLastNamePhoneCodedOut. # noqa: E501 :type: str @@ -321,6 +330,7 @@ def phone_country_iso2(self, phone_country_iso2): def phone_country_iso2_alt(self): """Gets the phone_country_iso2_alt of this FirstLastNamePhoneCodedOut. # noqa: E501 + The best alternative country of the phone number. # noqa: E501 :return: The phone_country_iso2_alt of this FirstLastNamePhoneCodedOut. # noqa: E501 :rtype: str @@ -331,6 +341,7 @@ def phone_country_iso2_alt(self): def phone_country_iso2_alt(self, phone_country_iso2_alt): """Sets the phone_country_iso2_alt of this FirstLastNamePhoneCodedOut. + The best alternative country of the phone number. # noqa: E501 :param phone_country_iso2_alt: The phone_country_iso2_alt of this FirstLastNamePhoneCodedOut. # noqa: E501 :type: str @@ -342,6 +353,7 @@ def phone_country_iso2_alt(self, phone_country_iso2_alt): def origin_country_iso2(self): """Gets the origin_country_iso2 of this FirstLastNamePhoneCodedOut. # noqa: E501 + The likely country of origin of the name. # noqa: E501 :return: The origin_country_iso2 of this FirstLastNamePhoneCodedOut. # noqa: E501 :rtype: str @@ -352,6 +364,7 @@ def origin_country_iso2(self): def origin_country_iso2(self, origin_country_iso2): """Sets the origin_country_iso2 of this FirstLastNamePhoneCodedOut. + The likely country of origin of the name. # noqa: E501 :param origin_country_iso2: The origin_country_iso2 of this FirstLastNamePhoneCodedOut. # noqa: E501 :type: str @@ -363,6 +376,7 @@ def origin_country_iso2(self, origin_country_iso2): def origin_country_iso2_alt(self): """Gets the origin_country_iso2_alt of this FirstLastNamePhoneCodedOut. # noqa: E501 + The best alternative country of origin of the name. # noqa: E501 :return: The origin_country_iso2_alt of this FirstLastNamePhoneCodedOut. # noqa: E501 :rtype: str @@ -373,6 +387,7 @@ def origin_country_iso2_alt(self): def origin_country_iso2_alt(self, origin_country_iso2_alt): """Sets the origin_country_iso2_alt of this FirstLastNamePhoneCodedOut. + The best alternative country of origin of the name. # noqa: E501 :param origin_country_iso2_alt: The origin_country_iso2_alt of this FirstLastNamePhoneCodedOut. # noqa: E501 :type: str @@ -384,6 +399,7 @@ def origin_country_iso2_alt(self, origin_country_iso2_alt): def phone_number(self): """Gets the phone_number of this FirstLastNamePhoneCodedOut. # noqa: E501 + The input phone number. # noqa: E501 :return: The phone_number of this FirstLastNamePhoneCodedOut. # noqa: E501 :rtype: str @@ -394,6 +410,7 @@ def phone_number(self): def phone_number(self, phone_number): """Sets the phone_number of this FirstLastNamePhoneCodedOut. + The input phone number. # noqa: E501 :param phone_number: The phone_number of this FirstLastNamePhoneCodedOut. # noqa: E501 :type: str @@ -405,6 +422,7 @@ def phone_number(self, phone_number): def verified(self): """Gets the verified of this FirstLastNamePhoneCodedOut. # noqa: E501 + Indicates if the phone number could be positively verified using libphonenumber. # noqa: E501 :return: The verified of this FirstLastNamePhoneCodedOut. # noqa: E501 :rtype: bool @@ -415,6 +433,7 @@ def verified(self): def verified(self, verified): """Sets the verified of this FirstLastNamePhoneCodedOut. + Indicates if the phone number could be positively verified using libphonenumber. # noqa: E501 :param verified: The verified of this FirstLastNamePhoneCodedOut. # noqa: E501 :type: bool @@ -426,6 +445,7 @@ def verified(self, verified): def score(self): """Gets the score of this FirstLastNamePhoneCodedOut. # noqa: E501 + Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :return: The score of this FirstLastNamePhoneCodedOut. # noqa: E501 :rtype: float @@ -436,10 +456,15 @@ def score(self): def score(self, score): """Sets the score of this FirstLastNamePhoneCodedOut. + Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :param score: The score of this FirstLastNamePhoneCodedOut. # noqa: E501 :type: float """ + if score is not None and score > 100: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value less than or equal to `100`") # noqa: E501 + if score is not None and score < 0: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value greater than or equal to `0`") # noqa: E501 self._score = score @@ -464,27 +489,6 @@ def country_iso2(self, country_iso2): self._country_iso2 = country_iso2 - @property - def category(self): - """Gets the category of this FirstLastNamePhoneCodedOut. # noqa: E501 - - - :return: The category of this FirstLastNamePhoneCodedOut. # noqa: E501 - :rtype: str - """ - return self._category - - @category.setter - def category(self, category): - """Sets the category of this FirstLastNamePhoneCodedOut. - - - :param category: The category of this FirstLastNamePhoneCodedOut. # noqa: E501 - :type: str - """ - - self._category = category - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/openapi_client/models/first_last_name_phone_number_geo_in.py b/openapi_client/models/first_last_name_phone_number_geo_in.py index 3605b40..32717d1 100644 --- a/openapi_client/models/first_last_name_phone_number_geo_in.py +++ b/openapi_client/models/first_last_name_phone_number_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/first_last_name_phone_number_in.py b/openapi_client/models/first_last_name_phone_number_in.py index a2c0413..30ed339 100644 --- a/openapi_client/models/first_last_name_phone_number_in.py +++ b/openapi_client/models/first_last_name_phone_number_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/first_last_name_us_race_ethnicity_out.py b/openapi_client/models/first_last_name_us_race_ethnicity_out.py index a6debc1..d023413 100644 --- a/openapi_client/models/first_last_name_us_race_ethnicity_out.py +++ b/openapi_client/models/first_last_name_us_race_ethnicity_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -41,8 +41,7 @@ class FirstLastNameUSRaceEthnicityOut(object): 'score': 'float', 'race_ethnicities_top': 'list[str]', 'probability_calibrated': 'float', - 'probability_alt_calibrated': 'float', - 'category': 'str' + 'probability_alt_calibrated': 'float' } attribute_map = { @@ -55,11 +54,10 @@ class FirstLastNameUSRaceEthnicityOut(object): 'score': 'score', 'race_ethnicities_top': 'raceEthnicitiesTop', 'probability_calibrated': 'probabilityCalibrated', - 'probability_alt_calibrated': 'probabilityAltCalibrated', - 'category': 'category' + 'probability_alt_calibrated': 'probabilityAltCalibrated' } - def __init__(self, script=None, id=None, first_name=None, last_name=None, race_ethnicity_alt=None, race_ethnicity=None, score=None, race_ethnicities_top=None, probability_calibrated=None, probability_alt_calibrated=None, category=None): # noqa: E501 + def __init__(self, script=None, id=None, first_name=None, last_name=None, race_ethnicity_alt=None, race_ethnicity=None, score=None, race_ethnicities_top=None, probability_calibrated=None, probability_alt_calibrated=None): # noqa: E501 """FirstLastNameUSRaceEthnicityOut - a model defined in OpenAPI""" # noqa: E501 self._script = None @@ -72,7 +70,6 @@ def __init__(self, script=None, id=None, first_name=None, last_name=None, race_e self._race_ethnicities_top = None self._probability_calibrated = None self._probability_alt_calibrated = None - self._category = None self.discriminator = None if script is not None: @@ -95,8 +92,6 @@ def __init__(self, script=None, id=None, first_name=None, last_name=None, race_e self.probability_calibrated = probability_calibrated if probability_alt_calibrated is not None: self.probability_alt_calibrated = probability_alt_calibrated - if category is not None: - self.category = category @property def script(self): @@ -144,6 +139,7 @@ def id(self, id): def first_name(self): """Gets the first_name of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 + The first name (also known as given name) # noqa: E501 :return: The first_name of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 :rtype: str @@ -154,6 +150,7 @@ def first_name(self): def first_name(self, first_name): """Sets the first_name of this FirstLastNameUSRaceEthnicityOut. + The first name (also known as given name) # noqa: E501 :param first_name: The first_name of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 :type: str @@ -165,6 +162,7 @@ def first_name(self, first_name): def last_name(self): """Gets the last_name of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 + The last name (also known as family name, or surname) # noqa: E501 :return: The last_name of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 :rtype: str @@ -175,6 +173,7 @@ def last_name(self): def last_name(self, last_name): """Sets the last_name of this FirstLastNameUSRaceEthnicityOut. + The last name (also known as family name, or surname) # noqa: E501 :param last_name: The last_name of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 :type: str @@ -202,7 +201,7 @@ def race_ethnicity_alt(self, race_ethnicity_alt): :param race_ethnicity_alt: The race_ethnicity_alt of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 :type: str """ - allowed_values = ["W_NL", "HL", "A", "B_NL"] # noqa: E501 + allowed_values = ["W_NL", "HL", "A", "B_NL", "AI_AN", "PI"] # noqa: E501 if race_ethnicity_alt not in allowed_values: raise ValueError( "Invalid value for `race_ethnicity_alt` ({0}), must be one of {1}" # noqa: E501 @@ -231,7 +230,7 @@ def race_ethnicity(self, race_ethnicity): :param race_ethnicity: The race_ethnicity of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 :type: str """ - allowed_values = ["W_NL", "HL", "A", "B_NL"] # noqa: E501 + allowed_values = ["W_NL", "HL", "A", "B_NL", "AI_AN", "PI"] # noqa: E501 if race_ethnicity not in allowed_values: raise ValueError( "Invalid value for `race_ethnicity` ({0}), must be one of {1}" # noqa: E501 @@ -244,7 +243,7 @@ def race_ethnicity(self, race_ethnicity): def score(self): """Gets the score of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 - Compatibility to NamSor_v1 Origin score value # noqa: E501 + Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :return: The score of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 :rtype: float @@ -255,11 +254,15 @@ def score(self): def score(self, score): """Sets the score of this FirstLastNameUSRaceEthnicityOut. - Compatibility to NamSor_v1 Origin score value # noqa: E501 + Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :param score: The score of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 :type: float """ + if score is not None and score > 100: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value less than or equal to `100`") # noqa: E501 + if score is not None and score < 0: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value greater than or equal to `0`") # noqa: E501 self._score = score @@ -290,6 +293,7 @@ def race_ethnicities_top(self, race_ethnicities_top): def probability_calibrated(self): """Gets the probability_calibrated of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 + The calibrated probability for raceEthnicity to have been guessed correctly. # noqa: E501 :return: The probability_calibrated of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 :rtype: float @@ -300,6 +304,7 @@ def probability_calibrated(self): def probability_calibrated(self, probability_calibrated): """Sets the probability_calibrated of this FirstLastNameUSRaceEthnicityOut. + The calibrated probability for raceEthnicity to have been guessed correctly. # noqa: E501 :param probability_calibrated: The probability_calibrated of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 :type: float @@ -311,6 +316,7 @@ def probability_calibrated(self, probability_calibrated): def probability_alt_calibrated(self): """Gets the probability_alt_calibrated of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 + The calibrated probability for raceEthnicity OR raceEthnicityAlt to have been guessed correctly. # noqa: E501 :return: The probability_alt_calibrated of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 :rtype: float @@ -321,6 +327,7 @@ def probability_alt_calibrated(self): def probability_alt_calibrated(self, probability_alt_calibrated): """Sets the probability_alt_calibrated of this FirstLastNameUSRaceEthnicityOut. + The calibrated probability for raceEthnicity OR raceEthnicityAlt to have been guessed correctly. # noqa: E501 :param probability_alt_calibrated: The probability_alt_calibrated of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 :type: float @@ -328,27 +335,6 @@ def probability_alt_calibrated(self, probability_alt_calibrated): self._probability_alt_calibrated = probability_alt_calibrated - @property - def category(self): - """Gets the category of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 - - - :return: The category of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 - :rtype: str - """ - return self._category - - @category.setter - def category(self, category): - """Sets the category of this FirstLastNameUSRaceEthnicityOut. - - - :param category: The category of this FirstLastNameUSRaceEthnicityOut. # noqa: E501 - :type: str - """ - - self._category = category - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/openapi_client/models/match_personal_first_last_name_in.py b/openapi_client/models/match_personal_first_last_name_in.py index 190359f..e27b9e9 100644 --- a/openapi_client/models/match_personal_first_last_name_in.py +++ b/openapi_client/models/match_personal_first_last_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/name_geo_in.py b/openapi_client/models/name_geo_in.py index a29075f..ecb1276 100644 --- a/openapi_client/models/name_geo_in.py +++ b/openapi_client/models/name_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/name_in.py b/openapi_client/models/name_in.py index 076806c..6a4224e 100644 --- a/openapi_client/models/name_in.py +++ b/openapi_client/models/name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/name_match_candidate_out.py b/openapi_client/models/name_match_candidate_out.py index 223cbc8..165ac3c 100644 --- a/openapi_client/models/name_match_candidate_out.py +++ b/openapi_client/models/name_match_candidate_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -67,6 +67,7 @@ def __init__(self, candidate_name=None, probability=None, pred_score_given_name= def candidate_name(self): """Gets the candidate_name of this NameMatchCandidateOut. # noqa: E501 + The name matching candidate name # noqa: E501 :return: The candidate_name of this NameMatchCandidateOut. # noqa: E501 :rtype: str @@ -77,6 +78,7 @@ def candidate_name(self): def candidate_name(self, candidate_name): """Sets the candidate_name of this NameMatchCandidateOut. + The name matching candidate name # noqa: E501 :param candidate_name: The candidate_name of this NameMatchCandidateOut. # noqa: E501 :type: str @@ -88,6 +90,7 @@ def candidate_name(self, candidate_name): def probability(self): """Gets the probability of this NameMatchCandidateOut. # noqa: E501 + The name matching estimated probability. # noqa: E501 :return: The probability of this NameMatchCandidateOut. # noqa: E501 :rtype: float @@ -98,6 +101,7 @@ def probability(self): def probability(self, probability): """Sets the probability of this NameMatchCandidateOut. + The name matching estimated probability. # noqa: E501 :param probability: The probability of this NameMatchCandidateOut. # noqa: E501 :type: float @@ -109,6 +113,7 @@ def probability(self, probability): def pred_score_given_name(self): """Gets the pred_score_given_name of this NameMatchCandidateOut. # noqa: E501 + The given name prediction score. # noqa: E501 :return: The pred_score_given_name of this NameMatchCandidateOut. # noqa: E501 :rtype: float @@ -119,6 +124,7 @@ def pred_score_given_name(self): def pred_score_given_name(self, pred_score_given_name): """Sets the pred_score_given_name of this NameMatchCandidateOut. + The given name prediction score. # noqa: E501 :param pred_score_given_name: The pred_score_given_name of this NameMatchCandidateOut. # noqa: E501 :type: float @@ -130,6 +136,7 @@ def pred_score_given_name(self, pred_score_given_name): def pred_score_family_name(self): """Gets the pred_score_family_name of this NameMatchCandidateOut. # noqa: E501 + The family name prediction score. # noqa: E501 :return: The pred_score_family_name of this NameMatchCandidateOut. # noqa: E501 :rtype: float @@ -140,6 +147,7 @@ def pred_score_family_name(self): def pred_score_family_name(self, pred_score_family_name): """Sets the pred_score_family_name of this NameMatchCandidateOut. + The family name prediction score. # noqa: E501 :param pred_score_family_name: The pred_score_family_name of this NameMatchCandidateOut. # noqa: E501 :type: float diff --git a/openapi_client/models/name_match_candidates_out.py b/openapi_client/models/name_match_candidates_out.py index 91a79c7..b94d071 100644 --- a/openapi_client/models/name_match_candidates_out.py +++ b/openapi_client/models/name_match_candidates_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -37,8 +37,7 @@ class NameMatchCandidatesOut(object): 'first_name': 'str', 'last_name': 'str', 'order_option': 'str', - 'match_candidates': 'list[NameMatchCandidateOut]', - 'category': 'str' + 'match_candidates': 'list[NameMatchCandidateOut]' } attribute_map = { @@ -47,11 +46,10 @@ class NameMatchCandidatesOut(object): 'first_name': 'firstName', 'last_name': 'lastName', 'order_option': 'orderOption', - 'match_candidates': 'matchCandidates', - 'category': 'category' + 'match_candidates': 'matchCandidates' } - def __init__(self, script=None, id=None, first_name=None, last_name=None, order_option=None, match_candidates=None, category=None): # noqa: E501 + def __init__(self, script=None, id=None, first_name=None, last_name=None, order_option=None, match_candidates=None): # noqa: E501 """NameMatchCandidatesOut - a model defined in OpenAPI""" # noqa: E501 self._script = None @@ -60,7 +58,6 @@ def __init__(self, script=None, id=None, first_name=None, last_name=None, order_ self._last_name = None self._order_option = None self._match_candidates = None - self._category = None self.discriminator = None if script is not None: @@ -75,8 +72,6 @@ def __init__(self, script=None, id=None, first_name=None, last_name=None, order_ self.order_option = order_option if match_candidates is not None: self.match_candidates = match_candidates - if category is not None: - self.category = category @property def script(self): @@ -124,6 +119,7 @@ def id(self, id): def first_name(self): """Gets the first_name of this NameMatchCandidatesOut. # noqa: E501 + The first name (also known as given name) # noqa: E501 :return: The first_name of this NameMatchCandidatesOut. # noqa: E501 :rtype: str @@ -134,6 +130,7 @@ def first_name(self): def first_name(self, first_name): """Sets the first_name of this NameMatchCandidatesOut. + The first name (also known as given name) # noqa: E501 :param first_name: The first_name of this NameMatchCandidatesOut. # noqa: E501 :type: str @@ -145,6 +142,7 @@ def first_name(self, first_name): def last_name(self): """Gets the last_name of this NameMatchCandidatesOut. # noqa: E501 + The last name (also known as family name, or surname) # noqa: E501 :return: The last_name of this NameMatchCandidatesOut. # noqa: E501 :rtype: str @@ -155,6 +153,7 @@ def last_name(self): def last_name(self, last_name): """Sets the last_name of this NameMatchCandidatesOut. + The last name (also known as family name, or surname) # noqa: E501 :param last_name: The last_name of this NameMatchCandidatesOut. # noqa: E501 :type: str @@ -166,6 +165,7 @@ def last_name(self, last_name): def order_option(self): """Gets the order_option of this NameMatchCandidatesOut. # noqa: E501 + The option for ordering # noqa: E501 :return: The order_option of this NameMatchCandidatesOut. # noqa: E501 :rtype: str @@ -176,6 +176,7 @@ def order_option(self): def order_option(self, order_option): """Sets the order_option of this NameMatchCandidatesOut. + The option for ordering # noqa: E501 :param order_option: The order_option of this NameMatchCandidatesOut. # noqa: E501 :type: str @@ -187,6 +188,7 @@ def order_option(self, order_option): def match_candidates(self): """Gets the match_candidates of this NameMatchCandidatesOut. # noqa: E501 + The ordered list of name matching candidates # noqa: E501 :return: The match_candidates of this NameMatchCandidatesOut. # noqa: E501 :rtype: list[NameMatchCandidateOut] @@ -197,6 +199,7 @@ def match_candidates(self): def match_candidates(self, match_candidates): """Sets the match_candidates of this NameMatchCandidatesOut. + The ordered list of name matching candidates # noqa: E501 :param match_candidates: The match_candidates of this NameMatchCandidatesOut. # noqa: E501 :type: list[NameMatchCandidateOut] @@ -204,27 +207,6 @@ def match_candidates(self, match_candidates): self._match_candidates = match_candidates - @property - def category(self): - """Gets the category of this NameMatchCandidatesOut. # noqa: E501 - - - :return: The category of this NameMatchCandidatesOut. # noqa: E501 - :rtype: str - """ - return self._category - - @category.setter - def category(self, category): - """Sets the category of this NameMatchCandidatesOut. - - - :param category: The category of this NameMatchCandidatesOut. # noqa: E501 - :type: str - """ - - self._category = category - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/openapi_client/models/name_matched_out.py b/openapi_client/models/name_matched_out.py index aa56bc8..af43e35 100644 --- a/openapi_client/models/name_matched_out.py +++ b/openapi_client/models/name_matched_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -35,26 +35,23 @@ class NameMatchedOut(object): 'script': 'str', 'id': 'str', 'match_status': 'str', - 'score': 'float', - 'category': 'str' + 'score': 'float' } attribute_map = { 'script': 'script', 'id': 'id', 'match_status': 'matchStatus', - 'score': 'score', - 'category': 'category' + 'score': 'score' } - def __init__(self, script=None, id=None, match_status=None, score=None, category=None): # noqa: E501 + def __init__(self, script=None, id=None, match_status=None, score=None): # noqa: E501 """NameMatchedOut - a model defined in OpenAPI""" # noqa: E501 self._script = None self._id = None self._match_status = None self._score = None - self._category = None self.discriminator = None if script is not None: @@ -65,8 +62,6 @@ def __init__(self, script=None, id=None, match_status=None, score=None, category self.match_status = match_status if score is not None: self.score = score - if category is not None: - self.category = category @property def script(self): @@ -114,6 +109,7 @@ def id(self, id): def match_status(self): """Gets the match_status of this NameMatchedOut. # noqa: E501 + The name matching status. # noqa: E501 :return: The match_status of this NameMatchedOut. # noqa: E501 :rtype: str @@ -124,6 +120,7 @@ def match_status(self): def match_status(self, match_status): """Sets the match_status of this NameMatchedOut. + The name matching status. # noqa: E501 :param match_status: The match_status of this NameMatchedOut. # noqa: E501 :type: str @@ -152,27 +149,6 @@ def score(self, score): self._score = score - @property - def category(self): - """Gets the category of this NameMatchedOut. # noqa: E501 - - - :return: The category of this NameMatchedOut. # noqa: E501 - :rtype: str - """ - return self._category - - @category.setter - def category(self, category): - """Sets the category of this NameMatchedOut. - - - :param category: The category of this NameMatchedOut. # noqa: E501 - :type: str - """ - - self._category = category - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/openapi_client/models/personal_name_gendered_out.py b/openapi_client/models/personal_name_gendered_out.py index 244cf7c..08b2b39 100644 --- a/openapi_client/models/personal_name_gendered_out.py +++ b/openapi_client/models/personal_name_gendered_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -38,8 +38,7 @@ class PersonalNameGenderedOut(object): 'likely_gender': 'str', 'gender_scale': 'float', 'score': 'float', - 'probability_calibrated': 'float', - 'category': 'str' + 'probability_calibrated': 'float' } attribute_map = { @@ -49,11 +48,10 @@ class PersonalNameGenderedOut(object): 'likely_gender': 'likelyGender', 'gender_scale': 'genderScale', 'score': 'score', - 'probability_calibrated': 'probabilityCalibrated', - 'category': 'category' + 'probability_calibrated': 'probabilityCalibrated' } - def __init__(self, script=None, id=None, name=None, likely_gender=None, gender_scale=None, score=None, probability_calibrated=None, category=None): # noqa: E501 + def __init__(self, script=None, id=None, name=None, likely_gender=None, gender_scale=None, score=None, probability_calibrated=None): # noqa: E501 """PersonalNameGenderedOut - a model defined in OpenAPI""" # noqa: E501 self._script = None @@ -63,7 +61,6 @@ def __init__(self, script=None, id=None, name=None, likely_gender=None, gender_s self._gender_scale = None self._score = None self._probability_calibrated = None - self._category = None self.discriminator = None if script is not None: @@ -80,8 +77,6 @@ def __init__(self, script=None, id=None, name=None, likely_gender=None, gender_s self.score = score if probability_calibrated is not None: self.probability_calibrated = probability_calibrated - if category is not None: - self.category = category @property def script(self): @@ -129,6 +124,7 @@ def id(self, id): def name(self): """Gets the name of this PersonalNameGenderedOut. # noqa: E501 + The input name # noqa: E501 :return: The name of this PersonalNameGenderedOut. # noqa: E501 :rtype: str @@ -139,6 +135,7 @@ def name(self): def name(self, name): """Sets the name of this PersonalNameGenderedOut. + The input name # noqa: E501 :param name: The name of this PersonalNameGenderedOut. # noqa: E501 :type: str @@ -202,6 +199,7 @@ def gender_scale(self, gender_scale): def score(self): """Gets the score of this PersonalNameGenderedOut. # noqa: E501 + Compatibility to NamSor_v1 Gender score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :return: The score of this PersonalNameGenderedOut. # noqa: E501 :rtype: float @@ -212,10 +210,15 @@ def score(self): def score(self, score): """Sets the score of this PersonalNameGenderedOut. + Compatibility to NamSor_v1 Gender score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :param score: The score of this PersonalNameGenderedOut. # noqa: E501 :type: float """ + if score is not None and score > 100: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value less than or equal to `100`") # noqa: E501 + if score is not None and score < 0: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value greater than or equal to `0`") # noqa: E501 self._score = score @@ -223,6 +226,7 @@ def score(self, score): def probability_calibrated(self): """Gets the probability_calibrated of this PersonalNameGenderedOut. # noqa: E501 + The calibrated probability for inferred gender to have been guessed correctly. # noqa: E501 :return: The probability_calibrated of this PersonalNameGenderedOut. # noqa: E501 :rtype: float @@ -233,6 +237,7 @@ def probability_calibrated(self): def probability_calibrated(self, probability_calibrated): """Sets the probability_calibrated of this PersonalNameGenderedOut. + The calibrated probability for inferred gender to have been guessed correctly. # noqa: E501 :param probability_calibrated: The probability_calibrated of this PersonalNameGenderedOut. # noqa: E501 :type: float @@ -240,27 +245,6 @@ def probability_calibrated(self, probability_calibrated): self._probability_calibrated = probability_calibrated - @property - def category(self): - """Gets the category of this PersonalNameGenderedOut. # noqa: E501 - - - :return: The category of this PersonalNameGenderedOut. # noqa: E501 - :rtype: str - """ - return self._category - - @category.setter - def category(self, category): - """Sets the category of this PersonalNameGenderedOut. - - - :param category: The category of this PersonalNameGenderedOut. # noqa: E501 - :type: str - """ - - self._category = category - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/openapi_client/models/personal_name_geo_in.py b/openapi_client/models/personal_name_geo_in.py index 5dad7e9..8290f5f 100644 --- a/openapi_client/models/personal_name_geo_in.py +++ b/openapi_client/models/personal_name_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/personal_name_geo_out.py b/openapi_client/models/personal_name_geo_out.py index 45809da..2eb438b 100644 --- a/openapi_client/models/personal_name_geo_out.py +++ b/openapi_client/models/personal_name_geo_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -43,8 +43,7 @@ class PersonalNameGeoOut(object): 'sub_region': 'str', 'countries_top': 'list[str]', 'probability_calibrated': 'float', - 'probability_alt_calibrated': 'float', - 'category': 'str' + 'probability_alt_calibrated': 'float' } attribute_map = { @@ -59,11 +58,10 @@ class PersonalNameGeoOut(object): 'sub_region': 'subRegion', 'countries_top': 'countriesTop', 'probability_calibrated': 'probabilityCalibrated', - 'probability_alt_calibrated': 'probabilityAltCalibrated', - 'category': 'category' + 'probability_alt_calibrated': 'probabilityAltCalibrated' } - def __init__(self, script=None, id=None, name=None, score=None, country=None, country_alt=None, region=None, top_region=None, sub_region=None, countries_top=None, probability_calibrated=None, probability_alt_calibrated=None, category=None): # noqa: E501 + def __init__(self, script=None, id=None, name=None, score=None, country=None, country_alt=None, region=None, top_region=None, sub_region=None, countries_top=None, probability_calibrated=None, probability_alt_calibrated=None): # noqa: E501 """PersonalNameGeoOut - a model defined in OpenAPI""" # noqa: E501 self._script = None @@ -78,7 +76,6 @@ def __init__(self, script=None, id=None, name=None, score=None, country=None, co self._countries_top = None self._probability_calibrated = None self._probability_alt_calibrated = None - self._category = None self.discriminator = None if script is not None: @@ -105,8 +102,6 @@ def __init__(self, script=None, id=None, name=None, score=None, country=None, co self.probability_calibrated = probability_calibrated if probability_alt_calibrated is not None: self.probability_alt_calibrated = probability_alt_calibrated - if category is not None: - self.category = category @property def script(self): @@ -154,6 +149,7 @@ def id(self, id): def name(self): """Gets the name of this PersonalNameGeoOut. # noqa: E501 + The input name. # noqa: E501 :return: The name of this PersonalNameGeoOut. # noqa: E501 :rtype: str @@ -164,6 +160,7 @@ def name(self): def name(self, name): """Sets the name of this PersonalNameGeoOut. + The input name. # noqa: E501 :param name: The name of this PersonalNameGeoOut. # noqa: E501 :type: str @@ -175,6 +172,7 @@ def name(self, name): def score(self): """Gets the score of this PersonalNameGeoOut. # noqa: E501 + Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :return: The score of this PersonalNameGeoOut. # noqa: E501 :rtype: float @@ -185,10 +183,15 @@ def score(self): def score(self, score): """Sets the score of this PersonalNameGeoOut. + Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :param score: The score of this PersonalNameGeoOut. # noqa: E501 :type: float """ + if score is not None and score > 100: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value less than or equal to `100`") # noqa: E501 + if score is not None and score < 0: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value greater than or equal to `0`") # noqa: E501 self._score = score @@ -196,6 +199,7 @@ def score(self, score): def country(self): """Gets the country of this PersonalNameGeoOut. # noqa: E501 + Most likely country # noqa: E501 :return: The country of this PersonalNameGeoOut. # noqa: E501 :rtype: str @@ -206,6 +210,7 @@ def country(self): def country(self, country): """Sets the country of this PersonalNameGeoOut. + Most likely country # noqa: E501 :param country: The country of this PersonalNameGeoOut. # noqa: E501 :type: str @@ -217,6 +222,7 @@ def country(self, country): def country_alt(self): """Gets the country_alt of this PersonalNameGeoOut. # noqa: E501 + Second best alternative : country # noqa: E501 :return: The country_alt of this PersonalNameGeoOut. # noqa: E501 :rtype: str @@ -227,6 +233,7 @@ def country_alt(self): def country_alt(self, country_alt): """Sets the country_alt of this PersonalNameGeoOut. + Second best alternative : country # noqa: E501 :param country_alt: The country_alt of this PersonalNameGeoOut. # noqa: E501 :type: str @@ -238,6 +245,7 @@ def country_alt(self, country_alt): def region(self): """Gets the region of this PersonalNameGeoOut. # noqa: E501 + Most likely region (based on country ISO2 code) # noqa: E501 :return: The region of this PersonalNameGeoOut. # noqa: E501 :rtype: str @@ -248,6 +256,7 @@ def region(self): def region(self, region): """Sets the region of this PersonalNameGeoOut. + Most likely region (based on country ISO2 code) # noqa: E501 :param region: The region of this PersonalNameGeoOut. # noqa: E501 :type: str @@ -259,6 +268,7 @@ def region(self, region): def top_region(self): """Gets the top_region of this PersonalNameGeoOut. # noqa: E501 + Most likely top region (based on country ISO2 code) # noqa: E501 :return: The top_region of this PersonalNameGeoOut. # noqa: E501 :rtype: str @@ -269,6 +279,7 @@ def top_region(self): def top_region(self, top_region): """Sets the top_region of this PersonalNameGeoOut. + Most likely top region (based on country ISO2 code) # noqa: E501 :param top_region: The top_region of this PersonalNameGeoOut. # noqa: E501 :type: str @@ -280,6 +291,7 @@ def top_region(self, top_region): def sub_region(self): """Gets the sub_region of this PersonalNameGeoOut. # noqa: E501 + Most likely sub region (based on country ISO2 code) # noqa: E501 :return: The sub_region of this PersonalNameGeoOut. # noqa: E501 :rtype: str @@ -290,6 +302,7 @@ def sub_region(self): def sub_region(self, sub_region): """Sets the sub_region of this PersonalNameGeoOut. + Most likely sub region (based on country ISO2 code) # noqa: E501 :param sub_region: The sub_region of this PersonalNameGeoOut. # noqa: E501 :type: str @@ -324,6 +337,7 @@ def countries_top(self, countries_top): def probability_calibrated(self): """Gets the probability_calibrated of this PersonalNameGeoOut. # noqa: E501 + The calibrated probability for country to have been guessed correctly. # noqa: E501 :return: The probability_calibrated of this PersonalNameGeoOut. # noqa: E501 :rtype: float @@ -334,6 +348,7 @@ def probability_calibrated(self): def probability_calibrated(self, probability_calibrated): """Sets the probability_calibrated of this PersonalNameGeoOut. + The calibrated probability for country to have been guessed correctly. # noqa: E501 :param probability_calibrated: The probability_calibrated of this PersonalNameGeoOut. # noqa: E501 :type: float @@ -345,6 +360,7 @@ def probability_calibrated(self, probability_calibrated): def probability_alt_calibrated(self): """Gets the probability_alt_calibrated of this PersonalNameGeoOut. # noqa: E501 + The calibrated probability for country OR countryAlt to have been guessed correctly. # noqa: E501 :return: The probability_alt_calibrated of this PersonalNameGeoOut. # noqa: E501 :rtype: float @@ -355,6 +371,7 @@ def probability_alt_calibrated(self): def probability_alt_calibrated(self, probability_alt_calibrated): """Sets the probability_alt_calibrated of this PersonalNameGeoOut. + The calibrated probability for country OR countryAlt to have been guessed correctly. # noqa: E501 :param probability_alt_calibrated: The probability_alt_calibrated of this PersonalNameGeoOut. # noqa: E501 :type: float @@ -362,27 +379,6 @@ def probability_alt_calibrated(self, probability_alt_calibrated): self._probability_alt_calibrated = probability_alt_calibrated - @property - def category(self): - """Gets the category of this PersonalNameGeoOut. # noqa: E501 - - - :return: The category of this PersonalNameGeoOut. # noqa: E501 - :rtype: str - """ - return self._category - - @category.setter - def category(self, category): - """Sets the category of this PersonalNameGeoOut. - - - :param category: The category of this PersonalNameGeoOut. # noqa: E501 - :type: str - """ - - self._category = category - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/openapi_client/models/personal_name_in.py b/openapi_client/models/personal_name_in.py index 36193f6..1b928ff 100644 --- a/openapi_client/models/personal_name_in.py +++ b/openapi_client/models/personal_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/openapi_client/models/personal_name_parsed_out.py b/openapi_client/models/personal_name_parsed_out.py index 996a554..4e55f4a 100644 --- a/openapi_client/models/personal_name_parsed_out.py +++ b/openapi_client/models/personal_name_parsed_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -38,8 +38,7 @@ class PersonalNameParsedOut(object): 'name_parser_type': 'str', 'name_parser_type_alt': 'str', 'first_last_name': 'FirstLastNameOut', - 'score': 'float', - 'category': 'str' + 'score': 'float' } attribute_map = { @@ -49,11 +48,10 @@ class PersonalNameParsedOut(object): 'name_parser_type': 'nameParserType', 'name_parser_type_alt': 'nameParserTypeAlt', 'first_last_name': 'firstLastName', - 'score': 'score', - 'category': 'category' + 'score': 'score' } - def __init__(self, script=None, id=None, name=None, name_parser_type=None, name_parser_type_alt=None, first_last_name=None, score=None, category=None): # noqa: E501 + def __init__(self, script=None, id=None, name=None, name_parser_type=None, name_parser_type_alt=None, first_last_name=None, score=None): # noqa: E501 """PersonalNameParsedOut - a model defined in OpenAPI""" # noqa: E501 self._script = None @@ -63,7 +61,6 @@ def __init__(self, script=None, id=None, name=None, name_parser_type=None, name_ self._name_parser_type_alt = None self._first_last_name = None self._score = None - self._category = None self.discriminator = None if script is not None: @@ -80,8 +77,6 @@ def __init__(self, script=None, id=None, name=None, name_parser_type=None, name_ self.first_last_name = first_last_name if score is not None: self.score = score - if category is not None: - self.category = category @property def script(self): @@ -129,6 +124,7 @@ def id(self, id): def name(self): """Gets the name of this PersonalNameParsedOut. # noqa: E501 + The input name # noqa: E501 :return: The name of this PersonalNameParsedOut. # noqa: E501 :rtype: str @@ -139,6 +135,7 @@ def name(self): def name(self, name): """Sets the name of this PersonalNameParsedOut. + The input name # noqa: E501 :param name: The name of this PersonalNameParsedOut. # noqa: E501 :type: str @@ -150,6 +147,7 @@ def name(self, name): def name_parser_type(self): """Gets the name_parser_type of this PersonalNameParsedOut. # noqa: E501 + Name parsing is addressed as a classification problem, for example FN1LN1 means a first then last name order. # noqa: E501 :return: The name_parser_type of this PersonalNameParsedOut. # noqa: E501 :rtype: str @@ -160,6 +158,7 @@ def name_parser_type(self): def name_parser_type(self, name_parser_type): """Sets the name_parser_type of this PersonalNameParsedOut. + Name parsing is addressed as a classification problem, for example FN1LN1 means a first then last name order. # noqa: E501 :param name_parser_type: The name_parser_type of this PersonalNameParsedOut. # noqa: E501 :type: str @@ -171,6 +170,7 @@ def name_parser_type(self, name_parser_type): def name_parser_type_alt(self): """Gets the name_parser_type_alt of this PersonalNameParsedOut. # noqa: E501 + Second best alternative parsing. Name parsing is addressed as a classification problem, for example FN1LN1 means a first then last name order. # noqa: E501 :return: The name_parser_type_alt of this PersonalNameParsedOut. # noqa: E501 :rtype: str @@ -181,6 +181,7 @@ def name_parser_type_alt(self): def name_parser_type_alt(self, name_parser_type_alt): """Sets the name_parser_type_alt of this PersonalNameParsedOut. + Second best alternative parsing. Name parsing is addressed as a classification problem, for example FN1LN1 means a first then last name order. # noqa: E501 :param name_parser_type_alt: The name_parser_type_alt of this PersonalNameParsedOut. # noqa: E501 :type: str @@ -213,6 +214,7 @@ def first_last_name(self, first_last_name): def score(self): """Gets the score of this PersonalNameParsedOut. # noqa: E501 + Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :return: The score of this PersonalNameParsedOut. # noqa: E501 :rtype: float @@ -223,34 +225,18 @@ def score(self): def score(self, score): """Sets the score of this PersonalNameParsedOut. + Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :param score: The score of this PersonalNameParsedOut. # noqa: E501 :type: float """ + if score is not None and score > 100: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value less than or equal to `100`") # noqa: E501 + if score is not None and score < 0: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value greater than or equal to `0`") # noqa: E501 self._score = score - @property - def category(self): - """Gets the category of this PersonalNameParsedOut. # noqa: E501 - - - :return: The category of this PersonalNameParsedOut. # noqa: E501 - :rtype: str - """ - return self._category - - @category.setter - def category(self, category): - """Sets the category of this PersonalNameParsedOut. - - - :param category: The category of this PersonalNameParsedOut. # noqa: E501 - :type: str - """ - - self._category = category - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/openapi_client/models/proper_noun_categorized_out.py b/openapi_client/models/proper_noun_categorized_out.py index 8b4919d..04b0ce9 100644 --- a/openapi_client/models/proper_noun_categorized_out.py +++ b/openapi_client/models/proper_noun_categorized_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -37,8 +37,7 @@ class ProperNounCategorizedOut(object): 'name': 'str', 'common_type': 'str', 'common_type_alt': 'str', - 'score': 'float', - 'category': 'str' + 'score': 'float' } attribute_map = { @@ -47,11 +46,10 @@ class ProperNounCategorizedOut(object): 'name': 'name', 'common_type': 'commonType', 'common_type_alt': 'commonTypeAlt', - 'score': 'score', - 'category': 'category' + 'score': 'score' } - def __init__(self, script=None, id=None, name=None, common_type=None, common_type_alt=None, score=None, category=None): # noqa: E501 + def __init__(self, script=None, id=None, name=None, common_type=None, common_type_alt=None, score=None): # noqa: E501 """ProperNounCategorizedOut - a model defined in OpenAPI""" # noqa: E501 self._script = None @@ -60,7 +58,6 @@ def __init__(self, script=None, id=None, name=None, common_type=None, common_typ self._common_type = None self._common_type_alt = None self._score = None - self._category = None self.discriminator = None if script is not None: @@ -75,8 +72,6 @@ def __init__(self, script=None, id=None, name=None, common_type=None, common_typ self.common_type_alt = common_type_alt if score is not None: self.score = score - if category is not None: - self.category = category @property def script(self): @@ -124,6 +119,7 @@ def id(self, id): def name(self): """Gets the name of this ProperNounCategorizedOut. # noqa: E501 + The input name # noqa: E501 :return: The name of this ProperNounCategorizedOut. # noqa: E501 :rtype: str @@ -134,6 +130,7 @@ def name(self): def name(self, name): """Sets the name of this ProperNounCategorizedOut. + The input name # noqa: E501 :param name: The name of this ProperNounCategorizedOut. # noqa: E501 :type: str @@ -145,6 +142,7 @@ def name(self, name): def common_type(self): """Gets the common_type of this ProperNounCategorizedOut. # noqa: E501 + The most likely common name type # noqa: E501 :return: The common_type of this ProperNounCategorizedOut. # noqa: E501 :rtype: str @@ -155,6 +153,7 @@ def common_type(self): def common_type(self, common_type): """Sets the common_type of this ProperNounCategorizedOut. + The most likely common name type # noqa: E501 :param common_type: The common_type of this ProperNounCategorizedOut. # noqa: E501 :type: str @@ -166,6 +165,7 @@ def common_type(self, common_type): def common_type_alt(self): """Gets the common_type_alt of this ProperNounCategorizedOut. # noqa: E501 + Best alternative for : The most likely common name type # noqa: E501 :return: The common_type_alt of this ProperNounCategorizedOut. # noqa: E501 :rtype: str @@ -176,6 +176,7 @@ def common_type_alt(self): def common_type_alt(self, common_type_alt): """Sets the common_type_alt of this ProperNounCategorizedOut. + Best alternative for : The most likely common name type # noqa: E501 :param common_type_alt: The common_type_alt of this ProperNounCategorizedOut. # noqa: E501 :type: str @@ -187,6 +188,7 @@ def common_type_alt(self, common_type_alt): def score(self): """Gets the score of this ProperNounCategorizedOut. # noqa: E501 + Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :return: The score of this ProperNounCategorizedOut. # noqa: E501 :rtype: float @@ -197,34 +199,18 @@ def score(self): def score(self, score): """Sets the score of this ProperNounCategorizedOut. + Higher score is better, but score is not normalized. Use calibratedProbability if available. # noqa: E501 :param score: The score of this ProperNounCategorizedOut. # noqa: E501 :type: float """ + if score is not None and score > 100: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value less than or equal to `100`") # noqa: E501 + if score is not None and score < 0: # noqa: E501 + raise ValueError("Invalid value for `score`, must be a value greater than or equal to `0`") # noqa: E501 self._score = score - @property - def category(self): - """Gets the category of this ProperNounCategorizedOut. # noqa: E501 - - - :return: The category of this ProperNounCategorizedOut. # noqa: E501 - :rtype: str - """ - return self._category - - @category.setter - def category(self, category): - """Sets the category of this ProperNounCategorizedOut. - - - :param category: The category of this ProperNounCategorizedOut. # noqa: E501 - :type: str - """ - - self._category = category - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/openapi_client/models/software_version_out.py b/openapi_client/models/software_version_out.py index 5c2ffa3..8a4e3d2 100644 --- a/openapi_client/models/software_version_out.py +++ b/openapi_client/models/software_version_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -57,6 +57,7 @@ def __init__(self, software_name_and_version=None, software_version=None): # no def software_name_and_version(self): """Gets the software_name_and_version of this SoftwareVersionOut. # noqa: E501 + The software version # noqa: E501 :return: The software_name_and_version of this SoftwareVersionOut. # noqa: E501 :rtype: str @@ -67,6 +68,7 @@ def software_name_and_version(self): def software_name_and_version(self, software_name_and_version): """Sets the software_name_and_version of this SoftwareVersionOut. + The software version # noqa: E501 :param software_name_and_version: The software_name_and_version of this SoftwareVersionOut. # noqa: E501 :type: str @@ -78,6 +80,7 @@ def software_name_and_version(self, software_name_and_version): def software_version(self): """Gets the software_version of this SoftwareVersionOut. # noqa: E501 + The software version major minor build # noqa: E501 :return: The software_version of this SoftwareVersionOut. # noqa: E501 :rtype: list[int] @@ -88,6 +91,7 @@ def software_version(self): def software_version(self, software_version): """Sets the software_version of this SoftwareVersionOut. + The software version major minor build # noqa: E501 :param software_version: The software_version of this SoftwareVersionOut. # noqa: E501 :type: list[int] diff --git a/openapi_client/rest.py b/openapi_client/rest.py index ae9b2c1..5e07e83 100644 --- a/openapi_client/rest.py +++ b/openapi_client/rest.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/run-python.bash b/run-python.bash index 327a0b3..25fd199 100755 --- a/run-python.bash +++ b/run-python.bash @@ -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.13 +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.15 #~/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 diff --git a/setup.py b/setup.py index 2777d8b..0e00b69 100644 --- a/setup.py +++ b/setup.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -14,7 +14,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "openapi-client" -VERSION = "2.0.13" +VERSION = "2.0.15" # To install the library, run the following # # python setup.py install @@ -35,6 +35,6 @@ packages=find_packages(), include_package_data=True, long_description="""\ - 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 + 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 """ ) diff --git a/test/test_admin_api.py b/test/test_admin_api.py index 2f8761d..db77de3 100644 --- a/test/test_admin_api.py +++ b/test/test_admin_api.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -29,13 +29,6 @@ def setUp(self): def tearDown(self): pass - def test_add_credits(self): - """Test case for add_credits - - Add usage credits to an API Key. # noqa: E501 - """ - pass - def test_anonymize(self): """Test case for anonymize @@ -46,7 +39,7 @@ def test_anonymize(self): def test_api_status(self): """Test case for api_status - Prints the current status of the classifiers. # noqa: E501 + Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices. # noqa: E501 """ pass @@ -71,80 +64,17 @@ def test_api_usage_history_aggregate(self): """ pass - def test_available_plans(self): - """Test case for available_plans - - List all available plans in the user's preferred currency. # noqa: E501 - """ - pass - - def test_available_plans1(self): - """Test case for available_plans1 - - List all available plans in the default currency (usd). # noqa: E501 - """ - pass - def test_available_services(self): """Test case for available_services - List of API services and usage cost in Units (default is 1=ONE Unit). # noqa: E501 - """ - pass - - def test_billing_currencies(self): - """Test case for billing_currencies - - List possible currency options for billing (USD, EUR, GBP, ...) # noqa: E501 - """ - pass - - def test_billing_history(self): - """Test case for billing_history - - Read the history billing information (invoices paid via Stripe or manually). # noqa: E501 - """ - pass - - def test_billing_info(self): - """Test case for billing_info - - Read the billing information (company name, address, phone, vat ID) # noqa: E501 - """ - pass - - def test_charge(self): - """Test case for charge - - Create a Stripe Customer, based on a payment card token (from secure StripeJS) and email. # noqa: E501 + List of classification services and usage cost in Units per classification (default is 1=ONE Unit). Some API endpoints (ex. Corridor) combine multiple classifiers. # noqa: E501 """ pass - def test_corporate_key(self): - """Test case for corporate_key + def test_disable(self): + """Test case for disable - Setting an API Key to a corporate status. # noqa: E501 - """ - pass - - def test_debug_level(self): - """Test case for debug_level - - Update debug level for a classifier # noqa: E501 - """ - pass - - def test_flush(self): - """Test case for flush - - Flush counters. # noqa: E501 - """ - pass - - def test_invalidate_cache(self): - """Test case for invalidate_cache - - Invalidate system caches. # noqa: E501 + Activate/deactivate an API Key. # noqa: E501 """ pass @@ -155,48 +85,6 @@ def test_learnable(self): """ pass - def test_namsor_counter(self): - """Test case for namsor_counter - - Get the overall API counter # noqa: E501 - """ - pass - - def test_payment_info(self): - """Test case for payment_info - - Get the Stripe payment information associated with the current google auth session token. # noqa: E501 - """ - pass - - def test_procure_key(self): - """Test case for procure_key - - Procure an API Key (sent via Email), based on an auth token. Keep your API Key secret. # noqa: E501 - """ - pass - - def test_remove_user_account(self): - """Test case for remove_user_account - - Remove the user account. # noqa: E501 - """ - pass - - def test_remove_user_account_on_behalf(self): - """Test case for remove_user_account_on_behalf - - Remove (on behalf) a user account. # noqa: E501 - """ - pass - - def test_shutdown(self): - """Test case for shutdown - - Stop learning and shutdown system. # noqa: E501 - """ - pass - def test_software_version(self): """Test case for software_version @@ -204,41 +92,6 @@ def test_software_version(self): """ pass - def test_source_stats(self): - """Test case for source_stats - - Print basic source statistics. # noqa: E501 - """ - pass - - def test_stats(self): - """Test case for stats - - Print basic system statistics. # noqa: E501 - """ - pass - - def test_stripe_connect(self): - """Test case for stripe_connect - - Connects a Stripe Account. # noqa: E501 - """ - pass - - def test_subscribe_plan(self): - """Test case for subscribe_plan - - Subscribe to a give API plan, using the user's preferred or default currency. # noqa: E501 - """ - pass - - def test_subscribe_plan_on_behalf(self): - """Test case for subscribe_plan_on_behalf - - Subscribe to a give API plan, using the user's preferred or default currency (admin only). # noqa: E501 - """ - pass - def test_taxonomy_classes(self): """Test case for taxonomy_classes @@ -246,55 +99,6 @@ def test_taxonomy_classes(self): """ pass - def test_update_billing_info(self): - """Test case for update_billing_info - - Sets or update the billing information (company name, address, phone, vat ID) # noqa: E501 - """ - pass - - def test_update_limit(self): - """Test case for update_limit - - Modifies the hard/soft limit on the API plan's overages (default is 0$ soft limit). # noqa: E501 - """ - pass - - def test_update_payment_default(self): - """Test case for update_payment_default - - Update the default Stripe card associated with the current google auth session token. # noqa: E501 - """ - pass - - def test_user_info(self): - """Test case for user_info - - Get the user profile associated with the current google auth session token. # noqa: E501 - """ - pass - - def test_verify_email(self): - """Test case for verify_email - - Verifies an email, based on token sent to that email # noqa: E501 - """ - pass - - def test_verify_remove_email(self): - """Test case for verify_remove_email - - Verifies an email, based on token sent to that email # noqa: E501 - """ - pass - - def test_vet(self): - """Test case for vet - - Vetting of a source. # noqa: E501 - """ - pass - if __name__ == '__main__': unittest.main() diff --git a/test/test_api_billing_period_usage_out.py b/test/test_api_billing_period_usage_out.py index 91d7bef..3f6b761 100644 --- a/test/test_api_billing_period_usage_out.py +++ b/test/test_api_billing_period_usage_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_api_classifier_out.py b/test/test_api_classifier_out.py index d9aba7f..3668d11 100644 --- a/test/test_api_classifier_out.py +++ b/test/test_api_classifier_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_api_classifier_taxonomy_out.py b/test/test_api_classifier_taxonomy_out.py index 2310e74..e1c9a58 100644 --- a/test/test_api_classifier_taxonomy_out.py +++ b/test/test_api_classifier_taxonomy_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_api_classifiers_status_out.py b/test/test_api_classifiers_status_out.py index 44ce6bf..f3c427c 100644 --- a/test/test_api_classifiers_status_out.py +++ b/test/test_api_classifiers_status_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_api_counter_v2_out.py b/test/test_api_counter_v2_out.py index 24b5adc..44316a4 100644 --- a/test/test_api_counter_v2_out.py +++ b/test/test_api_counter_v2_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_api_key_out.py b/test/test_api_key_out.py index 8e5c5e9..b4a9914 100644 --- a/test/test_api_key_out.py +++ b/test/test_api_key_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_api_period_usage_out.py b/test/test_api_period_usage_out.py index a705b07..bfc3337 100644 --- a/test/test_api_period_usage_out.py +++ b/test/test_api_period_usage_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_api_plan_subscription_out.py b/test/test_api_plan_subscription_out.py index a922709..61333a0 100644 --- a/test/test_api_plan_subscription_out.py +++ b/test/test_api_plan_subscription_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_api_service_out.py b/test/test_api_service_out.py index 994baca..1fd2826 100644 --- a/test/test_api_service_out.py +++ b/test/test_api_service_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_api_services_out.py b/test/test_api_services_out.py index ad28f16..896138b 100644 --- a/test/test_api_services_out.py +++ b/test/test_api_services_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_api_usage_aggregated_out.py b/test/test_api_usage_aggregated_out.py index c756084..8bedd2b 100644 --- a/test/test_api_usage_aggregated_out.py +++ b/test/test_api_usage_aggregated_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_api_usage_history_out.py b/test/test_api_usage_history_out.py new file mode 100644 index 0000000..69e722a --- /dev/null +++ b/test/test_api_usage_history_out.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + NamSor API v2 + + 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.15 + Contact: contact@namsor.com + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest + +import openapi_client +from openapi_client.models.api_usage_history_out import APIUsageHistoryOut # noqa: E501 +from openapi_client.rest import ApiException + + +class TestAPIUsageHistoryOut(unittest.TestCase): + """APIUsageHistoryOut unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAPIUsageHistoryOut(self): + """Test APIUsageHistoryOut""" + # FIXME: construct object with mandatory attributes with example values + # model = openapi_client.models.api_usage_history_out.APIUsageHistoryOut() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_batch_corridor_in.py b/test/test_batch_corridor_in.py index cd78fb5..05c6fcc 100644 --- a/test/test_batch_corridor_in.py +++ b/test/test_batch_corridor_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_corridor_out.py b/test/test_batch_corridor_out.py index 4412670..6a941e9 100644 --- a/test/test_batch_corridor_out.py +++ b/test/test_batch_corridor_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_first_last_name_diasporaed_out.py b/test/test_batch_first_last_name_diasporaed_out.py index 836ef7e..13c68b2 100644 --- a/test/test_batch_first_last_name_diasporaed_out.py +++ b/test/test_batch_first_last_name_diasporaed_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_first_last_name_gender_in.py b/test/test_batch_first_last_name_gender_in.py index 5e7e007..57886c7 100644 --- a/test/test_batch_first_last_name_gender_in.py +++ b/test/test_batch_first_last_name_gender_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_first_last_name_gendered_out.py b/test/test_batch_first_last_name_gendered_out.py index 949e9df..bc8903e 100644 --- a/test/test_batch_first_last_name_gendered_out.py +++ b/test/test_batch_first_last_name_gendered_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_first_last_name_geo_in.py b/test/test_batch_first_last_name_geo_in.py index a2ea753..7eac227 100644 --- a/test/test_batch_first_last_name_geo_in.py +++ b/test/test_batch_first_last_name_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_first_last_name_geo_zipped_in.py b/test/test_batch_first_last_name_geo_zipped_in.py index 13a5540..c94adf3 100644 --- a/test/test_batch_first_last_name_geo_zipped_in.py +++ b/test/test_batch_first_last_name_geo_zipped_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_first_last_name_in.py b/test/test_batch_first_last_name_in.py index a5e6872..7051b91 100644 --- a/test/test_batch_first_last_name_in.py +++ b/test/test_batch_first_last_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_first_last_name_origined_out.py b/test/test_batch_first_last_name_origined_out.py index 532b2b4..1438125 100644 --- a/test/test_batch_first_last_name_origined_out.py +++ b/test/test_batch_first_last_name_origined_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_first_last_name_phone_coded_out.py b/test/test_batch_first_last_name_phone_coded_out.py index e5809e4..3f435ca 100644 --- a/test/test_batch_first_last_name_phone_coded_out.py +++ b/test/test_batch_first_last_name_phone_coded_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_first_last_name_phone_number_geo_in.py b/test/test_batch_first_last_name_phone_number_geo_in.py index 4054ce6..3f822fe 100644 --- a/test/test_batch_first_last_name_phone_number_geo_in.py +++ b/test/test_batch_first_last_name_phone_number_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_first_last_name_phone_number_in.py b/test/test_batch_first_last_name_phone_number_in.py index 6dbdcf7..71a735b 100644 --- a/test/test_batch_first_last_name_phone_number_in.py +++ b/test/test_batch_first_last_name_phone_number_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_first_last_name_us_race_ethnicity_out.py b/test/test_batch_first_last_name_us_race_ethnicity_out.py index 0282362..c9e3bd3 100644 --- a/test/test_batch_first_last_name_us_race_ethnicity_out.py +++ b/test/test_batch_first_last_name_us_race_ethnicity_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_match_personal_first_last_name_in.py b/test/test_batch_match_personal_first_last_name_in.py index 59e38e5..041d923 100644 --- a/test/test_batch_match_personal_first_last_name_in.py +++ b/test/test_batch_match_personal_first_last_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_name_geo_in.py b/test/test_batch_name_geo_in.py index 800c68e..e7b6fcf 100644 --- a/test/test_batch_name_geo_in.py +++ b/test/test_batch_name_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_name_in.py b/test/test_batch_name_in.py index c829800..075e722 100644 --- a/test/test_batch_name_in.py +++ b/test/test_batch_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_name_match_candidates_out.py b/test/test_batch_name_match_candidates_out.py index aed237c..1413df5 100644 --- a/test/test_batch_name_match_candidates_out.py +++ b/test/test_batch_name_match_candidates_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_name_matched_out.py b/test/test_batch_name_matched_out.py index f4e0eb3..ed01d45 100644 --- a/test/test_batch_name_matched_out.py +++ b/test/test_batch_name_matched_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_personal_name_gendered_out.py b/test/test_batch_personal_name_gendered_out.py index b6a29e6..f84361b 100644 --- a/test/test_batch_personal_name_gendered_out.py +++ b/test/test_batch_personal_name_gendered_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_personal_name_geo_in.py b/test/test_batch_personal_name_geo_in.py index b1eee6a..8eec3f9 100644 --- a/test/test_batch_personal_name_geo_in.py +++ b/test/test_batch_personal_name_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_personal_name_geo_out.py b/test/test_batch_personal_name_geo_out.py index 8a9c5c0..16af726 100644 --- a/test/test_batch_personal_name_geo_out.py +++ b/test/test_batch_personal_name_geo_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_personal_name_in.py b/test/test_batch_personal_name_in.py index 2112abd..736c6aa 100644 --- a/test/test_batch_personal_name_in.py +++ b/test/test_batch_personal_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_personal_name_parsed_out.py b/test/test_batch_personal_name_parsed_out.py index 0fe1bd3..5dbedbe 100644 --- a/test/test_batch_personal_name_parsed_out.py +++ b/test/test_batch_personal_name_parsed_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_batch_proper_noun_categorized_out.py b/test/test_batch_proper_noun_categorized_out.py index eb797f3..ede52b8 100644 --- a/test/test_batch_proper_noun_categorized_out.py +++ b/test/test_batch_proper_noun_categorized_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_chinese_api.py b/test/test_chinese_api.py index 9934fb9..c487699 100644 --- a/test/test_chinese_api.py +++ b/test/test_chinese_api.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_corridor_in.py b/test/test_corridor_in.py index 4c996ff..73188b0 100644 --- a/test/test_corridor_in.py +++ b/test/test_corridor_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_corridor_out.py b/test/test_corridor_out.py index 555f21a..25f0f9e 100644 --- a/test/test_corridor_out.py +++ b/test/test_corridor_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_feedback_loop_out.py b/test/test_feedback_loop_out.py index c4810ec..d83b4b2 100644 --- a/test/test_feedback_loop_out.py +++ b/test/test_feedback_loop_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_first_last_name_diasporaed_out.py b/test/test_first_last_name_diasporaed_out.py index ded1f1f..435e903 100644 --- a/test/test_first_last_name_diasporaed_out.py +++ b/test/test_first_last_name_diasporaed_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_first_last_name_gender_in.py b/test/test_first_last_name_gender_in.py index 8f3a915..85f7978 100644 --- a/test/test_first_last_name_gender_in.py +++ b/test/test_first_last_name_gender_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_first_last_name_gendered_out.py b/test/test_first_last_name_gendered_out.py index 851bca6..b1f6807 100644 --- a/test/test_first_last_name_gendered_out.py +++ b/test/test_first_last_name_gendered_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_first_last_name_geo_in.py b/test/test_first_last_name_geo_in.py index e15387a..0d8f26f 100644 --- a/test/test_first_last_name_geo_in.py +++ b/test/test_first_last_name_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_first_last_name_geo_zipped_in.py b/test/test_first_last_name_geo_zipped_in.py index a0eae51..863c95f 100644 --- a/test/test_first_last_name_geo_zipped_in.py +++ b/test/test_first_last_name_geo_zipped_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_first_last_name_in.py b/test/test_first_last_name_in.py index 4e2f276..bd7a95e 100644 --- a/test/test_first_last_name_in.py +++ b/test/test_first_last_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_first_last_name_origined_out.py b/test/test_first_last_name_origined_out.py index 14bae9d..0651e3f 100644 --- a/test/test_first_last_name_origined_out.py +++ b/test/test_first_last_name_origined_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_first_last_name_out.py b/test/test_first_last_name_out.py index 28ecc75..9b1ebef 100644 --- a/test/test_first_last_name_out.py +++ b/test/test_first_last_name_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_first_last_name_phone_coded_out.py b/test/test_first_last_name_phone_coded_out.py index a94222f..961a46a 100644 --- a/test/test_first_last_name_phone_coded_out.py +++ b/test/test_first_last_name_phone_coded_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_first_last_name_phone_number_geo_in.py b/test/test_first_last_name_phone_number_geo_in.py index a83cd09..d964a35 100644 --- a/test/test_first_last_name_phone_number_geo_in.py +++ b/test/test_first_last_name_phone_number_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_first_last_name_phone_number_in.py b/test/test_first_last_name_phone_number_in.py index 0e5d4c1..b3a1267 100644 --- a/test/test_first_last_name_phone_number_in.py +++ b/test/test_first_last_name_phone_number_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_first_last_name_us_race_ethnicity_out.py b/test/test_first_last_name_us_race_ethnicity_out.py index c795b15..2251b60 100644 --- a/test/test_first_last_name_us_race_ethnicity_out.py +++ b/test/test_first_last_name_us_race_ethnicity_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_general_api.py b/test/test_general_api.py index 639ec7b..5264bac 100644 --- a/test/test_general_api.py +++ b/test/test_general_api.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_japanese_api.py b/test/test_japanese_api.py index b8d6d18..c341a57 100644 --- a/test/test_japanese_api.py +++ b/test/test_japanese_api.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_match_personal_first_last_name_in.py b/test/test_match_personal_first_last_name_in.py index 0969e3a..0cd7aa9 100644 --- a/test/test_match_personal_first_last_name_in.py +++ b/test/test_match_personal_first_last_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_name_geo_in.py b/test/test_name_geo_in.py index 8a8227f..b9ab936 100644 --- a/test/test_name_geo_in.py +++ b/test/test_name_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_name_in.py b/test/test_name_in.py index 28896bc..b2452ae 100644 --- a/test/test_name_in.py +++ b/test/test_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_name_match_candidate_out.py b/test/test_name_match_candidate_out.py index 79a39bc..33efe82 100644 --- a/test/test_name_match_candidate_out.py +++ b/test/test_name_match_candidate_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_name_match_candidates_out.py b/test/test_name_match_candidates_out.py index 0d710aa..ea499e1 100644 --- a/test/test_name_match_candidates_out.py +++ b/test/test_name_match_candidates_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_name_matched_out.py b/test/test_name_matched_out.py index 3740bda..0e9d181 100644 --- a/test/test_name_matched_out.py +++ b/test/test_name_matched_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_personal_api.py b/test/test_personal_api.py index b86beae..6b2bc79 100644 --- a/test/test_personal_api.py +++ b/test/test_personal_api.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ @@ -169,45 +169,31 @@ def test_parse_name_geo_batch(self): """ pass - def test_parsed_gender_batch(self): - """Test case for parsed_gender_batch - - Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. # noqa: E501 - """ - pass - - def test_parsed_gender_geo_batch(self): - """Test case for parsed_gender_geo_batch - - Infer the likely gender of up to 100 fully parsed names, detecting automatically the cultural context. # noqa: E501 - """ - pass - def test_us_race_ethnicity(self): """Test case for us_race_ethnicity - [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). # noqa: E501 + [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). # noqa: E501 """ pass def test_us_race_ethnicity_batch(self): """Test case for us_race_ethnicity_batch - [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. # noqa: E501 + [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). # noqa: E501 """ pass def test_us_race_ethnicity_zip5(self): """Test case for us_race_ethnicity_zip5 - [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). # noqa: E501 + [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). # noqa: E501 """ pass def test_us_zip_race_ethnicity_batch(self): """Test case for us_zip_race_ethnicity_batch - [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. # noqa: E501 + [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. 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). # noqa: E501 """ pass diff --git a/test/test_personal_name_gendered_out.py b/test/test_personal_name_gendered_out.py index 958e1cb..4c5a21a 100644 --- a/test/test_personal_name_gendered_out.py +++ b/test/test_personal_name_gendered_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_personal_name_geo_in.py b/test/test_personal_name_geo_in.py index 48c9f4c..384397c 100644 --- a/test/test_personal_name_geo_in.py +++ b/test/test_personal_name_geo_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_personal_name_geo_out.py b/test/test_personal_name_geo_out.py index 422663c..d8ab106 100644 --- a/test/test_personal_name_geo_out.py +++ b/test/test_personal_name_geo_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_personal_name_in.py b/test/test_personal_name_in.py index d71b3f8..949ab3b 100644 --- a/test/test_personal_name_in.py +++ b/test/test_personal_name_in.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_personal_name_parsed_out.py b/test/test_personal_name_parsed_out.py index 1aa667a..5657568 100644 --- a/test/test_personal_name_parsed_out.py +++ b/test/test_personal_name_parsed_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_proper_noun_categorized_out.py b/test/test_proper_noun_categorized_out.py index a934ea9..5352a39 100644 --- a/test/test_proper_noun_categorized_out.py +++ b/test/test_proper_noun_categorized_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_social_api.py b/test/test_social_api.py index 83f3674..0aa5684 100644 --- a/test/test_social_api.py +++ b/test/test_social_api.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """ diff --git a/test/test_software_version_out.py b/test/test_software_version_out.py index 864357c..a2c26e8 100644 --- a/test/test_software_version_out.py +++ b/test/test_software_version_out.py @@ -3,9 +3,9 @@ """ NamSor API v2 - 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 + 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.13 + OpenAPI spec version: 2.0.15 Contact: contact@namsor.com Generated by: https://openapi-generator.tech """