WFP-VAM · AlexGherardelli · Apr 13, 2022 · Apr 13, 2022 · Apr 15, 2022 · Apr 22, 2022
diff --git a/.config/data_bridges_api_config.yaml b/.config/data_bridges_api_config.yaml
@@ -0,0 +1,9 @@
+NAME: 'analytics-integration-databridges'
+VERSION : '2.0.0'
+KEY: 'xxx'
+SECRET: 'xxx'
+SCOPES:
+ - 'vamdatabridges_household-fulldata_get'
+ - 'vamdatabridges_household-draftinternalbasedata_get'
+ - 'vamdatabridges_household-officialusebasedata_get'
+ - 'vamdatabridges_household-publicbasedata_get'
diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11"]
 
     steps:
       - uses: actions/checkout@v3

diff --git a/.gitignore b/.gitignore
@@ -64,3 +64,7 @@ target/
 
 #Ipython Notebook
 .ipynb_checkpoints
+
+# Custom
+ROADMAP.md
+config.py
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -33,6 +33,9 @@ data_bridges_client/models/economic_indicator_property.py
 data_bridges_client/models/economic_indicator_property_paged_result.py
 data_bridges_client/models/feature.py
 data_bridges_client/models/geometry.py
+data_bridges_client/models/gorp_country_api_dto.py
+data_bridges_client/models/gorp_global_api_dto.py
+data_bridges_client/models/gorp_regional_api_dto.py
 data_bridges_client/models/gorp_value_with_changes.py
 data_bridges_client/models/gorp_value_with_changes_paged_result.py
 data_bridges_client/models/household_survey_list_dto.py
@@ -93,6 +96,9 @@ docs/Feature.md
 docs/FoodSecurityApi.md
 docs/Geometry.md
 docs/GorpApi.md
+docs/GorpCountryApiDto.md
+docs/GorpGlobalApiDto.md
+docs/GorpRegionalApiDto.md
 docs/GorpValueWithChanges.md
 docs/GorpValueWithChangesPagedResult.md
 docs/HouseholdSurveyListDTO.md
@@ -164,6 +170,9 @@ test/test_feature.py
 test/test_food_security_api.py
 test/test_geometry.py
 test/test_gorp_api.py
+test/test_gorp_country_api_dto.py
+test/test_gorp_global_api_dto.py
+test/test_gorp_regional_api_dto.py
 test/test_gorp_value_with_changes.py
 test/test_gorp_value_with_changes_paged_result.py
 test/test_household_survey_list_dto.py

diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
@@ -1 +1 @@
-7.5.0
+7.6.0
diff --git a/README.md b/README.md
@@ -3,14 +3,14 @@ API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.o
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 4.0.0
-- Package version: 4.0.0
-- Generator version: 7.5.0
+- API version: 4.1.0
+- Package version: 4.1.0
+- Generator version: 7.6.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
 ## Requirements.
 
-Python 3.7+
+Python 3.9+
 
 ## Installation & Usage
 ### pip install
@@ -24,7 +24,8 @@ pip install git+https://github.com/WFP-VAM/DataBridgesAPI.git
 
 Then import the package:
 ```python
-import data_bridges_client
+
+from data_bridges_utils import DataBridgesShapes
 ```
 
 ### Setuptools
@@ -38,7 +39,7 @@ python setup.py install --user
 
 Then import the package:
 ```python
-import data_bridges_client
+from data_bridges_utils import DataBridgesShapes
 ```
 
 ### Tests
@@ -47,50 +48,47 @@ Execute `pytest` to run the tests.
 
 ## Getting Started
 
