Merge pull request #26 from WFP-VAM/release/v5.0

Release/v5.0

.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

.openapi-generator/VERSION

@@ -1 +1 @@
-7.5.0
+7.8.0

README.md

@@ -3,8 +3,8 @@ 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
+- API version: 5.0.0
+- Package version: 5.0.0
 - Generator version: 7.5.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
@@ -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/v5.0
 ```
 (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/WFP-VAM/DataBridgesAPI.git`)
 
@@ -53,19 +53,21 @@ Please follow the [installation procedure](#installation--usage) and then run th
 
 import data_bridges_client
 from data_bridges_client.rest import ApiException
+from data_bridges_client.token import WfpApiToken
 from pprint import pprint
 
 # Configure OAuth2 access token for authorization: default
 KEY = ''
 SECRET = ''
+SCOPES = ['', '']
 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"
+    host = "https://api.wfp.org/vam-data-bridges/5.0.0"
 )
-configuration.access_token = token.refresh()
+configuration.access_token = token.refresh(scopes=SCOPES)
 
 # Enter a context with an instance of the API client
 with data_bridges_client.ApiClient(configuration) as api_client:
@@ -90,7 +92,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/4.0.0*
+All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.0.0*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------

data_bridges_client/__init__.py

@@ -7,7 +7,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: 4.0.0
+    The version of the OpenAPI document: 5.0.0
     Contact: wfp.economicanalysis@wfp.org
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -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

data_bridges_client/api/commodities_api.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: 4.0.0
+    The version of the OpenAPI document: 5.0.0
     Contact: wfp.economicanalysis@wfp.org
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -64,7 +64,7 @@ def commodities_categories_list_get(
     ) -> PagedCommodityListDTO:
         """Provides the list of categories.
 
-          [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()  [![Generic badge](https://img.shields.io/badge/Access_Policy-Approval_Required-yellow)]()  [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()  ### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodities-categories-list_get\"  Categories are matched with high level WFP commodity classification at level 1. No mandatory parameter.    **Data Controller** - Wael Attia  **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern
+          [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()  [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()  [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()  ### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodities-categories-list_get\"  Categories are matched with high level WFP commodity classification at level 1. No mandatory parameter.    **Data Controller** - Wael ATTIA  **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern
 
         :param country_code: The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code
         :type country_code: str
@@ -152,7 +152,7 @@ def commodities_categories_list_get_with_http_info(
     ) -> ApiResponse[PagedCommodityListDTO]:
         """Provides the list of categories.
 
-          [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()  [![Generic badge](https://img.shields.io/badge/Access_Policy-Approval_Required-yellow)]()  [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()  ### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodities-categories-list_get\"  Categories are matched with high level WFP commodity classification at level 1. No mandatory parameter.    **Data Controller** - Wael Attia  **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern
+          [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()  [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()  [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()  ### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodities-categories-list_get\"  Categories are matched with high level WFP commodity classification at level 1. No mandatory parameter.    **Data Controller** - Wael ATTIA  **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern
 
         :param country_code: The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code
         :type country_code: str
@@ -240,7 +240,7 @@ def commodities_categories_list_get_without_preload_content(
     ) -> RESTResponseType:
         """Provides the list of categories.
 
-          [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()  [![Generic badge](https://img.shields.io/badge/Access_Policy-Approval_Required-yellow)]()  [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()  ### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodities-categories-list_get\"  Categories are matched with high level WFP commodity classification at level 1. No mandatory parameter.    **Data Controller** - Wael Attia  **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern
+          [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()  [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()  [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()  ### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodities-categories-list_get\"  Categories are matched with high level WFP commodity classification at level 1. No mandatory parameter.    **Data Controller** - Wael ATTIA  **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern
 
         :param country_code: The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code
         :type country_code: str
@@ -358,13 +358,14 @@ def _commodities_categories_list_get_serialize(
 
 
         # set the HTTP header `Accept`
-        _header_params['Accept'] = self.api_client.select_header_accept(
-            [
-                'text/plain', 
-                'application/json', 
-                'text/json'
-            ]
-        )
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'text/plain', 
+                    'application/json', 
+                    'text/json'
+                ]
+            )
 
 
         # authentication setting
@@ -414,7 +415,7 @@ def commodities_list_get(
     ) -> PagedCommodityListDTO:
         """Provide the detailed list of the commodities available in DataBridges platform
 
-          [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()  [![Generic badge](https://img.shields.io/badge/Access_Policy-Approval_Required-yellow)]()  [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()  ### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodities-list_get\"  COICOP 2018 codes are returned to hierarchically matching categories based on [UN-Statistical Division codes](https://unstats.un.org/unsd/classifications/Econ/). No mandatory parameter.    **Data Controller** - Wael Attia  **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern
+          [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()  [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()  [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()  ### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodities-list_get\"  COICOP 2018 codes are returned to hierarchically matching categories based on [UN-Statistical Division codes](https://unstats.un.org/unsd/classifications/Econ/). No mandatory parameter.    **Data Controller** - Wael ATTIA  **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern
 
         :param country_code: The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code
         :type country_code: str
@@ -502,7 +503,7 @@ def commodities_list_get_with_http_info(
     ) -> ApiResponse[PagedCommodityListDTO]:
         """Provide the detailed list of the commodities available in DataBridges platform
 
-          [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()  [![Generic badge](https://img.shields.io/badge/Access_Policy-Approval_Required-yellow)]()  [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()  ### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodities-list_get\"  COICOP 2018 codes are returned to hierarchically matching categories based on [UN-Statistical Division codes](https://unstats.un.org/unsd/classifications/Econ/). No mandatory parameter.    **Data Controller** - Wael Attia  **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern
+          [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()  [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()  [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()  ### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodities-list_get\"  COICOP 2018 codes are returned to hierarchically matching categories based on [UN-Statistical Division codes](https://unstats.un.org/unsd/classifications/Econ/). No mandatory parameter.    **Data Controller** - Wael ATTIA  **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern
 
         :param country_code: The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code
         :type country_code: str
@@ -590,7 +591,7 @@ def commodities_list_get_without_preload_content(
     ) -> RESTResponseType:
         """Provide the detailed list of the commodities available in DataBridges platform
 
-          [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()  [![Generic badge](https://img.shields.io/badge/Access_Policy-Approval_Required-yellow)]()  [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()  ### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodities-list_get\"  COICOP 2018 codes are returned to hierarchically matching categories based on [UN-Statistical Division codes](https://unstats.un.org/unsd/classifications/Econ/). No mandatory parameter.    **Data Controller** - Wael Attia  **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern
+          [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()  [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()  [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()  ### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodities-list_get\"  COICOP 2018 codes are returned to hierarchically matching categories based on [UN-Statistical Division codes](https://unstats.un.org/unsd/classifications/Econ/). No mandatory parameter.    **Data Controller** - Wael ATTIA  **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern
 
         :param country_code: The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code
         :type country_code: str
@@ -708,13 +709,14 @@ def _commodities_list_get_serialize(
 
 
         # set the HTTP header `Accept`
-        _header_params['Accept'] = self.api_client.select_header_accept(
-            [
-                'text/plain', 
-                'application/json', 
-                'text/json'
-            ]
-        )
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'text/plain', 
+                    'application/json', 
+                    'text/json'
+                ]
+            )
 
 
         # authentication setting