docs: reverted README and setup.py to include custom features

README.md

@@ -5,7 +5,7 @@ This Python package is automatically generated by the [OpenAPI Generator](https:
 
 - API version: 5.0.0
 - Package version: 5.0.0
-- Generator version: 7.8.0
+- Generator version: 7.5.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
 ## Requirements.
@@ -18,7 +18,7 @@ Python 3.7+
 If the python package is hosted on a repository, you can install directly using:
 
 ```sh
-pip install git+https://github.com/WFP-VAM/DataBridgesAPI.git
+pip install git+https://github.com/WFP-VAM/DataBridgesAPI.git@release/v4.1
 ```
 (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/WFP-VAM/DataBridgesAPI.git`)
 
@@ -55,19 +55,17 @@ import data_bridges_client
 from data_bridges_client.rest import ApiException
 from pprint import pprint
 
-# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.0
+# Configure OAuth2 access token for authorization: default
+KEY = ''
+SECRET = ''
+token = WfpApiToken(api_key=KEY, api_secret=SECRET)
+
+# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/1.4.0
 # See configuration.py for a list of all supported configuration parameters.
 configuration = data_bridges_client.Configuration(
-    host = "https://api.wfp.org/vam-data-bridges/5.0.0"
+    host = "https://api.wfp.org/vam-data-bridges/4.1.0"
 )
-
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-configuration.access_token = os.environ["ACCESS_TOKEN"]
-
+configuration.access_token = token.refresh()
 
 # Enter a context with an instance of the API client
 with data_bridges_client.ApiClient(configuration) as api_client:
@@ -92,7 +90,7 @@ with data_bridges_client.ApiClient(configuration) as api_client:
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.0.0*
+All URIs are relative to *https://api.wfp.org/vam-data-bridges/4.1.0*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -105,15 +103,10 @@ Class | Method | HTTP request | Description
 *EconomicDataApi* | [**economic_data_indicator_list_get**](docs/EconomicDataApi.md#economic_data_indicator_list_get) | **GET** /EconomicData/IndicatorList | Returns the lists of indicators.
 *EconomicDataApi* | [**economic_data_indicator_name_get**](docs/EconomicDataApi.md#economic_data_indicator_name_get) | **GET** /EconomicData/{indicatorName} | Returns the time series of values for different indicators.
 *FoodSecurityApi* | [**food_security_list_get**](docs/FoodSecurityApi.md#food_security_list_get) | **GET** /FoodSecurity/List | 
-*GorpApi* | [**gorp_country_latest_get**](docs/GorpApi.md#gorp_country_latest_get) | **GET** /Gorp/CountryLatest | Return the latest country dataset of number of acutely food insecure (in thousands)  based on WFP Global Operational Response Plan.
-*GorpApi* | [**gorp_global_latest_get**](docs/GorpApi.md#gorp_global_latest_get) | **GET** /Gorp/GlobalLatest | Return the latest global dataset of number of acutely food insecure (in millions)  based on WFP Global Operational Response Plan.
 *GorpApi* | [**gorp_latest_get**](docs/GorpApi.md#gorp_latest_get) | **GET** /Gorp/Latest | Return the latest dataset of number of acutely food insecure (in millions)  based on WFP Global Operational Response Plan.
 *GorpApi* | [**gorp_list_get**](docs/GorpApi.md#gorp_list_get) | **GET** /Gorp/List | Return the full dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan.
-*GorpApi* | [**gorp_regional_latest_get**](docs/GorpApi.md#gorp_regional_latest_get) | **GET** /Gorp/RegionalLatest | Return the latest regional dataset of number of acutely food insecure (in millions)  based on WFP Global Operational Response Plan.
-*IncubationApi* | [**aims_download_all_analysis_rounds_get**](docs/IncubationApi.md#aims_download_all_analysis_rounds_get) | **GET** /Aims/DownloadAllAnalysisRounds | Each asset has a baseline and several rounds. Each round reflects the number of times the asset   has been analysed over time. The number of total rounds changes according to the workstream:   Asset Detection (AD) assets can have a total of 5 rounds, while there is no limit to the monitoring of   Landscape Impact Assessment (LIA) assets. Assets considered for Site Prioritization (SP) have one round only.   Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only).
-*IncubationApi* | [**aims_download_polygon_files_get**](docs/IncubationApi.md#aims_download_polygon_files_get) | **GET** /Aims/DownloadPolygonFiles | Polygon files are available for Landscape Impact Assessment (LIA) assets only.   The file name corresponds to the “Geotrace” name. Please note that adm0code can be obtained   from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only).
-*IncubationApi* | [**household_draft_internal_base_data_get**](docs/IncubationApi.md#household_draft_internal_base_data_get) | **GET** /Household/DraftInternalBaseData | Get data that includes the core household fields only by Survey ID.  To access this data, please contact Wael ATTIA for authorization.   This endpoint will send you only data you have access to, based on permissions assigned to your application profile.   The \"apiKey\" can be found in the profile section of the DataBridges application.
-*IncubationApi* | [**household_full_data_get**](docs/IncubationApi.md#household_full_data_get) | **GET** /Household/FullData | Get a full dataset that includes all the fields included in the survey in addition to the core household fields by Survey ID.  To access this data, please contact Wael ATTIA for authorization.   This endpoint will send you only data you have access to, based on permissions assigned to your application profile.   The \"apiKey\" can be found in the profile section of the DataBridges application.
+*IncubationApi* | [**household_draft_internal_base_data_get**](docs/IncubationApi.md#household_draft_internal_base_data_get) | **GET** /Household/DraftInternalBaseData | Get data that includes the core household fields only by Survey ID
+*IncubationApi* | [**household_full_data_get**](docs/IncubationApi.md#household_full_data_get) | **GET** /Household/FullData | Get a full dataset that includes all the fields included in the survey in addition to the core household fields by Survey ID. To access this data, please contact xxxx for authorization.
 *IncubationApi* | [**household_official_use_base_data_get**](docs/IncubationApi.md#household_official_use_base_data_get) | **GET** /Household/OfficialUseBaseData | Get data that includes the core household fields only by Survey ID
 *IncubationApi* | [**household_public_base_data_get**](docs/IncubationApi.md#household_public_base_data_get) | **GET** /Household/PublicBaseData | Get data that includes the core household fields only by Survey ID
 *IncubationApi* | [**household_surveys_get**](docs/IncubationApi.md#household_surveys_get) | **GET** /Household/Surveys | Retrieve 1) Survey IDs, 2) their corresponding XLS Form IDs, and 3) Base XLS Form of all household surveys conducted in a country.   A date of reference, SurveyDate, for the data collection is set by the officer responsible for the upload for each survey.
@@ -153,9 +146,6 @@ Class | Method | HTTP request | Description
  - [EconomicIndicatorPropertyPagedResult](docs/EconomicIndicatorPropertyPagedResult.md)
  - [Feature](docs/Feature.md)
  - [Geometry](docs/Geometry.md)
- - [GorpCountryApiDto](docs/GorpCountryApiDto.md)
- - [GorpGlobalApiDto](docs/GorpGlobalApiDto.md)
- - [GorpRegionalApiDto](docs/GorpRegionalApiDto.md)
  - [GorpValueWithChanges](docs/GorpValueWithChanges.md)
  - [GorpValueWithChangesPagedResult](docs/GorpValueWithChangesPagedResult.md)
  - [HouseholdSurveyListDTO](docs/HouseholdSurveyListDTO.md)
@@ -226,27 +216,22 @@ Authentication schemes defined for the API:
  - **vamdatabridges_marketprices-priceweekly_get**: vamdatabridges_marketprices-priceweekly_get
  - **vamdatabridges_markets-marketsascsv_get**: vamdatabridges_markets-marketsascsv_get
  - **vamdatabridges_household-publicbasedata_get**: vamdatabridges_household-publicbasedata_get
- - **vamdatabridges_gorp-globallatest_get**: vamdatabridges_gorp-globallatest_get
  - **vamdatabridges_mfi-xlsforms_get**: vamdatabridges_mfi-xlsforms_get
  - **vamdatabridges_economicdata-indicatorlist_get**: vamdatabridges_economicdata-indicatorlist_get
  - **vamdatabridges_markets-geojsonlist_get**: vamdatabridges_markets-geojsonlist_get
- - **vamdatabridges_gorp-regionallatest_get**: vamdatabridges_gorp-regionallatest_get
  - **vamdatabridges_rpme-surveys_get**: vamdatabridges_rpme-surveys_get
  - **vamdatabridges_rpme-xlsforms_get**: vamdatabridges_rpme-xlsforms_get
  - **vamdatabridges_mfi-surveys-basedata_get**: vamdatabridges_mfi-surveys-basedata_get
  - **vamdatabridges_mfi-surveys-fulldata_get**: vamdatabridges_mfi-surveys-fulldata_get
  - **vamdatabridges_household-fulldata_get**: vamdatabridges_household-fulldata_get
  - **vamdatabridges_household-officialusebasedata_get**: vamdatabridges_household-officialusebasedata_get
  - **vamdatabridges_marketprices-pricemonthly_get**: vamdatabridges_marketprices-pricemonthly_get
- - **vamdatabridges_aims-downloadallanalysisrounds_get**: vamdatabridges_aims-downloadallanalysisrounds_get
  - **vamdatabridges_markets-list_get**: vamdatabridges_markets-list_get
  - **vamdatabridges_currency-list_get**: vamdatabridges_currency-list_get
  - **vamdatabridges_gorp-list_get**: vamdatabridges_gorp-list_get
  - **vamdatabridges_marketprices-priceraw_get**: vamdatabridges_marketprices-priceraw_get
  - **vamdatabridges_rpme-variables_get**: vamdatabridges_rpme-variables_get
- - **vamdatabridges_aims-downloadpolygonfiles_get**: vamdatabridges_aims-downloadpolygonfiles_get
  - **vamdatabridges_gorp-latest_get**: vamdatabridges_gorp-latest_get
- - **vamdatabridges_gorp-countrylatest_get**: vamdatabridges_gorp-countrylatest_get
  - **vamdatabridges_currency-usdindirectquotation_get**: vamdatabridges_currency-usdindirectquotation_get
  - **vamdatabridges_xlsforms-definition_get**: vamdatabridges_xlsforms-definition_get
  - **vamdatabridges_household-draftinternalbasedata_get**: vamdatabridges_household-draftinternalbasedata_get

setup.py

@@ -5,7 +5,7 @@
 
     API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern
 
-    The version of the OpenAPI document: 5.0.0
+    The version of the OpenAPI document: 4.0.0
     Contact: wfp.economicanalysis@wfp.org
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -26,6 +26,7 @@
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 2.1.0",
+    "httpx",
     "python-dateutil",
     "pydantic >= 2",
     "typing-extensions >= 4.7.1",
@@ -47,4 +48,4 @@
     API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId&#x3D;cbd1e508-c6e8-459d-96b7-6cac3039c42c&amp;tenantId&#x3D;462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern
     """,  # noqa: E501
     package_data={"data_bridges_client": ["py.typed"]},
-)
+)