-Please follow the [installation procedure](#installation--usage) and then run the following:
+
+
+Please follow the [installation procedure](#installation--usage) and then place your API credentials in the ```data_bridges_api_config.yaml```.
+
+The following is a sample script to download household survey data from Data Bridges.
 
 ```python
+"""
+Read Household Data from Data Bridges and load it into STATA.
+Only works if user has STATA 18+ installed and added to PATH.
+"""
+from data_bridges_utils import DataBridgesShapes, load_stata
+
+CONFIG_PATH = r"data_bridges_api_config.yaml"
+
+client = DataBridgesShapes(CONFIG_PATH)
+
+# Get full household data for survey id
+survey_id = 3329 
+access_type = 'full'
+survey_data = client.get_household_survey(survey_id=survey_id, access_type=access_type)
+print(survey_data.head())
 
-import data_bridges_client
-from data_bridges_client.rest import ApiException
-from pprint import pprint
-
-# 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/4.0.0"
-)
-configuration.access_token = token.refresh()
-
-# Enter a context with an instance of the API client
-with data_bridges_client.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = data_bridges_client.CommoditiesApi(api_client)
-    country_code = 'country_code_example' # str | The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code (optional)
-    category_name = 'category_name_example' # str | The name, even partial and case insensitive, of a commodity category. (optional)
-    category_id = 0 # int | The exact ID of a Commodity, as found in /Commodities/List. (optional) (default to 0)
-    page = 1 # int | page number for paged results (optional) (default to 1)
-    format = 'json' # str | Output format: [JSON|CSV] Json is the default value (optional) (default to 'json')
-    env = 'env_example' # str | Environment.   * `prod` - api.vam.wfp.org   * `dev` - dev.api.vam.wfp.org (optional)
-
-    try:
-        # Provides the list of categories.
-        api_response = api_instance.commodities_categories_list_get(country_code=country_code, category_name=category_name, category_id=category_id, page=page, format=format, env=env)
-        print("The response of CommoditiesApi->commodities_categories_list_get:\n")
-        pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling CommoditiesApi->commodities_categories_list_get: %s\n" % e)
+```
+
+## STATA 
 
+STATA users can run the Python script using the [STATA-Python integration](https://www.stata.com/features/overview/pystata-python-integration/), then loading the data directly into a STATA dataframe using the `load_stata` function.
+
+```python
+# Load into STATA dataframe
+ds = load_stata(survey_data)
 ```
 
+**See sample files for further examples**
+
+
+
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://api.wfp.org/vam-data-bridges/4.0.0*
+All URIs are relative to *https://api.wfp.org/vam-data-bridges/4.1.0*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -103,8 +101,13 @@ 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
 *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
@@ -146,6 +149,9 @@ 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)
@@ -216,22 +222,27 @@ 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

diff --git a/data_bridges_api_config.yaml b/data_bridges_api_config.yaml
@@ -0,0 +1,36 @@
+NAME: 'analytics-integration-databridges'
+VERSION : '4.1.0'
+KEY: 'Hjo8WHWVGe5jicksTYgduPmTUEwa'
+SECRET: 'JKL4BjVTG3J4LDYmSZRLCjKK84Ea'
+# KEY3.0: '_9D8S4GtBnJoln7znAb0e8lGrVYa'
+# SECRET3.0: 'nL73B6dAGmJ62dN53zO7NhWe5UYa'
+SCOPES:
+ - 'vamdatabridges_household-fulldata_get'
+ - 'vamdatabridges_household-officialusebase_get'
+ - 'vamdatabridges_household-publicbasedata_get'
+ - 'vamdatabridges_commodities-categories-list_get'
+ - 'vamdatabridges_commodities-list_get'
+ - 'vamdatabridges_commodityunits-conversion-list_get'
+ - 'vamdatabridges_commodityunits-list_get'
+ - 'vamdatabridges_currency-list_get'
+ - 'vamdatabridges_currency-usdindirectquotation_get'
+ - 'vamdatabridges_economicdata-indicatorlist_get'
+ - 'vamdatabridges_economicdata_get'
+ - 'vamdatabridges_foodsecurity-list_get'
+ - 'vamdatabridges_gorp-latest_get'
+ - 'vamdatabridges_gorp-list_get'
+ - 'vamdatabridges_household-surveys_get'
+ - 'vamdatabridges_marketprices-alps_get'
+ - 'vamdatabridges_marketprices-pricedaily_get'
+ - 'vamdatabridges_marketprices-pricemonthly_get'
+ - 'vamdatabridges_marketprices-priceweekly_get'
+ - 'vamdatabridges_markets-geojsonlist_get'
+ - 'vamdatabridges_markets-list_get'
+ - 'vamdatabridges_markets-marketsascsv_get'
+ - 'vamdatabridges_markets-nearbymarkets_get'
+ - 'vamdatabridges_mfi-surveys-basedata_get'
+ - 'vamdatabridges_mfi-surveys-fulldata_get'
+ - 'vamdatabridges_mfi-surveys-processeddata_get'
+ - 'vamdatabridges_mfi-surveys_get'
+ - 'vamdatabridges_mfi-xlsforms_get'
+
diff --git a/data_bridges_api_config_sample.yaml b/data_bridges_api_config_sample.yaml
@@ -0,0 +1,9 @@
+NAME: ''
+VERSION : ''
+KEY: ''
+SECRET: ''
+KEY3.0: ''
+SECRET3.0: ''
+SCOPES:
+ - ''
+ - ''
diff --git a/data_bridges_client/__init__.py b/data_bridges_client/__init__.py
@@ -7,15 +7,15 @@
 
     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: 4.0.0
+    The version of the OpenAPI document: 4.1.0
     Contact: [email protected]
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
 """  # noqa: E501
 
 
-__version__ = "1.0.0"
+__version__ = "4.1.0"
 
 # import apis into sdk package
 from data_bridges_client.api.commodities_api import CommoditiesApi
@@ -54,6 +54,9 @@
 from data_bridges_client.models.economic_indicator_property_paged_result import EconomicIndicatorPropertyPagedResult
 from data_bridges_client.models.feature import Feature
 from data_bridges_client.models.geometry import Geometry
+from data_bridges_client.models.gorp_country_api_dto import GorpCountryApiDto
+from data_bridges_client.models.gorp_global_api_dto import GorpGlobalApiDto
+from data_bridges_client.models.gorp_regional_api_dto import GorpRegionalApiDto
 from data_bridges_client.models.gorp_value_with_changes import GorpValueWithChanges
 from data_bridges_client.models.gorp_value_with_changes_paged_result import GorpValueWithChangesPagedResult
 from data_bridges_client.models.household_survey_list_dto import HouseholdSurveyListDTO