From 7f927741d4ca30d21b1611496d474b82628310ab Mon Sep 17 00:00:00 2001 From: Alessandra Gherardelli Date: Thu, 23 May 2024 12:17:07 +0200 Subject: [PATCH 1/7] Updated .gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index 43995bd..d764623 100644 --- a/.gitignore +++ b/.gitignore @@ -64,3 +64,5 @@ target/ #Ipython Notebook .ipynb_checkpoints +data_bridges_api_config.yaml +ROADMAP.md \ No newline at end of file From 2c7ea30064ec7353759edc447995d0fe6ebd252b Mon Sep 17 00:00:00 2001 From: Alessandra Gherardelli Date: Tue, 10 Sep 2024 13:03:57 +0200 Subject: [PATCH 2/7] Generated API client for v5.0 --- .gitignore | 2 - .openapi-generator/FILES | 9 + .openapi-generator/VERSION | 2 +- README.md | 43 +- data_bridges_client/__init__.py | 5 +- data_bridges_client/api/commodities_api.py | 44 +- .../api/commodity_units_api.py | 44 +- data_bridges_client/api/currency_api.py | 44 +- data_bridges_client/api/economic_data_api.py | 44 +- data_bridges_client/api/food_security_api.py | 23 +- data_bridges_client/api/gorp_api.py | 845 +++++++++++++++++- data_bridges_client/api/incubation_api.py | 731 +++++++++++++-- data_bridges_client/api/market_prices_api.py | 107 +-- data_bridges_client/api/markets_api.py | 78 +- data_bridges_client/api/rpme_api.py | 124 +-- data_bridges_client/api/surveys_api.py | 82 +- data_bridges_client/api/xls_forms_api.py | 19 +- data_bridges_client/api_client.py | 38 +- data_bridges_client/configuration.py | 26 +- data_bridges_client/exceptions.py | 2 +- data_bridges_client/models/__init__.py | 5 +- data_bridges_client/models/bad_request_dto.py | 2 +- data_bridges_client/models/commodity_dto.py | 14 +- .../models/commodity_price_dto.py | 2 +- .../models/commodity_processing_dto.py | 2 +- .../models/commodity_quality_dto.py | 2 +- data_bridges_client/models/currency_dto.py | 2 +- .../models/economic_data_dto.py | 2 +- .../models/economic_indicator_property.py | 2 +- ...conomic_indicator_property_paged_result.py | 8 +- data_bridges_client/models/feature.py | 2 +- data_bridges_client/models/geometry.py | 2 +- .../models/gorp_country_api_dto.py | 122 +++ .../models/gorp_global_api_dto.py | 129 +++ .../models/gorp_regional_api_dto.py | 129 +++ .../models/gorp_value_with_changes.py | 2 +- .../gorp_value_with_changes_paged_result.py | 8 +- .../models/household_survey_list_dto.py | 32 +- .../household_survey_list_dto_paged_result.py | 8 +- data_bridges_client/models/ipc_value.py | 2 +- .../models/ipc_value_paged_result.py | 8 +- data_bridges_client/models/key_name_dto.py | 2 +- data_bridges_client/models/market_dto.py | 2 +- .../models/market_geo_json_root.py | 8 +- .../models/mfi_processed_data_dto.py | 2 +- .../models/nearby_markets_dto.py | 2 +- .../models/paged_commodity_list_dto.py | 8 +- .../models/paged_commodity_price_list_dto.py | 8 +- ...modity_weekly_aggregated_price_list_dto.py | 8 +- .../models/paged_currency_list_dto.py | 8 +- .../models/paged_economic_data_dto.py | 8 +- .../models/paged_market_list_dto.py | 8 +- .../models/paged_processed_data_dto.py | 8 +- .../models/paged_survey_list_dto.py | 8 +- .../models/paged_survey_responses_dto.py | 2 +- .../models/paged_xls_form_list_dto.py | 8 +- data_bridges_client/models/problem_details.py | 2 +- data_bridges_client/models/properties.py | 2 +- data_bridges_client/models/rpme_assessment.py | 8 +- .../models/rpme_assessment_paged_result.py | 8 +- .../models/rpme_output_values.py | 2 +- data_bridges_client/models/rpme_variable.py | 2 +- .../models/rpme_variable_paged_result.py | 8 +- data_bridges_client/models/survey_list_dto.py | 2 +- .../models/usd_indirect_quotation.py | 2 +- .../usd_indirect_quotation_paged_result.py | 8 +- .../models/view_extended_aggregated_price.py | 2 +- ..._extended_aggregated_price_paged_result.py | 8 +- .../models/view_extended_alps_value.py | 2 +- .../view_extended_alps_value_paged_result.py | 8 +- .../models/weekly_aggregated_price.py | 2 +- .../xls_form_definition_new_schema_dto.py | 8 +- data_bridges_client/models/xls_form_dto.py | 2 +- .../models/xls_form_fields_dto.py | 2 +- .../models/xls_form_list_choice_dto.py | 2 +- .../models/xls_form_list_choices_dto.py | 8 +- data_bridges_client/rest.py | 2 +- docs/CommoditiesApi.md | 14 +- docs/CommodityUnitsApi.md | 14 +- docs/CurrencyApi.md | 14 +- docs/EconomicDataApi.md | 14 +- docs/FoodSecurityApi.md | 8 +- docs/GorpApi.md | 245 ++++- docs/GorpCountryApiDto.md | 32 + docs/GorpGlobalApiDto.md | 33 + docs/GorpRegionalApiDto.md | 33 + docs/HouseholdSurveyListDTO.md | 4 +- docs/IncubationApi.md | 220 ++++- docs/MarketPricesApi.md | 32 +- docs/MarketsApi.md | 26 +- docs/RpmeApi.md | 38 +- docs/SurveysApi.md | 26 +- docs/XlsFormsApi.md | 8 +- generate/README.md | 5 +- openapitools.json | 7 + pyproject.toml | 2 +- setup.py | 3 +- test/test_bad_request_dto.py | 4 +- test/test_commodities_api.py | 2 +- test/test_commodity_dto.py | 4 +- test/test_commodity_price_dto.py | 4 +- test/test_commodity_processing_dto.py | 4 +- test/test_commodity_quality_dto.py | 4 +- test/test_commodity_units_api.py | 2 +- test/test_currency_api.py | 2 +- test/test_currency_dto.py | 4 +- test/test_economic_data_api.py | 2 +- test/test_economic_data_dto.py | 4 +- test/test_economic_indicator_property.py | 4 +- ...conomic_indicator_property_paged_result.py | 4 +- test/test_feature.py | 4 +- test/test_food_security_api.py | 2 +- test/test_geometry.py | 4 +- test/test_gorp_api.py | 23 +- test/test_gorp_country_api_dto.py | 55 ++ test/test_gorp_global_api_dto.py | 56 ++ test/test_gorp_regional_api_dto.py | 56 ++ test/test_gorp_value_with_changes.py | 4 +- ...st_gorp_value_with_changes_paged_result.py | 4 +- test/test_household_survey_list_dto.py | 10 +- ..._household_survey_list_dto_paged_result.py | 4 +- test/test_incubation_api.py | 20 +- test/test_ipc_value.py | 4 +- test/test_ipc_value_paged_result.py | 4 +- test/test_key_name_dto.py | 4 +- test/test_market_dto.py | 4 +- test/test_market_geo_json_root.py | 4 +- test/test_market_prices_api.py | 2 +- test/test_markets_api.py | 2 +- test/test_mfi_processed_data_dto.py | 4 +- test/test_nearby_markets_dto.py | 4 +- test/test_paged_commodity_list_dto.py | 4 +- test/test_paged_commodity_price_list_dto.py | 4 +- ...modity_weekly_aggregated_price_list_dto.py | 4 +- test/test_paged_currency_list_dto.py | 4 +- test/test_paged_economic_data_dto.py | 4 +- test/test_paged_market_list_dto.py | 4 +- test/test_paged_processed_data_dto.py | 4 +- test/test_paged_survey_list_dto.py | 4 +- test/test_paged_survey_responses_dto.py | 4 +- test/test_paged_xls_form_list_dto.py | 4 +- test/test_problem_details.py | 4 +- test/test_properties.py | 4 +- test/test_rpme_api.py | 2 +- test/test_rpme_assessment.py | 4 +- test/test_rpme_assessment_paged_result.py | 4 +- test/test_rpme_output_values.py | 4 +- test/test_rpme_variable.py | 4 +- test/test_rpme_variable_paged_result.py | 4 +- test/test_survey_list_dto.py | 4 +- test/test_surveys_api.py | 2 +- test/test_usd_indirect_quotation.py | 4 +- ...est_usd_indirect_quotation_paged_result.py | 4 +- test/test_view_extended_aggregated_price.py | 4 +- ..._extended_aggregated_price_paged_result.py | 4 +- test/test_view_extended_alps_value.py | 4 +- ...t_view_extended_alps_value_paged_result.py | 4 +- test/test_weekly_aggregated_price.py | 4 +- ...test_xls_form_definition_new_schema_dto.py | 4 +- test/test_xls_form_dto.py | 4 +- test/test_xls_form_fields_dto.py | 4 +- test/test_xls_form_list_choice_dto.py | 4 +- test/test_xls_form_list_choices_dto.py | 4 +- test/test_xls_forms_api.py | 2 +- 164 files changed, 3391 insertions(+), 808 deletions(-) create mode 100644 data_bridges_client/models/gorp_country_api_dto.py create mode 100644 data_bridges_client/models/gorp_global_api_dto.py create mode 100644 data_bridges_client/models/gorp_regional_api_dto.py create mode 100644 docs/GorpCountryApiDto.md create mode 100644 docs/GorpGlobalApiDto.md create mode 100644 docs/GorpRegionalApiDto.md create mode 100644 openapitools.json create mode 100644 test/test_gorp_country_api_dto.py create mode 100644 test/test_gorp_global_api_dto.py create mode 100644 test/test_gorp_regional_api_dto.py diff --git a/.gitignore b/.gitignore index d764623..43995bd 100644 --- a/.gitignore +++ b/.gitignore @@ -64,5 +64,3 @@ target/ #Ipython Notebook .ipynb_checkpoints -data_bridges_api_config.yaml -ROADMAP.md \ No newline at end of file diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index c2acb95..008f688 100644 --- 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 index 18bb418..09a6d30 100644 --- a/.openapi-generator/VERSION +++ b/.openapi-generator/VERSION @@ -1 +1 @@ -7.5.0 +7.8.0 diff --git a/README.md b/README.md index c6ddaae..0eb630a 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ 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: 5.0.0 +- Package version: 1.0.0 +- Generator version: 7.8.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen ## Requirements. @@ -55,17 +55,19 @@ 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 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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() + +# 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"] + # 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 ------------ | ------------- | ------------- | ------------- @@ -103,10 +105,15 @@ 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. -*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. +*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_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. @@ -146,6 +153,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,9 +226,11 @@ 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 @@ -226,12 +238,15 @@ Authentication schemes defined for the API: - **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_client/__init__.py b/data_bridges_client/__init__.py index cb9a661..2337b93 100644 --- a/data_bridges_client/__init__.py +++ b/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 diff --git a/data_bridges_client/api/commodities_api.py b/data_bridges_client/api/commodities_api.py index 2be6747..503a405 100644 --- a/data_bridges_client/api/commodities_api.py +++ b/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 diff --git a/data_bridges_client/api/commodity_units_api.py b/data_bridges_client/api/commodity_units_api.py index b13ce4b..7d315ae 100644 --- a/data_bridges_client/api/commodity_units_api.py +++ b/data_bridges_client/api/commodity_units_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) @@ -65,7 +65,7 @@ def commodity_units_conversion_list_get( ) -> PagedCommodityListDTO: """Provides conversion factors to Kilogram or Litres for each convertible unit of measure. - [![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_commodityunits-conversion-list_get\" Some non-standard units of measure might have different a conversion factor based on the country [Adm0Code]; Other non-standard units of measure might have a different conversion factor based on the commodity [CommodityID] being measured. Other cases will have null adm0code and CommodityID. 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_commodityunits-conversion-list_get\" Some non-standard units of measure might have different a conversion factor based on the country [Adm0Code]; Other non-standard units of measure might have a different conversion factor based on the commodity [CommodityID] being measured. Other cases will have null adm0code and CommodityID. 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 @@ -157,7 +157,7 @@ def commodity_units_conversion_list_get_with_http_info( ) -> ApiResponse[PagedCommodityListDTO]: """Provides conversion factors to Kilogram or Litres for each convertible unit of measure. - [![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_commodityunits-conversion-list_get\" Some non-standard units of measure might have different a conversion factor based on the country [Adm0Code]; Other non-standard units of measure might have a different conversion factor based on the commodity [CommodityID] being measured. Other cases will have null adm0code and CommodityID. 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_commodityunits-conversion-list_get\" Some non-standard units of measure might have different a conversion factor based on the country [Adm0Code]; Other non-standard units of measure might have a different conversion factor based on the commodity [CommodityID] being measured. Other cases will have null adm0code and CommodityID. 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 @@ -249,7 +249,7 @@ def commodity_units_conversion_list_get_without_preload_content( ) -> RESTResponseType: """Provides conversion factors to Kilogram or Litres for each convertible unit of measure. - [![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_commodityunits-conversion-list_get\" Some non-standard units of measure might have different a conversion factor based on the country [Adm0Code]; Other non-standard units of measure might have a different conversion factor based on the commodity [CommodityID] being measured. Other cases will have null adm0code and CommodityID. 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_commodityunits-conversion-list_get\" Some non-standard units of measure might have different a conversion factor based on the country [Adm0Code]; Other non-standard units of measure might have a different conversion factor based on the commodity [CommodityID] being measured. Other cases will have null adm0code and CommodityID. 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 @@ -375,13 +375,14 @@ def _commodity_units_conversion_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 @@ -431,7 +432,7 @@ def commodity_units_list_get( ) -> PagedCommodityListDTO: """Provides the detailed list of the unit of measure 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_commodityunits-list_get\" **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_commodityunits-list_get\" **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 @@ -519,7 +520,7 @@ def commodity_units_list_get_with_http_info( ) -> ApiResponse[PagedCommodityListDTO]: """Provides the detailed list of the unit of measure 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_commodityunits-list_get\" **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_commodityunits-list_get\" **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 @@ -607,7 +608,7 @@ def commodity_units_list_get_without_preload_content( ) -> RESTResponseType: """Provides the detailed list of the unit of measure 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_commodityunits-list_get\" **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_commodityunits-list_get\" **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 @@ -725,13 +726,14 @@ def _commodity_units_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 diff --git a/data_bridges_client/api/currency_api.py b/data_bridges_client/api/currency_api.py index 72f32b5..f60a306 100644 --- a/data_bridges_client/api/currency_api.py +++ b/data_bridges_client/api/currency_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) @@ -65,7 +65,7 @@ def currency_list_get( ) -> PagedCurrencyListDTO: """Returns the list of currencies available in the internal VAM database, with Currency 3-letter code, matching with ISO 4217. - [![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_currency-list_get\" **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_currency-list_get\" **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 @@ -153,7 +153,7 @@ def currency_list_get_with_http_info( ) -> ApiResponse[PagedCurrencyListDTO]: """Returns the list of currencies available in the internal VAM database, with Currency 3-letter code, matching with ISO 4217. - [![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_currency-list_get\" **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_currency-list_get\" **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 @@ -241,7 +241,7 @@ def currency_list_get_without_preload_content( ) -> RESTResponseType: """Returns the list of currencies available in the internal VAM database, with Currency 3-letter code, matching with ISO 4217. - [![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_currency-list_get\" **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_currency-list_get\" **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 @@ -359,13 +359,14 @@ def _currency_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 currency_usd_indirect_quotation_get( ) -> UsdIndirectQuotationPagedResult: """Returns the value of the Exchange rates from Trading Economics, for official rates, and DataViz for unofficial rates. - [![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_currency-usdindirectquotation_get\" Returns the time series of values of the Exchange rate of the Local Currency for buying 1 USD in the official market. Original frequency for official rates is daily, non-indicated. Unofficial rates are aggregated at national level by the original frequency of collection. For greater detail on unofficial exchange rates, explore the Exchange Rate (unofficial) commodity in Market Prices Prices. 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_currency-usdindirectquotation_get\" Returns the time series of values of the Exchange rate of the Local Currency for buying 1 USD in the official market. Original frequency for official rates is daily, non-indicated. Unofficial rates are aggregated at national level by the original frequency of collection. For greater detail on unofficial exchange rates, explore the Exchange Rate (unofficial) commodity in Market Prices Prices. 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_iso3: The code to identify the country. Must be a ISO-3166 Alpha 3 code. :type country_iso3: str @@ -498,7 +499,7 @@ def currency_usd_indirect_quotation_get_with_http_info( ) -> ApiResponse[UsdIndirectQuotationPagedResult]: """Returns the value of the Exchange rates from Trading Economics, for official rates, and DataViz for unofficial rates. - [![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_currency-usdindirectquotation_get\" Returns the time series of values of the Exchange rate of the Local Currency for buying 1 USD in the official market. Original frequency for official rates is daily, non-indicated. Unofficial rates are aggregated at national level by the original frequency of collection. For greater detail on unofficial exchange rates, explore the Exchange Rate (unofficial) commodity in Market Prices Prices. 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_currency-usdindirectquotation_get\" Returns the time series of values of the Exchange rate of the Local Currency for buying 1 USD in the official market. Original frequency for official rates is daily, non-indicated. Unofficial rates are aggregated at national level by the original frequency of collection. For greater detail on unofficial exchange rates, explore the Exchange Rate (unofficial) commodity in Market Prices Prices. 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_iso3: The code to identify the country. Must be a ISO-3166 Alpha 3 code. :type country_iso3: str @@ -582,7 +583,7 @@ def currency_usd_indirect_quotation_get_without_preload_content( ) -> RESTResponseType: """Returns the value of the Exchange rates from Trading Economics, for official rates, and DataViz for unofficial rates. - [![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_currency-usdindirectquotation_get\" Returns the time series of values of the Exchange rate of the Local Currency for buying 1 USD in the official market. Original frequency for official rates is daily, non-indicated. Unofficial rates are aggregated at national level by the original frequency of collection. For greater detail on unofficial exchange rates, explore the Exchange Rate (unofficial) commodity in Market Prices Prices. 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_currency-usdindirectquotation_get\" Returns the time series of values of the Exchange rate of the Local Currency for buying 1 USD in the official market. Original frequency for official rates is daily, non-indicated. Unofficial rates are aggregated at national level by the original frequency of collection. For greater detail on unofficial exchange rates, explore the Exchange Rate (unofficial) commodity in Market Prices Prices. 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_iso3: The code to identify the country. Must be a ISO-3166 Alpha 3 code. :type country_iso3: str @@ -692,13 +693,14 @@ def _currency_usd_indirect_quotation_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 diff --git a/data_bridges_client/api/economic_data_api.py b/data_bridges_client/api/economic_data_api.py index 83a4f7e..6e1d1e2 100644 --- a/data_bridges_client/api/economic_data_api.py +++ b/data_bridges_client/api/economic_data_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) @@ -65,7 +65,7 @@ def economic_data_indicator_list_get( ) -> EconomicIndicatorPropertyPagedResult: """Returns the lists of indicators. - [![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_economicdata-indicatorlist_get\" Returns the lists of indicators for which Vulnerability Analysis and Mapping - Economic and Market Analysis Unit has redistribution licensing from Trading Economics. 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_economicdata-indicatorlist_get\" Returns the lists of indicators for which Vulnerability Analysis and Mapping - Economic and Market Analysis Unit has redistribution licensing from Trading Economics. 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 page: Page number for paged results :type page: int @@ -149,7 +149,7 @@ def economic_data_indicator_list_get_with_http_info( ) -> ApiResponse[EconomicIndicatorPropertyPagedResult]: """Returns the lists of indicators. - [![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_economicdata-indicatorlist_get\" Returns the lists of indicators for which Vulnerability Analysis and Mapping - Economic and Market Analysis Unit has redistribution licensing from Trading Economics. 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_economicdata-indicatorlist_get\" Returns the lists of indicators for which Vulnerability Analysis and Mapping - Economic and Market Analysis Unit has redistribution licensing from Trading Economics. 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 page: Page number for paged results :type page: int @@ -233,7 +233,7 @@ def economic_data_indicator_list_get_without_preload_content( ) -> RESTResponseType: """Returns the lists of indicators. - [![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_economicdata-indicatorlist_get\" Returns the lists of indicators for which Vulnerability Analysis and Mapping - Economic and Market Analysis Unit has redistribution licensing from Trading Economics. 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_economicdata-indicatorlist_get\" Returns the lists of indicators for which Vulnerability Analysis and Mapping - Economic and Market Analysis Unit has redistribution licensing from Trading Economics. 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 page: Page number for paged results :type page: int @@ -343,13 +343,14 @@ def _economic_data_indicator_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 @@ -400,7 +401,7 @@ def economic_data_indicator_name_get( ) -> PagedEconomicDataDTO: """Returns the time series of values for different indicators. - [![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_economicdata_get\" Indicator name as retrieved from /EconomicData/IndicatorList is mandatory. **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_economicdata_get\" Indicator name as retrieved from /EconomicData/IndicatorList is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param indicator_name: Name of the indicator as found in /EconomicData/IndicatorList. (required) :type indicator_name: str @@ -493,7 +494,7 @@ def economic_data_indicator_name_get_with_http_info( ) -> ApiResponse[PagedEconomicDataDTO]: """Returns the time series of values for different indicators. - [![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_economicdata_get\" Indicator name as retrieved from /EconomicData/IndicatorList is mandatory. **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_economicdata_get\" Indicator name as retrieved from /EconomicData/IndicatorList is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param indicator_name: Name of the indicator as found in /EconomicData/IndicatorList. (required) :type indicator_name: str @@ -586,7 +587,7 @@ def economic_data_indicator_name_get_without_preload_content( ) -> RESTResponseType: """Returns the time series of values for different indicators. - [![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_economicdata_get\" Indicator name as retrieved from /EconomicData/IndicatorList is mandatory. **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_economicdata_get\" Indicator name as retrieved from /EconomicData/IndicatorList is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param indicator_name: Name of the indicator as found in /EconomicData/IndicatorList. (required) :type indicator_name: str @@ -729,13 +730,14 @@ def _economic_data_indicator_name_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 diff --git a/data_bridges_client/api/food_security_api.py b/data_bridges_client/api/food_security_api.py index c642bf0..dddc430 100644 --- a/data_bridges_client/api/food_security_api.py +++ b/data_bridges_client/api/food_security_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) @@ -62,7 +62,7 @@ def food_security_list_get( ) -> IpcValuePagedResult: """food_security_list_get - [![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_foodsecurity-list_get\" **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_foodsecurity-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param iso3: The country ISO3 code :type iso3: str @@ -142,7 +142,7 @@ def food_security_list_get_with_http_info( ) -> ApiResponse[IpcValuePagedResult]: """food_security_list_get - [![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_foodsecurity-list_get\" **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_foodsecurity-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param iso3: The country ISO3 code :type iso3: str @@ -222,7 +222,7 @@ def food_security_list_get_without_preload_content( ) -> RESTResponseType: """food_security_list_get - [![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_foodsecurity-list_get\" **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_foodsecurity-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param iso3: The country ISO3 code :type iso3: str @@ -324,13 +324,14 @@ def _food_security_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 diff --git a/data_bridges_client/api/gorp_api.py b/data_bridges_client/api/gorp_api.py index d55f42d..d2b498e 100644 --- a/data_bridges_client/api/gorp_api.py +++ b/data_bridges_client/api/gorp_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) @@ -18,8 +18,11 @@ from typing_extensions import Annotated from pydantic import Field, StrictInt, StrictStr, field_validator -from typing import Optional +from typing import List, Optional from typing_extensions import Annotated +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_paged_result import GorpValueWithChangesPagedResult from data_bridges_client.api_client import ApiClient, RequestSerialized @@ -40,6 +43,538 @@ def __init__(self, api_client=None) -> None: self.api_client = api_client + @validate_call + def gorp_country_latest_get( + self, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[GorpCountryApiDto]: + """Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan. + + [![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_gorp-countrylatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._gorp_country_latest_get_serialize( + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[GorpCountryApiDto]", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def gorp_country_latest_get_with_http_info( + self, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[GorpCountryApiDto]]: + """Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan. + + [![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_gorp-countrylatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._gorp_country_latest_get_serialize( + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[GorpCountryApiDto]", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def gorp_country_latest_get_without_preload_content( + self, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan. + + [![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_gorp-countrylatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._gorp_country_latest_get_serialize( + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[GorpCountryApiDto]", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _gorp_country_latest_get_serialize( + self, + env, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if env is not None: + + _query_params.append(('env', env)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'text/plain', + 'application/json', + 'text/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'default' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/Gorp/CountryLatest', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def gorp_global_latest_get( + self, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> GorpGlobalApiDto: + """Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + + [![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_gorp-globallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._gorp_global_latest_get_serialize( + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GorpGlobalApiDto", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def gorp_global_latest_get_with_http_info( + self, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[GorpGlobalApiDto]: + """Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + + [![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_gorp-globallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._gorp_global_latest_get_serialize( + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GorpGlobalApiDto", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def gorp_global_latest_get_without_preload_content( + self, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + + [![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_gorp-globallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._gorp_global_latest_get_serialize( + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GorpGlobalApiDto", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _gorp_global_latest_get_serialize( + self, + env, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if env is not None: + + _query_params.append(('env', env)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'text/plain', + 'application/json', + 'text/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'default' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/Gorp/GlobalLatest', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def gorp_latest_get( self, @@ -60,7 +595,7 @@ def gorp_latest_get( ) -> GorpValueWithChangesPagedResult: """Return the latest dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. - [![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_gorp-latest_get\" **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_gorp-latest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param page: :type page: int @@ -132,7 +667,7 @@ def gorp_latest_get_with_http_info( ) -> ApiResponse[GorpValueWithChangesPagedResult]: """Return the latest dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. - [![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_gorp-latest_get\" **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_gorp-latest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param page: :type page: int @@ -204,7 +739,7 @@ def gorp_latest_get_without_preload_content( ) -> RESTResponseType: """Return the latest dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. - [![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_gorp-latest_get\" **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_gorp-latest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param page: :type page: int @@ -290,13 +825,14 @@ def _gorp_latest_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 @@ -342,7 +878,7 @@ def gorp_list_get( ) -> GorpValueWithChangesPagedResult: """Return the full dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. - [![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_gorp-list_get\" **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_gorp-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param page: :type page: int @@ -414,7 +950,7 @@ def gorp_list_get_with_http_info( ) -> ApiResponse[GorpValueWithChangesPagedResult]: """Return the full dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. - [![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_gorp-list_get\" **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_gorp-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param page: :type page: int @@ -486,7 +1022,7 @@ def gorp_list_get_without_preload_content( ) -> RESTResponseType: """Return the full dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. - [![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_gorp-list_get\" **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_gorp-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param page: :type page: int @@ -572,13 +1108,280 @@ def _gorp_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 + _auth_settings: List[str] = [ + 'default' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/Gorp/List', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def gorp_regional_latest_get( + self, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> List[GorpRegionalApiDto]: + """Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + + [![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_gorp-regionallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._gorp_regional_latest_get_serialize( + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[GorpRegionalApiDto]", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def gorp_regional_latest_get_with_http_info( + self, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[List[GorpRegionalApiDto]]: + """Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + + [![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_gorp-regionallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._gorp_regional_latest_get_serialize( + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[GorpRegionalApiDto]", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def gorp_regional_latest_get_without_preload_content( + self, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + + [![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_gorp-regionallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._gorp_regional_latest_get_serialize( + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "List[GorpRegionalApiDto]", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response + + + def _gorp_regional_latest_get_serialize( + self, + env, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if env is not None: + + _query_params.append(('env', env)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'text/plain', + 'application/json', + 'text/json' + ] + ) # authentication setting @@ -588,7 +1391,7 @@ def _gorp_list_get_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/Gorp/List', + resource_path='/Gorp/RegionalLatest', path_params=_path_params, query_params=_query_params, header_params=_header_params, diff --git a/data_bridges_client/api/incubation_api.py b/data_bridges_client/api/incubation_api.py index 5e3f4f8..fab1f95 100644 --- a/data_bridges_client/api/incubation_api.py +++ b/data_bridges_client/api/incubation_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) @@ -43,9 +43,552 @@ def __init__(self, api_client=None) -> None: self.api_client = api_client + @validate_call + def aims_download_all_analysis_rounds_get( + self, + adm0_code: Annotated[StrictInt, Field(description="The country adm0Code")], + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """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). + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadallanalysisrounds_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param adm0_code: The country adm0Code (required) + :type adm0_code: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._aims_download_all_analysis_rounds_get_serialize( + adm0_code=adm0_code, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def aims_download_all_analysis_rounds_get_with_http_info( + self, + adm0_code: Annotated[StrictInt, Field(description="The country adm0Code")], + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """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). + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadallanalysisrounds_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param adm0_code: The country adm0Code (required) + :type adm0_code: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._aims_download_all_analysis_rounds_get_serialize( + adm0_code=adm0_code, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def aims_download_all_analysis_rounds_get_without_preload_content( + self, + adm0_code: Annotated[StrictInt, Field(description="The country adm0Code")], + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """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). + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadallanalysisrounds_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param adm0_code: The country adm0Code (required) + :type adm0_code: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._aims_download_all_analysis_rounds_get_serialize( + adm0_code=adm0_code, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _aims_download_all_analysis_rounds_get_serialize( + self, + adm0_code, + env, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if adm0_code is not None: + + _query_params.append(('adm0Code', adm0_code)) + + if env is not None: + + _query_params.append(('env', env)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'default' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/Aims/DownloadAllAnalysisRounds', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def aims_download_polygon_files_get( + self, + adm0_code: Annotated[StrictInt, Field(description="The country adm0Code")], + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """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). + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadpolygonfiles_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param adm0_code: The country adm0Code (required) + :type adm0_code: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._aims_download_polygon_files_get_serialize( + adm0_code=adm0_code, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def aims_download_polygon_files_get_with_http_info( + self, + adm0_code: Annotated[StrictInt, Field(description="The country adm0Code")], + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """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). + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadpolygonfiles_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param adm0_code: The country adm0Code (required) + :type adm0_code: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._aims_download_polygon_files_get_serialize( + adm0_code=adm0_code, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def aims_download_polygon_files_get_without_preload_content( + self, + adm0_code: Annotated[StrictInt, Field(description="The country adm0Code")], + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """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). + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadpolygonfiles_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param adm0_code: The country adm0Code (required) + :type adm0_code: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._aims_download_polygon_files_get_serialize( + adm0_code=adm0_code, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _aims_download_polygon_files_get_serialize( + self, + adm0_code, + env, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if adm0_code is not None: + + _query_params.append(('adm0Code', adm0_code)) + + if env is not None: + + _query_params.append(('env', env)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'default' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/Aims/DownloadPolygonFiles', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def household_draft_internal_base_data_get( self, + api_key: StrictStr, survey_id: Annotated[Optional[StrictInt], Field(description="unique identifier for the collected data, as retrieved from /Surveys API.")] = None, page: Annotated[Optional[StrictInt], Field(description="page number for paged results")] = None, page_size: Annotated[Optional[StrictInt], Field(description="page size for paged results, default value is 20.")] = None, @@ -63,10 +606,12 @@ def household_draft_internal_base_data_get( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> PagedSurveyResponsesDTO: - """Get data that includes the core household fields only by Survey ID + """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. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-draftinternalbasedata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-draftinternalbasedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + :param api_key: (required) + :type api_key: str :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int :param page: page number for paged results @@ -98,6 +643,7 @@ def household_draft_internal_base_data_get( """ # noqa: E501 _param = self._household_draft_internal_base_data_get_serialize( + api_key=api_key, survey_id=survey_id, page=page, page_size=page_size, @@ -111,6 +657,7 @@ def household_draft_internal_base_data_get( _response_types_map: Dict[str, Optional[str]] = { '200': "PagedSurveyResponsesDTO", '400': "BadRequestDTO", + '403': "ProblemDetails", '404': "ProblemDetails", } response_data = self.api_client.call_api( @@ -127,6 +674,7 @@ def household_draft_internal_base_data_get( @validate_call def household_draft_internal_base_data_get_with_http_info( self, + api_key: StrictStr, survey_id: Annotated[Optional[StrictInt], Field(description="unique identifier for the collected data, as retrieved from /Surveys API.")] = None, page: Annotated[Optional[StrictInt], Field(description="page number for paged results")] = None, page_size: Annotated[Optional[StrictInt], Field(description="page size for paged results, default value is 20.")] = None, @@ -144,10 +692,12 @@ def household_draft_internal_base_data_get_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[PagedSurveyResponsesDTO]: - """Get data that includes the core household fields only by Survey ID + """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. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-draftinternalbasedata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-draftinternalbasedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + :param api_key: (required) + :type api_key: str :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int :param page: page number for paged results @@ -179,6 +729,7 @@ def household_draft_internal_base_data_get_with_http_info( """ # noqa: E501 _param = self._household_draft_internal_base_data_get_serialize( + api_key=api_key, survey_id=survey_id, page=page, page_size=page_size, @@ -192,6 +743,7 @@ def household_draft_internal_base_data_get_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "PagedSurveyResponsesDTO", '400': "BadRequestDTO", + '403': "ProblemDetails", '404': "ProblemDetails", } response_data = self.api_client.call_api( @@ -208,6 +760,7 @@ def household_draft_internal_base_data_get_with_http_info( @validate_call def household_draft_internal_base_data_get_without_preload_content( self, + api_key: StrictStr, survey_id: Annotated[Optional[StrictInt], Field(description="unique identifier for the collected data, as retrieved from /Surveys API.")] = None, page: Annotated[Optional[StrictInt], Field(description="page number for paged results")] = None, page_size: Annotated[Optional[StrictInt], Field(description="page size for paged results, default value is 20.")] = None, @@ -225,10 +778,12 @@ def household_draft_internal_base_data_get_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Get data that includes the core household fields only by Survey ID + """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. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-draftinternalbasedata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-draftinternalbasedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + :param api_key: (required) + :type api_key: str :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int :param page: page number for paged results @@ -260,6 +815,7 @@ def household_draft_internal_base_data_get_without_preload_content( """ # noqa: E501 _param = self._household_draft_internal_base_data_get_serialize( + api_key=api_key, survey_id=survey_id, page=page, page_size=page_size, @@ -273,6 +829,7 @@ def household_draft_internal_base_data_get_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "PagedSurveyResponsesDTO", '400': "BadRequestDTO", + '403': "ProblemDetails", '404': "ProblemDetails", } response_data = self.api_client.call_api( @@ -284,6 +841,7 @@ def household_draft_internal_base_data_get_without_preload_content( def _household_draft_internal_base_data_get_serialize( self, + api_key, survey_id, page, page_size, @@ -308,6 +866,10 @@ def _household_draft_internal_base_data_get_serialize( # process the path parameters # process the query parameters + if api_key is not None: + + _query_params.append(('apiKey', api_key)) + if survey_id is not None: _query_params.append(('surveyID', survey_id)) @@ -330,13 +892,14 @@ def _household_draft_internal_base_data_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 @@ -365,6 +928,7 @@ def _household_draft_internal_base_data_get_serialize( @validate_call def household_full_data_get( self, + api_key: StrictStr, survey_id: Annotated[Optional[StrictInt], Field(description="unique identifier for the collected data, as retrieved from /Surveys API.")] = None, format: Annotated[Optional[StrictStr], Field(description="Output format: [JSON|CSV] Json is the default value")] = None, page: Annotated[Optional[StrictInt], Field(description="page number for paged results")] = None, @@ -383,10 +947,12 @@ def household_full_data_get( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> PagedSurveyResponsesDTO: - """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. + """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. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-fulldata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-fulldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + :param api_key: (required) + :type api_key: str :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int :param format: Output format: [JSON|CSV] Json is the default value @@ -420,6 +986,7 @@ def household_full_data_get( """ # noqa: E501 _param = self._household_full_data_get_serialize( + api_key=api_key, survey_id=survey_id, format=format, page=page, @@ -434,6 +1001,7 @@ def household_full_data_get( _response_types_map: Dict[str, Optional[str]] = { '200': "PagedSurveyResponsesDTO", '400': "BadRequestDTO", + '403': "ProblemDetails", '404': "ProblemDetails", } response_data = self.api_client.call_api( @@ -450,6 +1018,7 @@ def household_full_data_get( @validate_call def household_full_data_get_with_http_info( self, + api_key: StrictStr, survey_id: Annotated[Optional[StrictInt], Field(description="unique identifier for the collected data, as retrieved from /Surveys API.")] = None, format: Annotated[Optional[StrictStr], Field(description="Output format: [JSON|CSV] Json is the default value")] = None, page: Annotated[Optional[StrictInt], Field(description="page number for paged results")] = None, @@ -468,10 +1037,12 @@ def household_full_data_get_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[PagedSurveyResponsesDTO]: - """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. + """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. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-fulldata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-fulldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + :param api_key: (required) + :type api_key: str :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int :param format: Output format: [JSON|CSV] Json is the default value @@ -505,6 +1076,7 @@ def household_full_data_get_with_http_info( """ # noqa: E501 _param = self._household_full_data_get_serialize( + api_key=api_key, survey_id=survey_id, format=format, page=page, @@ -519,6 +1091,7 @@ def household_full_data_get_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "PagedSurveyResponsesDTO", '400': "BadRequestDTO", + '403': "ProblemDetails", '404': "ProblemDetails", } response_data = self.api_client.call_api( @@ -535,6 +1108,7 @@ def household_full_data_get_with_http_info( @validate_call def household_full_data_get_without_preload_content( self, + api_key: StrictStr, survey_id: Annotated[Optional[StrictInt], Field(description="unique identifier for the collected data, as retrieved from /Surveys API.")] = None, format: Annotated[Optional[StrictStr], Field(description="Output format: [JSON|CSV] Json is the default value")] = None, page: Annotated[Optional[StrictInt], Field(description="page number for paged results")] = None, @@ -553,10 +1127,12 @@ def household_full_data_get_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """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. + """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. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-fulldata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-fulldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + :param api_key: (required) + :type api_key: str :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int :param format: Output format: [JSON|CSV] Json is the default value @@ -590,6 +1166,7 @@ def household_full_data_get_without_preload_content( """ # noqa: E501 _param = self._household_full_data_get_serialize( + api_key=api_key, survey_id=survey_id, format=format, page=page, @@ -604,6 +1181,7 @@ def household_full_data_get_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "PagedSurveyResponsesDTO", '400': "BadRequestDTO", + '403': "ProblemDetails", '404': "ProblemDetails", } response_data = self.api_client.call_api( @@ -615,6 +1193,7 @@ def household_full_data_get_without_preload_content( def _household_full_data_get_serialize( self, + api_key, survey_id, format, page, @@ -640,6 +1219,10 @@ def _household_full_data_get_serialize( # process the path parameters # process the query parameters + if api_key is not None: + + _query_params.append(('apiKey', api_key)) + if survey_id is not None: _query_params.append(('surveyID', survey_id)) @@ -666,13 +1249,14 @@ def _household_full_data_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 @@ -720,7 +1304,7 @@ def household_official_use_base_data_get( ) -> PagedSurveyResponsesDTO: """Get data that includes the core household fields only by Survey ID - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-officialusebasedata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-officialusebasedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -801,7 +1385,7 @@ def household_official_use_base_data_get_with_http_info( ) -> ApiResponse[PagedSurveyResponsesDTO]: """Get data that includes the core household fields only by Survey ID - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-officialusebasedata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-officialusebasedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -882,7 +1466,7 @@ def household_official_use_base_data_get_without_preload_content( ) -> RESTResponseType: """Get data that includes the core household fields only by Survey ID - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-officialusebasedata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-officialusebasedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -985,13 +1569,14 @@ def _household_official_use_base_data_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 @@ -1039,7 +1624,7 @@ def household_public_base_data_get( ) -> PagedSurveyResponsesDTO: """Get data that includes the core household fields only by Survey ID - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-publicbasedata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-publicbasedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -1120,7 +1705,7 @@ def household_public_base_data_get_with_http_info( ) -> ApiResponse[PagedSurveyResponsesDTO]: """Get data that includes the core household fields only by Survey ID - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-publicbasedata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-publicbasedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -1201,7 +1786,7 @@ def household_public_base_data_get_without_preload_content( ) -> RESTResponseType: """Get data that includes the core household fields only by Survey ID - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-publicbasedata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-publicbasedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -1304,13 +1889,14 @@ def _household_public_base_data_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 @@ -1343,6 +1929,7 @@ def household_surveys_get( page: Annotated[Optional[StrictInt], Field(description="page number for paged results")] = None, start_date: Annotated[Optional[datetime], Field(description="starting date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24)")] = None, end_date: Annotated[Optional[datetime], Field(description="ending date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24)")] = None, + survey_id: Optional[StrictInt] = None, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ None, @@ -1359,7 +1946,7 @@ def household_surveys_get( ) -> HouseholdSurveyListDTOPagedResult: """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. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![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_household-surveys_get\" **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-Incubation-red)]() [![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_household-surveys_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -1369,6 +1956,8 @@ def household_surveys_get( :type start_date: datetime :param end_date: ending date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24) :type end_date: datetime + :param survey_id: + :type survey_id: int :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str :param _request_timeout: timeout setting for this request. If one @@ -1398,6 +1987,7 @@ def household_surveys_get( page=page, start_date=start_date, end_date=end_date, + survey_id=survey_id, env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -1427,6 +2017,7 @@ def household_surveys_get_with_http_info( page: Annotated[Optional[StrictInt], Field(description="page number for paged results")] = None, start_date: Annotated[Optional[datetime], Field(description="starting date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24)")] = None, end_date: Annotated[Optional[datetime], Field(description="ending date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24)")] = None, + survey_id: Optional[StrictInt] = None, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ None, @@ -1443,7 +2034,7 @@ def household_surveys_get_with_http_info( ) -> ApiResponse[HouseholdSurveyListDTOPagedResult]: """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. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![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_household-surveys_get\" **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-Incubation-red)]() [![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_household-surveys_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -1453,6 +2044,8 @@ def household_surveys_get_with_http_info( :type start_date: datetime :param end_date: ending date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24) :type end_date: datetime + :param survey_id: + :type survey_id: int :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str :param _request_timeout: timeout setting for this request. If one @@ -1482,6 +2075,7 @@ def household_surveys_get_with_http_info( page=page, start_date=start_date, end_date=end_date, + survey_id=survey_id, env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -1511,6 +2105,7 @@ def household_surveys_get_without_preload_content( page: Annotated[Optional[StrictInt], Field(description="page number for paged results")] = None, start_date: Annotated[Optional[datetime], Field(description="starting date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24)")] = None, end_date: Annotated[Optional[datetime], Field(description="ending date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24)")] = None, + survey_id: Optional[StrictInt] = None, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ None, @@ -1527,7 +2122,7 @@ def household_surveys_get_without_preload_content( ) -> RESTResponseType: """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. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![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_household-surveys_get\" **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-Incubation-red)]() [![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_household-surveys_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -1537,6 +2132,8 @@ def household_surveys_get_without_preload_content( :type start_date: datetime :param end_date: ending date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24) :type end_date: datetime + :param survey_id: + :type survey_id: int :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str :param _request_timeout: timeout setting for this request. If one @@ -1566,6 +2163,7 @@ def household_surveys_get_without_preload_content( page=page, start_date=start_date, end_date=end_date, + survey_id=survey_id, env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -1590,6 +2188,7 @@ def _household_surveys_get_serialize( page, start_date, end_date, + survey_id, env, _request_auth, _content_type, @@ -1645,6 +2244,10 @@ def _household_surveys_get_serialize( else: _query_params.append(('endDate', end_date)) + if survey_id is not None: + + _query_params.append(('surveyId', survey_id)) + if env is not None: _query_params.append(('env', env)) @@ -1655,11 +2258,12 @@ def _household_surveys_get_serialize( # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) # authentication setting @@ -1705,7 +2309,7 @@ def xls_forms_definition_get( ) -> List[XlsFormDefinitionNewSchemaDTO]: """Get a complete set of XLS Form definitions of a given XLS Form ID. This is the digital version of the questionnaire used during the data collection exercise. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![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_xlsforms-definition_get\" **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-Incubation-red)]() [![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_xlsforms-definition_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param xls_form_id: unique identifier for the XLS Form, as retrieved from /XLSForms :type xls_form_id: int @@ -1777,7 +2381,7 @@ def xls_forms_definition_get_with_http_info( ) -> ApiResponse[List[XlsFormDefinitionNewSchemaDTO]]: """Get a complete set of XLS Form definitions of a given XLS Form ID. This is the digital version of the questionnaire used during the data collection exercise. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![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_xlsforms-definition_get\" **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-Incubation-red)]() [![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_xlsforms-definition_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param xls_form_id: unique identifier for the XLS Form, as retrieved from /XLSForms :type xls_form_id: int @@ -1849,7 +2453,7 @@ def xls_forms_definition_get_without_preload_content( ) -> RESTResponseType: """Get a complete set of XLS Form definitions of a given XLS Form ID. This is the digital version of the questionnaire used during the data collection exercise. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![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_xlsforms-definition_get\" **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-Incubation-red)]() [![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_xlsforms-definition_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param xls_form_id: unique identifier for the XLS Form, as retrieved from /XLSForms :type xls_form_id: int @@ -1935,11 +2539,12 @@ def _xls_forms_definition_get_serialize( # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) # authentication setting diff --git a/data_bridges_client/api/market_prices_api.py b/data_bridges_client/api/market_prices_api.py index 53a610f..63110a2 100644 --- a/data_bridges_client/api/market_prices_api.py +++ b/data_bridges_client/api/market_prices_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) @@ -74,7 +74,7 @@ def market_prices_alps_get( ) -> ViewExtendedAlpsValuePagedResult: """Returns time series values of ALPS and PEWI. - [![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_marketprices-alps_get\" Returns the full time series of the Alert for Price Spikes (ALPS) and the value of the Price Early Warning Index (PEWI). Methodology is available in [DataViz](https://dataviz.vam.wfp.org/) and [VAM-Resource Centre](https://resources.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-alps_get\" Returns the full time series of the Alert for Price Spikes (ALPS) and the value of the Price Early Warning Index (PEWI). Methodology is available in [DataViz](https://dataviz.vam.wfp.org/) and [VAM-Resource Centre](https://resources.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -186,7 +186,7 @@ def market_prices_alps_get_with_http_info( ) -> ApiResponse[ViewExtendedAlpsValuePagedResult]: """Returns time series values of ALPS and PEWI. - [![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_marketprices-alps_get\" Returns the full time series of the Alert for Price Spikes (ALPS) and the value of the Price Early Warning Index (PEWI). Methodology is available in [DataViz](https://dataviz.vam.wfp.org/) and [VAM-Resource Centre](https://resources.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-alps_get\" Returns the full time series of the Alert for Price Spikes (ALPS) and the value of the Price Early Warning Index (PEWI). Methodology is available in [DataViz](https://dataviz.vam.wfp.org/) and [VAM-Resource Centre](https://resources.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -298,7 +298,7 @@ def market_prices_alps_get_without_preload_content( ) -> RESTResponseType: """Returns time series values of ALPS and PEWI. - [![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_marketprices-alps_get\" Returns the full time series of the Alert for Price Spikes (ALPS) and the value of the Price Early Warning Index (PEWI). Methodology is available in [DataViz](https://dataviz.vam.wfp.org/) and [VAM-Resource Centre](https://resources.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-alps_get\" Returns the full time series of the Alert for Price Spikes (ALPS) and the value of the Price Early Warning Index (PEWI). Methodology is available in [DataViz](https://dataviz.vam.wfp.org/) and [VAM-Resource Centre](https://resources.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -482,13 +482,14 @@ def _market_prices_alps_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 @@ -544,7 +545,7 @@ def market_prices_price_daily_get( ) -> ViewExtendedAggregatedPricePagedResult: """Returns a daily time series of commodity market prices. - [![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_marketprices-pricedaily_get\" This is the highest frequency available. Data is flagged according to its pre-processing characteristics. Actual data is collected originally with daily frequency; aggregated data returns an empty list; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in DataLibrary. For specific methodological notes on forecasts and imputations refer to the dedicated page in DataViz. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-pricedaily_get\" This is the highest frequency available. Data is flagged according to its pre-processing characteristics. Actual data is collected originally with daily frequency; aggregated data returns an empty list; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in DataLibrary. For specific methodological notes on forecasts and imputations refer to the dedicated page in DataViz. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -656,7 +657,7 @@ def market_prices_price_daily_get_with_http_info( ) -> ApiResponse[ViewExtendedAggregatedPricePagedResult]: """Returns a daily time series of commodity market prices. - [![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_marketprices-pricedaily_get\" This is the highest frequency available. Data is flagged according to its pre-processing characteristics. Actual data is collected originally with daily frequency; aggregated data returns an empty list; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in DataLibrary. For specific methodological notes on forecasts and imputations refer to the dedicated page in DataViz. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-pricedaily_get\" This is the highest frequency available. Data is flagged according to its pre-processing characteristics. Actual data is collected originally with daily frequency; aggregated data returns an empty list; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in DataLibrary. For specific methodological notes on forecasts and imputations refer to the dedicated page in DataViz. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -768,7 +769,7 @@ def market_prices_price_daily_get_without_preload_content( ) -> RESTResponseType: """Returns a daily time series of commodity market prices. - [![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_marketprices-pricedaily_get\" This is the highest frequency available. Data is flagged according to its pre-processing characteristics. Actual data is collected originally with daily frequency; aggregated data returns an empty list; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in DataLibrary. For specific methodological notes on forecasts and imputations refer to the dedicated page in DataViz. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-pricedaily_get\" This is the highest frequency available. Data is flagged according to its pre-processing characteristics. Actual data is collected originally with daily frequency; aggregated data returns an empty list; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in DataLibrary. For specific methodological notes on forecasts and imputations refer to the dedicated page in DataViz. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -952,13 +953,14 @@ def _market_prices_price_daily_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 @@ -1014,7 +1016,7 @@ def market_prices_price_monthly_get( ) -> ViewExtendedAggregatedPricePagedResult: """Returns a monthly time series of commodity market prices. - [![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_marketprices-pricemonthly_get\" This is the lowest frequency available and the most complete data source. Data is flagged according to its pre-processing characteristics. actual data is collected originally with monthly frequency; aggregated data is collected with higher frequency (daily or weekly) averaged through a weighted mean to monthly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-pricemonthly_get\" This is the lowest frequency available and the most complete data source. Data is flagged according to its pre-processing characteristics. actual data is collected originally with monthly frequency; aggregated data is collected with higher frequency (daily or weekly) averaged through a weighted mean to monthly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -1126,7 +1128,7 @@ def market_prices_price_monthly_get_with_http_info( ) -> ApiResponse[ViewExtendedAggregatedPricePagedResult]: """Returns a monthly time series of commodity market prices. - [![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_marketprices-pricemonthly_get\" This is the lowest frequency available and the most complete data source. Data is flagged according to its pre-processing characteristics. actual data is collected originally with monthly frequency; aggregated data is collected with higher frequency (daily or weekly) averaged through a weighted mean to monthly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-pricemonthly_get\" This is the lowest frequency available and the most complete data source. Data is flagged according to its pre-processing characteristics. actual data is collected originally with monthly frequency; aggregated data is collected with higher frequency (daily or weekly) averaged through a weighted mean to monthly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -1238,7 +1240,7 @@ def market_prices_price_monthly_get_without_preload_content( ) -> RESTResponseType: """Returns a monthly time series of commodity market prices. - [![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_marketprices-pricemonthly_get\" This is the lowest frequency available and the most complete data source. Data is flagged according to its pre-processing characteristics. actual data is collected originally with monthly frequency; aggregated data is collected with higher frequency (daily or weekly) averaged through a weighted mean to monthly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-pricemonthly_get\" This is the lowest frequency available and the most complete data source. Data is flagged according to its pre-processing characteristics. actual data is collected originally with monthly frequency; aggregated data is collected with higher frequency (daily or weekly) averaged through a weighted mean to monthly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -1422,13 +1424,14 @@ def _market_prices_price_monthly_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 @@ -1484,7 +1487,7 @@ def market_prices_price_raw_get( ) -> PagedCommodityPriceListDTO: """Returns original commodity market prices - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-priceraw_get\" Restricted endpoint. Returns the original data with the entire Commodity Price Metadata as inserted by the focal point, which might contain sensitive or personal informatio. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-priceraw_get\" Restricted endpoint. Returns the original data with the entire Commodity Price Metadata as inserted by the focal point, which might contain sensitive or personal informatio. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -1596,7 +1599,7 @@ def market_prices_price_raw_get_with_http_info( ) -> ApiResponse[PagedCommodityPriceListDTO]: """Returns original commodity market prices - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-priceraw_get\" Restricted endpoint. Returns the original data with the entire Commodity Price Metadata as inserted by the focal point, which might contain sensitive or personal informatio. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-priceraw_get\" Restricted endpoint. Returns the original data with the entire Commodity Price Metadata as inserted by the focal point, which might contain sensitive or personal informatio. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -1708,7 +1711,7 @@ def market_prices_price_raw_get_without_preload_content( ) -> RESTResponseType: """Returns original commodity market prices - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-priceraw_get\" Restricted endpoint. Returns the original data with the entire Commodity Price Metadata as inserted by the focal point, which might contain sensitive or personal informatio. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-priceraw_get\" Restricted endpoint. Returns the original data with the entire Commodity Price Metadata as inserted by the focal point, which might contain sensitive or personal informatio. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -1892,13 +1895,14 @@ def _market_prices_price_raw_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 @@ -1954,7 +1958,7 @@ def market_prices_price_weekly_get( ) -> PagedCommodityWeeklyAggregatedPriceListDTO: """Returns a weekly time series of commodity market prices. - [![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_marketprices-priceweekly_get\" Weeks used as reference are the International Organization for Standardization (ISO) week-numbering year (ISO-8601). Data is flagged according to its pre-processing characteristics. Aactual data is collected originally with weekly frequency; aggregated data is collected with higher frequency (daily) averaged through a weighted mean to weekly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-priceweekly_get\" Weeks used as reference are the International Organization for Standardization (ISO) week-numbering year (ISO-8601). Data is flagged according to its pre-processing characteristics. Aactual data is collected originally with weekly frequency; aggregated data is collected with higher frequency (daily) averaged through a weighted mean to weekly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -2066,7 +2070,7 @@ def market_prices_price_weekly_get_with_http_info( ) -> ApiResponse[PagedCommodityWeeklyAggregatedPriceListDTO]: """Returns a weekly time series of commodity market prices. - [![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_marketprices-priceweekly_get\" Weeks used as reference are the International Organization for Standardization (ISO) week-numbering year (ISO-8601). Data is flagged according to its pre-processing characteristics. Aactual data is collected originally with weekly frequency; aggregated data is collected with higher frequency (daily) averaged through a weighted mean to weekly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-priceweekly_get\" Weeks used as reference are the International Organization for Standardization (ISO) week-numbering year (ISO-8601). Data is flagged according to its pre-processing characteristics. Aactual data is collected originally with weekly frequency; aggregated data is collected with higher frequency (daily) averaged through a weighted mean to weekly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -2178,7 +2182,7 @@ def market_prices_price_weekly_get_without_preload_content( ) -> RESTResponseType: """Returns a weekly time series of commodity market prices. - [![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_marketprices-priceweekly_get\" Weeks used as reference are the International Organization for Standardization (ISO) week-numbering year (ISO-8601). Data is flagged according to its pre-processing characteristics. Aactual data is collected originally with weekly frequency; aggregated data is collected with higher frequency (daily) averaged through a weighted mean to weekly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-priceweekly_get\" Weeks used as reference are the International Organization for Standardization (ISO) week-numbering year (ISO-8601). Data is flagged according to its pre-processing characteristics. Aactual data is collected originally with weekly frequency; aggregated data is collected with higher frequency (daily) averaged through a weighted mean to weekly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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 @@ -2362,13 +2366,14 @@ def _market_prices_price_weekly_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 diff --git a/data_bridges_client/api/markets_api.py b/data_bridges_client/api/markets_api.py index 072b165..2bfd53d 100644 --- a/data_bridges_client/api/markets_api.py +++ b/data_bridges_client/api/markets_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) @@ -62,7 +62,7 @@ def markets_geo_json_list_get( ) -> MarketGeoJsonRoot: """Provide a list of geo referenced markets in a specific country - [![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_markets-geojsonlist_get\" **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_markets-geojsonlist_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0code: The admin code of the country :type adm0code: int @@ -134,7 +134,7 @@ def markets_geo_json_list_get_with_http_info( ) -> ApiResponse[MarketGeoJsonRoot]: """Provide a list of geo referenced markets in a specific country - [![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_markets-geojsonlist_get\" **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_markets-geojsonlist_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0code: The admin code of the country :type adm0code: int @@ -206,7 +206,7 @@ def markets_geo_json_list_get_without_preload_content( ) -> RESTResponseType: """Provide a list of geo referenced markets in a specific country - [![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_markets-geojsonlist_get\" **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_markets-geojsonlist_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0code: The admin code of the country :type adm0code: int @@ -292,11 +292,12 @@ def _markets_geo_json_list_get_serialize( # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/geo+json' - ] - ) + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/geo+json' + ] + ) # authentication setting @@ -344,7 +345,7 @@ def markets_list_get( ) -> PagedMarketListDTO: """Get a complete list of markets in a country - [![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_markets-list_get\" **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_markets-list_get\" **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 @@ -423,7 +424,7 @@ def markets_list_get_with_http_info( ) -> ApiResponse[PagedMarketListDTO]: """Get a complete list of markets in a country - [![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_markets-list_get\" **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_markets-list_get\" **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 markets_list_get_without_preload_content( ) -> RESTResponseType: """Get a complete list of markets in a country - [![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_markets-list_get\" **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_markets-list_get\" **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 @@ -603,13 +604,14 @@ def _markets_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 @@ -656,7 +658,7 @@ def markets_markets_as_csv_get( ) -> bytearray: """Get a complete list of markets in a country - [![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_markets-marketsascsv_get\" **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_markets-marketsascsv_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0code: The admin code of the country :type adm0code: int @@ -731,7 +733,7 @@ def markets_markets_as_csv_get_with_http_info( ) -> ApiResponse[bytearray]: """Get a complete list of markets in a country - [![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_markets-marketsascsv_get\" **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_markets-marketsascsv_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0code: The admin code of the country :type adm0code: int @@ -806,7 +808,7 @@ def markets_markets_as_csv_get_without_preload_content( ) -> RESTResponseType: """Get a complete list of markets in a country - [![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_markets-marketsascsv_get\" **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_markets-marketsascsv_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0code: The admin code of the country :type adm0code: int @@ -899,13 +901,14 @@ def _markets_markets_as_csv_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 @@ -953,7 +956,7 @@ def markets_nearby_markets_get( ) -> List[NearbyMarketsDTO]: """Find markets near a given location by longitude and latitude within a 15Km distance - [![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_markets-nearbymarkets_get\" **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_markets-nearbymarkets_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0code: int @@ -1033,7 +1036,7 @@ def markets_nearby_markets_get_with_http_info( ) -> ApiResponse[List[NearbyMarketsDTO]]: """Find markets near a given location by longitude and latitude within a 15Km distance - [![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_markets-nearbymarkets_get\" **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_markets-nearbymarkets_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0code: int @@ -1113,7 +1116,7 @@ def markets_nearby_markets_get_without_preload_content( ) -> RESTResponseType: """Find markets near a given location by longitude and latitude within a 15Km distance - [![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_markets-nearbymarkets_get\" **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_markets-nearbymarkets_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0code: int @@ -1215,11 +1218,12 @@ def _markets_nearby_markets_get_serialize( # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) # authentication setting diff --git a/data_bridges_client/api/rpme_api.py b/data_bridges_client/api/rpme_api.py index a3ed70a..db3134e 100644 --- a/data_bridges_client/api/rpme_api.py +++ b/data_bridges_client/api/rpme_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) @@ -67,7 +67,7 @@ def rpme_base_data_get( ) -> PagedSurveyResponsesDTO: """Get data that includes the core RPME fields only by Survey ID - [![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_rpme-basedata_get\" **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_rpme-basedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -148,7 +148,7 @@ def rpme_base_data_get_with_http_info( ) -> ApiResponse[PagedSurveyResponsesDTO]: """Get data that includes the core RPME fields only by Survey ID - [![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_rpme-basedata_get\" **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_rpme-basedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -229,7 +229,7 @@ def rpme_base_data_get_without_preload_content( ) -> RESTResponseType: """Get data that includes the core RPME fields only by Survey ID - [![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_rpme-basedata_get\" **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_rpme-basedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -332,13 +332,14 @@ def _rpme_base_data_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 @@ -387,7 +388,7 @@ def rpme_full_data_get( ) -> PagedSurveyResponsesDTO: """Get a full dataset that includes all the fields included in the survey in addition to the core RPME fields by Survey ID. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_rpme-fulldata_get\" **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%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_rpme-fulldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -472,7 +473,7 @@ def rpme_full_data_get_with_http_info( ) -> ApiResponse[PagedSurveyResponsesDTO]: """Get a full dataset that includes all the fields included in the survey in addition to the core RPME fields by Survey ID. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_rpme-fulldata_get\" **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%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_rpme-fulldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -557,7 +558,7 @@ def rpme_full_data_get_without_preload_content( ) -> RESTResponseType: """Get a full dataset that includes all the fields included in the survey in addition to the core RPME fields by Survey ID. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_rpme-fulldata_get\" **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%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_rpme-fulldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -668,13 +669,14 @@ def _rpme_full_data_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 @@ -725,7 +727,7 @@ def rpme_output_values_get( ) -> RpmeAssessmentPagedResult: """Processed values for each variable used in the assessments - [![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_rpme-outputvalues_get\" **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_rpme-outputvalues_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param page: page number for paged results :type page: int @@ -817,7 +819,7 @@ def rpme_output_values_get_with_http_info( ) -> ApiResponse[RpmeAssessmentPagedResult]: """Processed values for each variable used in the assessments - [![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_rpme-outputvalues_get\" **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_rpme-outputvalues_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param page: page number for paged results :type page: int @@ -909,7 +911,7 @@ def rpme_output_values_get_without_preload_content( ) -> RESTResponseType: """Processed values for each variable used in the assessments - [![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_rpme-outputvalues_get\" **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_rpme-outputvalues_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param page: page number for paged results :type page: int @@ -1035,13 +1037,14 @@ def _rpme_output_values_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 @@ -1090,7 +1093,7 @@ def rpme_surveys_get( ) -> PagedSurveyListDTO: """Retrieve 1) Survey IDs, 2) their corresponding XLS Form IDs, and 3) Base XLS Form of all RPME surveys conducted in a country. The date of reference, SurveyDate, for the data collection is set by the officer responsible for the upload of each survey. - [![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_rpme-surveys_get\" **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_rpme-surveys_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -1174,7 +1177,7 @@ def rpme_surveys_get_with_http_info( ) -> ApiResponse[PagedSurveyListDTO]: """Retrieve 1) Survey IDs, 2) their corresponding XLS Form IDs, and 3) Base XLS Form of all RPME surveys conducted in a country. The date of reference, SurveyDate, for the data collection is set by the officer responsible for the upload of each survey. - [![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_rpme-surveys_get\" **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_rpme-surveys_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -1258,7 +1261,7 @@ def rpme_surveys_get_without_preload_content( ) -> RESTResponseType: """Retrieve 1) Survey IDs, 2) their corresponding XLS Form IDs, and 3) Base XLS Form of all RPME surveys conducted in a country. The date of reference, SurveyDate, for the data collection is set by the officer responsible for the upload of each survey. - [![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_rpme-surveys_get\" **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_rpme-surveys_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -1386,13 +1389,14 @@ def _rpme_surveys_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 @@ -1438,7 +1442,7 @@ def rpme_variables_get( ) -> RpmeVariablePagedResult: """List of variables - [![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_rpme-variables_get\" **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_rpme-variables_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param page: :type page: int @@ -1510,7 +1514,7 @@ def rpme_variables_get_with_http_info( ) -> ApiResponse[RpmeVariablePagedResult]: """List of variables - [![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_rpme-variables_get\" **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_rpme-variables_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param page: :type page: int @@ -1582,7 +1586,7 @@ def rpme_variables_get_without_preload_content( ) -> RESTResponseType: """List of variables - [![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_rpme-variables_get\" **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_rpme-variables_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param page: :type page: int @@ -1668,13 +1672,14 @@ def _rpme_variables_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 @@ -1723,7 +1728,7 @@ def rpme_xls_forms_get( ) -> PagedXlsFormListDTO: """Get a complete list of XLS Forms uploaded on the RPME in a given period of data collection. This is the digital version of the questionnaire used during the data collection exercise. - [![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_rpme-xlsforms_get\" **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_rpme-xlsforms_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -1807,7 +1812,7 @@ def rpme_xls_forms_get_with_http_info( ) -> ApiResponse[PagedXlsFormListDTO]: """Get a complete list of XLS Forms uploaded on the RPME in a given period of data collection. This is the digital version of the questionnaire used during the data collection exercise. - [![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_rpme-xlsforms_get\" **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_rpme-xlsforms_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -1891,7 +1896,7 @@ def rpme_xls_forms_get_without_preload_content( ) -> RESTResponseType: """Get a complete list of XLS Forms uploaded on the RPME in a given period of data collection. This is the digital version of the questionnaire used during the data collection exercise. - [![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_rpme-xlsforms_get\" **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_rpme-xlsforms_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -2019,11 +2024,12 @@ def _rpme_xls_forms_get_serialize( # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) # authentication setting diff --git a/data_bridges_client/api/surveys_api.py b/data_bridges_client/api/surveys_api.py index 7c2732b..f9c4371 100644 --- a/data_bridges_client/api/surveys_api.py +++ b/data_bridges_client/api/surveys_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) @@ -65,7 +65,7 @@ def m_fi_surveys_base_data_get( ) -> PagedSurveyResponsesDTO: """Get data that includes the core Market Functionality Index (MFI) fields only by Survey ID - [![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_mfi-surveys-basedata_get\" **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_mfi-surveys-basedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -146,7 +146,7 @@ def m_fi_surveys_base_data_get_with_http_info( ) -> ApiResponse[PagedSurveyResponsesDTO]: """Get data that includes the core Market Functionality Index (MFI) fields only by Survey ID - [![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_mfi-surveys-basedata_get\" **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_mfi-surveys-basedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -227,7 +227,7 @@ def m_fi_surveys_base_data_get_without_preload_content( ) -> RESTResponseType: """Get data that includes the core Market Functionality Index (MFI) fields only by Survey ID - [![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_mfi-surveys-basedata_get\" **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_mfi-surveys-basedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -330,13 +330,14 @@ def _m_fi_surveys_base_data_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 @@ -385,7 +386,7 @@ def m_fi_surveys_full_data_get( ) -> PagedSurveyResponsesDTO: """Get a full dataset that includes all the fields included in the survey in addition to the core Market Functionality Index (MFI) fields by Survey ID. To access this data, please contact global.mfi@wfp.org for authorization. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_mfi-surveys-fulldata_get\" **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%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_mfi-surveys-fulldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -470,7 +471,7 @@ def m_fi_surveys_full_data_get_with_http_info( ) -> ApiResponse[PagedSurveyResponsesDTO]: """Get a full dataset that includes all the fields included in the survey in addition to the core Market Functionality Index (MFI) fields by Survey ID. To access this data, please contact global.mfi@wfp.org for authorization. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_mfi-surveys-fulldata_get\" **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%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_mfi-surveys-fulldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -555,7 +556,7 @@ def m_fi_surveys_full_data_get_without_preload_content( ) -> RESTResponseType: """Get a full dataset that includes all the fields included in the survey in addition to the core Market Functionality Index (MFI) fields by Survey ID. To access this data, please contact global.mfi@wfp.org for authorization. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_mfi-surveys-fulldata_get\" **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%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_mfi-surveys-fulldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: unique identifier for the collected data, as retrieved from /Surveys API. :type survey_id: int @@ -666,13 +667,14 @@ def _m_fi_surveys_full_data_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 @@ -721,7 +723,7 @@ def m_fi_surveys_get( ) -> PagedSurveyListDTO: """Retrieve 1) Survey IDs, 2) their corresponding XLS Form IDs, and 3) Base XLS Form of all MFI 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. - [![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_mfi-surveys_get\" **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_mfi-surveys_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -805,7 +807,7 @@ def m_fi_surveys_get_with_http_info( ) -> ApiResponse[PagedSurveyListDTO]: """Retrieve 1) Survey IDs, 2) their corresponding XLS Form IDs, and 3) Base XLS Form of all MFI 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. - [![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_mfi-surveys_get\" **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_mfi-surveys_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -889,7 +891,7 @@ def m_fi_surveys_get_without_preload_content( ) -> RESTResponseType: """Retrieve 1) Survey IDs, 2) their corresponding XLS Form IDs, and 3) Base XLS Form of all MFI 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. - [![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_mfi-surveys_get\" **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_mfi-surveys_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -1017,11 +1019,12 @@ def _m_fi_surveys_get_serialize( # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) # authentication setting @@ -1075,7 +1078,7 @@ def m_fi_surveys_processed_data_get( ) -> PagedProcessedDataDTO: """Get a MFI processed data in long format; levels indicate the data aggregation level 1) Normalized Score, 2) Trader Aggregate Score, 3) Market Aggregate Score, 4) Trader Median, 5) Trader Mean, 6) Market Mean; each line corresponds to one of the nine dimensions of scores plus the final MFI aggregate score; 1) Assortment, 2) Availability, 3) Price, 4) Resilience, 5) Competition, 6) Infrastructure, 7) Service, 8) Quality, 9) Access and Protection, and 10) MFI final score; the variable label describes each variable and its value range - [![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_mfi-surveys-processeddata_get\" **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_mfi-surveys-processeddata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: The ID of the survey :type survey_id: int @@ -1179,7 +1182,7 @@ def m_fi_surveys_processed_data_get_with_http_info( ) -> ApiResponse[PagedProcessedDataDTO]: """Get a MFI processed data in long format; levels indicate the data aggregation level 1) Normalized Score, 2) Trader Aggregate Score, 3) Market Aggregate Score, 4) Trader Median, 5) Trader Mean, 6) Market Mean; each line corresponds to one of the nine dimensions of scores plus the final MFI aggregate score; 1) Assortment, 2) Availability, 3) Price, 4) Resilience, 5) Competition, 6) Infrastructure, 7) Service, 8) Quality, 9) Access and Protection, and 10) MFI final score; the variable label describes each variable and its value range - [![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_mfi-surveys-processeddata_get\" **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_mfi-surveys-processeddata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: The ID of the survey :type survey_id: int @@ -1283,7 +1286,7 @@ def m_fi_surveys_processed_data_get_without_preload_content( ) -> RESTResponseType: """Get a MFI processed data in long format; levels indicate the data aggregation level 1) Normalized Score, 2) Trader Aggregate Score, 3) Market Aggregate Score, 4) Trader Median, 5) Trader Mean, 6) Market Mean; each line corresponds to one of the nine dimensions of scores plus the final MFI aggregate score; 1) Assortment, 2) Availability, 3) Price, 4) Resilience, 5) Competition, 6) Infrastructure, 7) Service, 8) Quality, 9) Access and Protection, and 10) MFI final score; the variable label describes each variable and its value range - [![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_mfi-surveys-processeddata_get\" **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_mfi-surveys-processeddata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param survey_id: The ID of the survey :type survey_id: int @@ -1451,13 +1454,14 @@ def _m_fi_surveys_processed_data_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 diff --git a/data_bridges_client/api/xls_forms_api.py b/data_bridges_client/api/xls_forms_api.py index 0176164..23ccacf 100644 --- a/data_bridges_client/api/xls_forms_api.py +++ b/data_bridges_client/api/xls_forms_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 m_fi_xls_forms_get( ) -> PagedXlsFormListDTO: """Get a complete list of XLS Forms uploaded on the MFI Data Bridge in a given period of data collection. This is the digital version of the questionnaire used during the data collection exercise. - [![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_mfi-xlsforms_get\" **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_mfi-xlsforms_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -148,7 +148,7 @@ def m_fi_xls_forms_get_with_http_info( ) -> ApiResponse[PagedXlsFormListDTO]: """Get a complete list of XLS Forms uploaded on the MFI Data Bridge in a given period of data collection. This is the digital version of the questionnaire used during the data collection exercise. - [![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_mfi-xlsforms_get\" **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_mfi-xlsforms_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -232,7 +232,7 @@ def m_fi_xls_forms_get_without_preload_content( ) -> RESTResponseType: """Get a complete list of XLS Forms uploaded on the MFI Data Bridge in a given period of data collection. This is the digital version of the questionnaire used during the data collection exercise. - [![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_mfi-xlsforms_get\" **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_mfi-xlsforms_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param adm0_code: code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion :type adm0_code: int @@ -360,11 +360,12 @@ def _m_fi_xls_forms_get_serialize( # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) # authentication setting diff --git a/data_bridges_client/api_client.py b/data_bridges_client/api_client.py index beb835a..bca2b8a 100644 --- a/data_bridges_client/api_client.py +++ b/data_bridges_client/api_client.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) @@ -16,6 +16,7 @@ import datetime from dateutil.parser import parse from enum import Enum +import decimal import json import mimetypes import os @@ -67,6 +68,7 @@ class ApiClient: 'bool': bool, 'date': datetime.date, 'datetime': datetime.datetime, + 'decimal': decimal.Decimal, 'object': object, } _pool = None @@ -228,7 +230,7 @@ def param_serialize( body = self.sanitize_for_serialization(body) # request url - if _host is None: + if _host is None or self.configuration.ignore_operation_servers: url = self.configuration.host + resource_path else: # use server/host defined in path or operation instead @@ -315,10 +317,7 @@ def response_deserialize( match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type) encoding = match.group(1) if match else "utf-8" response_text = response_data.data.decode(encoding) - if response_type in ["bytearray", "str"]: - return_data = self.__deserialize_primitive(response_text, response_type) - else: - return_data = self.deserialize(response_text, response_type) + return_data = self.deserialize(response_text, response_type, content_type) finally: if not 200 <= response_data.status <= 299: raise ApiException.from_response( @@ -342,6 +341,7 @@ def sanitize_for_serialization(self, obj): If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date convert to string in iso8601 format. + If obj is decimal.Decimal return string representation. If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is OpenAPI model, return the properties dict. @@ -367,6 +367,8 @@ def sanitize_for_serialization(self, obj): ) elif isinstance(obj, (datetime.datetime, datetime.date)): return obj.isoformat() + elif isinstance(obj, decimal.Decimal): + return str(obj) elif isinstance(obj, dict): obj_dict = obj @@ -386,21 +388,35 @@ def sanitize_for_serialization(self, obj): for key, val in obj_dict.items() } - def deserialize(self, response_text, response_type): + def deserialize(self, response_text: str, response_type: str, content_type: Optional[str]): """Deserializes response into an object. :param response: RESTResponse object to be deserialized. :param response_type: class literal for deserialized object, or string of class name. + :param content_type: content type of response. :return: deserialized object. """ # fetch data from response object - try: - data = json.loads(response_text) - except ValueError: + if content_type is None: + try: + data = json.loads(response_text) + except ValueError: + data = response_text + elif content_type.startswith("application/json"): + if response_text == "": + data = "" + else: + data = json.loads(response_text) + elif content_type.startswith("text/plain"): data = response_text + else: + raise ApiException( + status=0, + reason="Unsupported content type: {0}".format(content_type) + ) return self.__deserialize(data, response_type) @@ -444,6 +460,8 @@ def __deserialize(self, data, klass): return self.__deserialize_date(data) elif klass == datetime.datetime: return self.__deserialize_datetime(data) + elif klass == decimal.Decimal: + return decimal.Decimal(data) elif issubclass(klass, Enum): return self.__deserialize_enum(data, klass) else: diff --git a/data_bridges_client/configuration.py b/data_bridges_client/configuration.py index c0b6044..43265ca 100644 --- a/data_bridges_client/configuration.py +++ b/data_bridges_client/configuration.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) @@ -33,6 +33,9 @@ class Configuration: """This class contains various settings of the API client. :param host: Base url. + :param ignore_operation_servers + Boolean to ignore operation servers for the API client. + Config will use `host` as the base url regardless of the operation servers. :param api_key: Dict to store API key(s). Each entry in the dict specifies an API key. The dict key is the name of the security scheme in the OAS specification. @@ -55,6 +58,7 @@ class Configuration: values before. :param ssl_ca_cert: str - the path to a file of concatenated CA certificates in PEM format. + :param retries: Number of retries for API requests. :Example: """ @@ -67,11 +71,15 @@ def __init__(self, host=None, access_token=None, server_index=None, server_variables=None, server_operation_index=None, server_operation_variables=None, + ignore_operation_servers=False, ssl_ca_cert=None, + retries=None, + *, + debug: Optional[bool] = None ) -> None: """Constructor """ - self._base_path = "https://api.wfp.org/vam-data-bridges/4.0.0" if host is None else host + self._base_path = "https://api.wfp.org/vam-data-bridges/5.0.0" if host is None else host """Default Base url """ self.server_index = 0 if server_index is None and host is None else server_index @@ -82,6 +90,9 @@ def __init__(self, host=None, self.server_operation_variables = server_operation_variables or {} """Default server variables """ + self.ignore_operation_servers = ignore_operation_servers + """Ignore operation servers + """ self.temp_folder_path = None """Temp file folder for downloading files """ @@ -125,7 +136,10 @@ def __init__(self, host=None, self.logger_file = None """Debug file location """ - self.debug = False + if debug is not None: + self.debug = debug + else: + self.__debug = False """Debug switch """ @@ -168,7 +182,7 @@ def __init__(self, host=None, self.safe_chars_for_path_param = '' """Safe chars for path_param """ - self.retries = None + self.retries = retries """Adding retries to override urllib3 default value 3 """ # Enable client side validation @@ -378,7 +392,7 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 4.0.0\n"\ + "Version of the API: 5.0.0\n"\ "SDK Package Version: 1.0.0".\ format(env=sys.platform, pyversion=sys.version) @@ -389,7 +403,7 @@ def get_host_settings(self): """ return [ { - 'url': "https://api.wfp.org/vam-data-bridges/4.0.0", + 'url': "https://api.wfp.org/vam-data-bridges/5.0.0", 'description': "No description provided", } ] diff --git a/data_bridges_client/exceptions.py b/data_bridges_client/exceptions.py index 2b577e4..17c4acc 100644 --- a/data_bridges_client/exceptions.py +++ b/data_bridges_client/exceptions.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) diff --git a/data_bridges_client/models/__init__.py b/data_bridges_client/models/__init__.py index 9a58860..0ece5de 100644 --- a/data_bridges_client/models/__init__.py +++ b/data_bridges_client/models/__init__.py @@ -6,7 +6,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) @@ -26,6 +26,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 diff --git a/data_bridges_client/models/bad_request_dto.py b/data_bridges_client/models/bad_request_dto.py index f49678b..e6cf622 100644 --- a/data_bridges_client/models/bad_request_dto.py +++ b/data_bridges_client/models/bad_request_dto.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) diff --git a/data_bridges_client/models/commodity_dto.py b/data_bridges_client/models/commodity_dto.py index 20d4f00..d8315c5 100644 --- a/data_bridges_client/models/commodity_dto.py +++ b/data_bridges_client/models/commodity_dto.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) @@ -87,16 +87,16 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in qualities (list) _items = [] if self.qualities: - for _item in self.qualities: - if _item: - _items.append(_item.to_dict()) + for _item_qualities in self.qualities: + if _item_qualities: + _items.append(_item_qualities.to_dict()) _dict['qualities'] = _items # override the default output from pydantic by calling `to_dict()` of each item in processing (list) _items = [] if self.processing: - for _item in self.processing: - if _item: - _items.append(_item.to_dict()) + for _item_processing in self.processing: + if _item_processing: + _items.append(_item_processing.to_dict()) _dict['processing'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/commodity_price_dto.py b/data_bridges_client/models/commodity_price_dto.py index 8d47daf..02cf949 100644 --- a/data_bridges_client/models/commodity_price_dto.py +++ b/data_bridges_client/models/commodity_price_dto.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) diff --git a/data_bridges_client/models/commodity_processing_dto.py b/data_bridges_client/models/commodity_processing_dto.py index 4bc74b9..466c8ab 100644 --- a/data_bridges_client/models/commodity_processing_dto.py +++ b/data_bridges_client/models/commodity_processing_dto.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) diff --git a/data_bridges_client/models/commodity_quality_dto.py b/data_bridges_client/models/commodity_quality_dto.py index 3cae050..e5cc5ea 100644 --- a/data_bridges_client/models/commodity_quality_dto.py +++ b/data_bridges_client/models/commodity_quality_dto.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) diff --git a/data_bridges_client/models/currency_dto.py b/data_bridges_client/models/currency_dto.py index 4545a62..f1333d6 100644 --- a/data_bridges_client/models/currency_dto.py +++ b/data_bridges_client/models/currency_dto.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) diff --git a/data_bridges_client/models/economic_data_dto.py b/data_bridges_client/models/economic_data_dto.py index da03c94..cd8ade8 100644 --- a/data_bridges_client/models/economic_data_dto.py +++ b/data_bridges_client/models/economic_data_dto.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) diff --git a/data_bridges_client/models/economic_indicator_property.py b/data_bridges_client/models/economic_indicator_property.py index 5854afd..36a0a15 100644 --- a/data_bridges_client/models/economic_indicator_property.py +++ b/data_bridges_client/models/economic_indicator_property.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) diff --git a/data_bridges_client/models/economic_indicator_property_paged_result.py b/data_bridges_client/models/economic_indicator_property_paged_result.py index 45a3fcc..09fc404 100644 --- a/data_bridges_client/models/economic_indicator_property_paged_result.py +++ b/data_bridges_client/models/economic_indicator_property_paged_result.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) @@ -80,9 +80,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/feature.py b/data_bridges_client/models/feature.py index 5cfd2ab..5eec78f 100644 --- a/data_bridges_client/models/feature.py +++ b/data_bridges_client/models/feature.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) diff --git a/data_bridges_client/models/geometry.py b/data_bridges_client/models/geometry.py index 5f958c3..4fbb23e 100644 --- a/data_bridges_client/models/geometry.py +++ b/data_bridges_client/models/geometry.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) diff --git a/data_bridges_client/models/gorp_country_api_dto.py b/data_bridges_client/models/gorp_country_api_dto.py new file mode 100644 index 0000000..d8e7253 --- /dev/null +++ b/data_bridges_client/models/gorp_country_api_dto.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + 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 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class GorpCountryApiDto(BaseModel): + """ + GorpCountryApiDto + """ # noqa: E501 + gorp_date: Optional[StrictStr] = Field(default=None, alias="gorpDate") + country_office_iso3: Optional[StrictStr] = Field(default=None, alias="countryOfficeIso3") + gorp_total_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="gorpTotalValue") + gorp_comment: Optional[StrictStr] = Field(default=None, alias="gorpComment") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["gorpDate", "countryOfficeIso3", "gorpTotalValue", "gorpComment"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GorpCountryApiDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if gorp_date (nullable) is None + # and model_fields_set contains the field + if self.gorp_date is None and "gorp_date" in self.model_fields_set: + _dict['gorpDate'] = None + + # set to None if country_office_iso3 (nullable) is None + # and model_fields_set contains the field + if self.country_office_iso3 is None and "country_office_iso3" in self.model_fields_set: + _dict['countryOfficeIso3'] = None + + # set to None if gorp_comment (nullable) is None + # and model_fields_set contains the field + if self.gorp_comment is None and "gorp_comment" in self.model_fields_set: + _dict['gorpComment'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GorpCountryApiDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "gorpDate": obj.get("gorpDate"), + "countryOfficeIso3": obj.get("countryOfficeIso3"), + "gorpTotalValue": obj.get("gorpTotalValue"), + "gorpComment": obj.get("gorpComment") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/gorp_global_api_dto.py b/data_bridges_client/models/gorp_global_api_dto.py new file mode 100644 index 0000000..7bc87f5 --- /dev/null +++ b/data_bridges_client/models/gorp_global_api_dto.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + 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 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class GorpGlobalApiDto(BaseModel): + """ + GorpGlobalApiDto + """ # noqa: E501 + gorp_date: Optional[StrictStr] = Field(default=None, alias="gorpDate") + gorp_region_name: Optional[StrictStr] = Field(default=None, alias="gorpRegionName") + gorp_total_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="gorpTotalValue") + number_of_countries: Optional[StrictInt] = Field(default=None, alias="numberOfCountries") + gorp_comment: Optional[StrictStr] = Field(default=None, alias="gorpComment") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["gorpDate", "gorpRegionName", "gorpTotalValue", "numberOfCountries", "gorpComment"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GorpGlobalApiDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if gorp_date (nullable) is None + # and model_fields_set contains the field + if self.gorp_date is None and "gorp_date" in self.model_fields_set: + _dict['gorpDate'] = None + + # set to None if gorp_region_name (nullable) is None + # and model_fields_set contains the field + if self.gorp_region_name is None and "gorp_region_name" in self.model_fields_set: + _dict['gorpRegionName'] = None + + # set to None if number_of_countries (nullable) is None + # and model_fields_set contains the field + if self.number_of_countries is None and "number_of_countries" in self.model_fields_set: + _dict['numberOfCountries'] = None + + # set to None if gorp_comment (nullable) is None + # and model_fields_set contains the field + if self.gorp_comment is None and "gorp_comment" in self.model_fields_set: + _dict['gorpComment'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GorpGlobalApiDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "gorpDate": obj.get("gorpDate"), + "gorpRegionName": obj.get("gorpRegionName"), + "gorpTotalValue": obj.get("gorpTotalValue"), + "numberOfCountries": obj.get("numberOfCountries"), + "gorpComment": obj.get("gorpComment") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/gorp_regional_api_dto.py b/data_bridges_client/models/gorp_regional_api_dto.py new file mode 100644 index 0000000..cbdee84 --- /dev/null +++ b/data_bridges_client/models/gorp_regional_api_dto.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + 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 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class GorpRegionalApiDto(BaseModel): + """ + GorpRegionalApiDto + """ # noqa: E501 + gorp_date: Optional[StrictStr] = Field(default=None, alias="gorpDate") + gorp_region_name: Optional[StrictStr] = Field(default=None, alias="gorpRegionName") + gorp_total_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="gorpTotalValue") + number_of_countries: Optional[StrictInt] = Field(default=None, alias="numberOfCountries") + gorp_comment: Optional[StrictStr] = Field(default=None, alias="gorpComment") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["gorpDate", "gorpRegionName", "gorpTotalValue", "numberOfCountries", "gorpComment"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GorpRegionalApiDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if gorp_date (nullable) is None + # and model_fields_set contains the field + if self.gorp_date is None and "gorp_date" in self.model_fields_set: + _dict['gorpDate'] = None + + # set to None if gorp_region_name (nullable) is None + # and model_fields_set contains the field + if self.gorp_region_name is None and "gorp_region_name" in self.model_fields_set: + _dict['gorpRegionName'] = None + + # set to None if number_of_countries (nullable) is None + # and model_fields_set contains the field + if self.number_of_countries is None and "number_of_countries" in self.model_fields_set: + _dict['numberOfCountries'] = None + + # set to None if gorp_comment (nullable) is None + # and model_fields_set contains the field + if self.gorp_comment is None and "gorp_comment" in self.model_fields_set: + _dict['gorpComment'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GorpRegionalApiDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "gorpDate": obj.get("gorpDate"), + "gorpRegionName": obj.get("gorpRegionName"), + "gorpTotalValue": obj.get("gorpTotalValue"), + "numberOfCountries": obj.get("numberOfCountries"), + "gorpComment": obj.get("gorpComment") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/gorp_value_with_changes.py b/data_bridges_client/models/gorp_value_with_changes.py index 182e414..f8a7240 100644 --- a/data_bridges_client/models/gorp_value_with_changes.py +++ b/data_bridges_client/models/gorp_value_with_changes.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) diff --git a/data_bridges_client/models/gorp_value_with_changes_paged_result.py b/data_bridges_client/models/gorp_value_with_changes_paged_result.py index 9a8c1ba..795f44d 100644 --- a/data_bridges_client/models/gorp_value_with_changes_paged_result.py +++ b/data_bridges_client/models/gorp_value_with_changes_paged_result.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) @@ -80,9 +80,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/household_survey_list_dto.py b/data_bridges_client/models/household_survey_list_dto.py index 3e07e9a..216009f 100644 --- a/data_bridges_client/models/household_survey_list_dto.py +++ b/data_bridges_client/models/household_survey_list_dto.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) @@ -52,11 +52,13 @@ class HouseholdSurveyListDTO(BaseModel): survey_category_name: Optional[StrictStr] = Field(default=None, alias="surveyCategoryName") survey_sub_category_name: Optional[StrictStr] = Field(default=None, alias="surveySubCategoryName") survey_phase_name: Optional[StrictStr] = Field(default=None, alias="surveyPhaseName") - survey_visibilty: Optional[StrictStr] = Field(default=None, alias="surveyVisibilty") + survey_visibility: Optional[StrictStr] = Field(default=None, alias="surveyVisibility") is_continuous_monitoring: Optional[StrictBool] = Field(default=None, alias="isContinuousMonitoring") survey_name: Optional[StrictStr] = Field(default=None, alias="surveyName") + xls_form_id: Optional[StrictInt] = Field(default=None, alias="xlsFormId") + base_xls_form_id: Optional[StrictInt] = Field(default=None, alias="baseXlsFormId") additional_properties: Dict[str, Any] = {} - __properties: ClassVar[List[str]] = ["surveyID", "surveyStatusID", "surveyStartDate", "surveyEndDate", "surveyCreateDate", "surveyValidationReport", "surveyOriginalFilename", "xlsFormName", "baseXlsFormName", "countryName", "adm0Code", "iso3Alpha3", "userName", "approvedBy", "originalCsvFile", "baseData", "surveyAttributes", "organizations", "surveyModalityName", "surveyCategoryName", "surveySubCategoryName", "surveyPhaseName", "surveyVisibilty", "isContinuousMonitoring", "surveyName"] + __properties: ClassVar[List[str]] = ["surveyID", "surveyStatusID", "surveyStartDate", "surveyEndDate", "surveyCreateDate", "surveyValidationReport", "surveyOriginalFilename", "xlsFormName", "baseXlsFormName", "countryName", "adm0Code", "iso3Alpha3", "userName", "approvedBy", "originalCsvFile", "baseData", "surveyAttributes", "organizations", "surveyModalityName", "surveyCategoryName", "surveySubCategoryName", "surveyPhaseName", "surveyVisibility", "isContinuousMonitoring", "surveyName", "xlsFormId", "baseXlsFormId"] model_config = ConfigDict( populate_by_name=True, @@ -102,16 +104,16 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in survey_attributes (list) _items = [] if self.survey_attributes: - for _item in self.survey_attributes: - if _item: - _items.append(_item.to_dict()) + for _item_survey_attributes in self.survey_attributes: + if _item_survey_attributes: + _items.append(_item_survey_attributes.to_dict()) _dict['surveyAttributes'] = _items # override the default output from pydantic by calling `to_dict()` of each item in organizations (list) _items = [] if self.organizations: - for _item in self.organizations: - if _item: - _items.append(_item.to_dict()) + for _item_organizations in self.organizations: + if _item_organizations: + _items.append(_item_organizations.to_dict()) _dict['organizations'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: @@ -208,10 +210,10 @@ def to_dict(self) -> Dict[str, Any]: if self.survey_phase_name is None and "survey_phase_name" in self.model_fields_set: _dict['surveyPhaseName'] = None - # set to None if survey_visibilty (nullable) is None + # set to None if survey_visibility (nullable) is None # and model_fields_set contains the field - if self.survey_visibilty is None and "survey_visibilty" in self.model_fields_set: - _dict['surveyVisibilty'] = None + if self.survey_visibility is None and "survey_visibility" in self.model_fields_set: + _dict['surveyVisibility'] = None # set to None if survey_name (nullable) is None # and model_fields_set contains the field @@ -252,9 +254,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "surveyCategoryName": obj.get("surveyCategoryName"), "surveySubCategoryName": obj.get("surveySubCategoryName"), "surveyPhaseName": obj.get("surveyPhaseName"), - "surveyVisibilty": obj.get("surveyVisibilty"), + "surveyVisibility": obj.get("surveyVisibility"), "isContinuousMonitoring": obj.get("isContinuousMonitoring"), - "surveyName": obj.get("surveyName") + "surveyName": obj.get("surveyName"), + "xlsFormId": obj.get("xlsFormId"), + "baseXlsFormId": obj.get("baseXlsFormId") }) # store additional fields in additional_properties for _key in obj.keys(): diff --git a/data_bridges_client/models/household_survey_list_dto_paged_result.py b/data_bridges_client/models/household_survey_list_dto_paged_result.py index 3130bc2..414ff9e 100644 --- a/data_bridges_client/models/household_survey_list_dto_paged_result.py +++ b/data_bridges_client/models/household_survey_list_dto_paged_result.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) @@ -80,9 +80,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/ipc_value.py b/data_bridges_client/models/ipc_value.py index 1d4d4d0..f975bc5 100644 --- a/data_bridges_client/models/ipc_value.py +++ b/data_bridges_client/models/ipc_value.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) diff --git a/data_bridges_client/models/ipc_value_paged_result.py b/data_bridges_client/models/ipc_value_paged_result.py index c87a1a1..306a145 100644 --- a/data_bridges_client/models/ipc_value_paged_result.py +++ b/data_bridges_client/models/ipc_value_paged_result.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) @@ -80,9 +80,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/key_name_dto.py b/data_bridges_client/models/key_name_dto.py index 4b838d4..1e74d98 100644 --- a/data_bridges_client/models/key_name_dto.py +++ b/data_bridges_client/models/key_name_dto.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) diff --git a/data_bridges_client/models/market_dto.py b/data_bridges_client/models/market_dto.py index 316d89e..57b4619 100644 --- a/data_bridges_client/models/market_dto.py +++ b/data_bridges_client/models/market_dto.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) diff --git a/data_bridges_client/models/market_geo_json_root.py b/data_bridges_client/models/market_geo_json_root.py index d9af76c..356dc2f 100644 --- a/data_bridges_client/models/market_geo_json_root.py +++ b/data_bridges_client/models/market_geo_json_root.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) @@ -78,9 +78,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in features (list) _items = [] if self.features: - for _item in self.features: - if _item: - _items.append(_item.to_dict()) + for _item_features in self.features: + if _item_features: + _items.append(_item_features.to_dict()) _dict['features'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/mfi_processed_data_dto.py b/data_bridges_client/models/mfi_processed_data_dto.py index f0df58a..3a081e0 100644 --- a/data_bridges_client/models/mfi_processed_data_dto.py +++ b/data_bridges_client/models/mfi_processed_data_dto.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) diff --git a/data_bridges_client/models/nearby_markets_dto.py b/data_bridges_client/models/nearby_markets_dto.py index f3c97c2..c62eb4b 100644 --- a/data_bridges_client/models/nearby_markets_dto.py +++ b/data_bridges_client/models/nearby_markets_dto.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) diff --git a/data_bridges_client/models/paged_commodity_list_dto.py b/data_bridges_client/models/paged_commodity_list_dto.py index d2bc549..505285a 100644 --- a/data_bridges_client/models/paged_commodity_list_dto.py +++ b/data_bridges_client/models/paged_commodity_list_dto.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) @@ -78,9 +78,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/paged_commodity_price_list_dto.py b/data_bridges_client/models/paged_commodity_price_list_dto.py index 94ac0e5..1301657 100644 --- a/data_bridges_client/models/paged_commodity_price_list_dto.py +++ b/data_bridges_client/models/paged_commodity_price_list_dto.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) @@ -78,9 +78,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/paged_commodity_weekly_aggregated_price_list_dto.py b/data_bridges_client/models/paged_commodity_weekly_aggregated_price_list_dto.py index 42d590c..08caa94 100644 --- a/data_bridges_client/models/paged_commodity_weekly_aggregated_price_list_dto.py +++ b/data_bridges_client/models/paged_commodity_weekly_aggregated_price_list_dto.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) @@ -78,9 +78,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/paged_currency_list_dto.py b/data_bridges_client/models/paged_currency_list_dto.py index 0783e85..b4d6130 100644 --- a/data_bridges_client/models/paged_currency_list_dto.py +++ b/data_bridges_client/models/paged_currency_list_dto.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) @@ -78,9 +78,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/paged_economic_data_dto.py b/data_bridges_client/models/paged_economic_data_dto.py index aa019f0..e34c11f 100644 --- a/data_bridges_client/models/paged_economic_data_dto.py +++ b/data_bridges_client/models/paged_economic_data_dto.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) @@ -81,9 +81,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/paged_market_list_dto.py b/data_bridges_client/models/paged_market_list_dto.py index 48f0eee..0cb7cee 100644 --- a/data_bridges_client/models/paged_market_list_dto.py +++ b/data_bridges_client/models/paged_market_list_dto.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) @@ -78,9 +78,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/paged_processed_data_dto.py b/data_bridges_client/models/paged_processed_data_dto.py index 8fb8850..e12f3f9 100644 --- a/data_bridges_client/models/paged_processed_data_dto.py +++ b/data_bridges_client/models/paged_processed_data_dto.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) @@ -78,9 +78,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/paged_survey_list_dto.py b/data_bridges_client/models/paged_survey_list_dto.py index 587e349..5408f24 100644 --- a/data_bridges_client/models/paged_survey_list_dto.py +++ b/data_bridges_client/models/paged_survey_list_dto.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) @@ -78,9 +78,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/paged_survey_responses_dto.py b/data_bridges_client/models/paged_survey_responses_dto.py index d757b9e..ba8eef9 100644 --- a/data_bridges_client/models/paged_survey_responses_dto.py +++ b/data_bridges_client/models/paged_survey_responses_dto.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) diff --git a/data_bridges_client/models/paged_xls_form_list_dto.py b/data_bridges_client/models/paged_xls_form_list_dto.py index da3720e..1df06b0 100644 --- a/data_bridges_client/models/paged_xls_form_list_dto.py +++ b/data_bridges_client/models/paged_xls_form_list_dto.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) @@ -78,9 +78,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/problem_details.py b/data_bridges_client/models/problem_details.py index 2ce03e5..af5dad1 100644 --- a/data_bridges_client/models/problem_details.py +++ b/data_bridges_client/models/problem_details.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) diff --git a/data_bridges_client/models/properties.py b/data_bridges_client/models/properties.py index ccc6dcd..2ec2f57 100644 --- a/data_bridges_client/models/properties.py +++ b/data_bridges_client/models/properties.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) diff --git a/data_bridges_client/models/rpme_assessment.py b/data_bridges_client/models/rpme_assessment.py index b971c12..a091541 100644 --- a/data_bridges_client/models/rpme_assessment.py +++ b/data_bridges_client/models/rpme_assessment.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) @@ -96,9 +96,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in output_values (list) _items = [] if self.output_values: - for _item in self.output_values: - if _item: - _items.append(_item.to_dict()) + for _item_output_values in self.output_values: + if _item_output_values: + _items.append(_item_output_values.to_dict()) _dict['outputValues'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/rpme_assessment_paged_result.py b/data_bridges_client/models/rpme_assessment_paged_result.py index d9121bb..1fc7101 100644 --- a/data_bridges_client/models/rpme_assessment_paged_result.py +++ b/data_bridges_client/models/rpme_assessment_paged_result.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) @@ -80,9 +80,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/rpme_output_values.py b/data_bridges_client/models/rpme_output_values.py index 98c87aa..ed367f5 100644 --- a/data_bridges_client/models/rpme_output_values.py +++ b/data_bridges_client/models/rpme_output_values.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) diff --git a/data_bridges_client/models/rpme_variable.py b/data_bridges_client/models/rpme_variable.py index 7705b29..7948584 100644 --- a/data_bridges_client/models/rpme_variable.py +++ b/data_bridges_client/models/rpme_variable.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) diff --git a/data_bridges_client/models/rpme_variable_paged_result.py b/data_bridges_client/models/rpme_variable_paged_result.py index 2b32b32..3430706 100644 --- a/data_bridges_client/models/rpme_variable_paged_result.py +++ b/data_bridges_client/models/rpme_variable_paged_result.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) @@ -80,9 +80,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/survey_list_dto.py b/data_bridges_client/models/survey_list_dto.py index 968e4e5..5980119 100644 --- a/data_bridges_client/models/survey_list_dto.py +++ b/data_bridges_client/models/survey_list_dto.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) diff --git a/data_bridges_client/models/usd_indirect_quotation.py b/data_bridges_client/models/usd_indirect_quotation.py index 0672d33..35dc985 100644 --- a/data_bridges_client/models/usd_indirect_quotation.py +++ b/data_bridges_client/models/usd_indirect_quotation.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) diff --git a/data_bridges_client/models/usd_indirect_quotation_paged_result.py b/data_bridges_client/models/usd_indirect_quotation_paged_result.py index e2ecbc1..5509987 100644 --- a/data_bridges_client/models/usd_indirect_quotation_paged_result.py +++ b/data_bridges_client/models/usd_indirect_quotation_paged_result.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) @@ -80,9 +80,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/view_extended_aggregated_price.py b/data_bridges_client/models/view_extended_aggregated_price.py index e690dcc..865be0b 100644 --- a/data_bridges_client/models/view_extended_aggregated_price.py +++ b/data_bridges_client/models/view_extended_aggregated_price.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) diff --git a/data_bridges_client/models/view_extended_aggregated_price_paged_result.py b/data_bridges_client/models/view_extended_aggregated_price_paged_result.py index 6efbdb1..2725e20 100644 --- a/data_bridges_client/models/view_extended_aggregated_price_paged_result.py +++ b/data_bridges_client/models/view_extended_aggregated_price_paged_result.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) @@ -80,9 +80,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/view_extended_alps_value.py b/data_bridges_client/models/view_extended_alps_value.py index 23e59a6..6d33b90 100644 --- a/data_bridges_client/models/view_extended_alps_value.py +++ b/data_bridges_client/models/view_extended_alps_value.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) diff --git a/data_bridges_client/models/view_extended_alps_value_paged_result.py b/data_bridges_client/models/view_extended_alps_value_paged_result.py index 2e95a6b..b3b1b84 100644 --- a/data_bridges_client/models/view_extended_alps_value_paged_result.py +++ b/data_bridges_client/models/view_extended_alps_value_paged_result.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) @@ -80,9 +80,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in items (list) _items = [] if self.items: - for _item in self.items: - if _item: - _items.append(_item.to_dict()) + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) _dict['items'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/weekly_aggregated_price.py b/data_bridges_client/models/weekly_aggregated_price.py index 825d66e..f0b832b 100644 --- a/data_bridges_client/models/weekly_aggregated_price.py +++ b/data_bridges_client/models/weekly_aggregated_price.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) diff --git a/data_bridges_client/models/xls_form_definition_new_schema_dto.py b/data_bridges_client/models/xls_form_definition_new_schema_dto.py index c09f8c9..97ff545 100644 --- a/data_bridges_client/models/xls_form_definition_new_schema_dto.py +++ b/data_bridges_client/models/xls_form_definition_new_schema_dto.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) @@ -83,9 +83,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in fields (list) _items = [] if self.fields: - for _item in self.fields: - if _item: - _items.append(_item.to_dict()) + for _item_fields in self.fields: + if _item_fields: + _items.append(_item_fields.to_dict()) _dict['fields'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/models/xls_form_dto.py b/data_bridges_client/models/xls_form_dto.py index 8790df4..45dde27 100644 --- a/data_bridges_client/models/xls_form_dto.py +++ b/data_bridges_client/models/xls_form_dto.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) diff --git a/data_bridges_client/models/xls_form_fields_dto.py b/data_bridges_client/models/xls_form_fields_dto.py index f79c4ef..79d4f04 100644 --- a/data_bridges_client/models/xls_form_fields_dto.py +++ b/data_bridges_client/models/xls_form_fields_dto.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) diff --git a/data_bridges_client/models/xls_form_list_choice_dto.py b/data_bridges_client/models/xls_form_list_choice_dto.py index ccbd0a7..1848b00 100644 --- a/data_bridges_client/models/xls_form_list_choice_dto.py +++ b/data_bridges_client/models/xls_form_list_choice_dto.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) diff --git a/data_bridges_client/models/xls_form_list_choices_dto.py b/data_bridges_client/models/xls_form_list_choices_dto.py index 86dc5d3..8d164f0 100644 --- a/data_bridges_client/models/xls_form_list_choices_dto.py +++ b/data_bridges_client/models/xls_form_list_choices_dto.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) @@ -77,9 +77,9 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of each item in choices (list) _items = [] if self.choices: - for _item in self.choices: - if _item: - _items.append(_item.to_dict()) + for _item_choices in self.choices: + if _item_choices: + _items.append(_item_choices.to_dict()) _dict['choices'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: diff --git a/data_bridges_client/rest.py b/data_bridges_client/rest.py index ca9744b..4545923 100644 --- a/data_bridges_client/rest.py +++ b/data_bridges_client/rest.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) diff --git a/docs/CommoditiesApi.md b/docs/CommoditiesApi.md index 12b6cf7..d73b893 100644 --- a/docs/CommoditiesApi.md +++ b/docs/CommoditiesApi.md @@ -1,6 +1,6 @@ # data_bridges_client.CommoditiesApi -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* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -13,7 +13,7 @@ Method | HTTP request | Description 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 ### Example @@ -25,10 +25,10 @@ from data_bridges_client.models.paged_commodity_list_dto import PagedCommodityLi 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -99,7 +99,7 @@ Name | Type | Description | Notes 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 ### Example @@ -111,10 +111,10 @@ from data_bridges_client.models.paged_commodity_list_dto import PagedCommodityLi 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters diff --git a/docs/CommodityUnitsApi.md b/docs/CommodityUnitsApi.md index 9e45aa2..a8af464 100644 --- a/docs/CommodityUnitsApi.md +++ b/docs/CommodityUnitsApi.md @@ -1,6 +1,6 @@ # data_bridges_client.CommodityUnitsApi -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* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -13,7 +13,7 @@ Method | HTTP request | Description Provides conversion factors to Kilogram or Litres for each convertible unit of measure. - [![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_commodityunits-conversion-list_get\" Some non-standard units of measure might have different a conversion factor based on the country [Adm0Code]; Other non-standard units of measure might have a different conversion factor based on the commodity [CommodityID] being measured. Other cases will have null adm0code and CommodityID. 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_commodityunits-conversion-list_get\" Some non-standard units of measure might have different a conversion factor based on the country [Adm0Code]; Other non-standard units of measure might have a different conversion factor based on the commodity [CommodityID] being measured. Other cases will have null adm0code and CommodityID. No mandatory parameter. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -25,10 +25,10 @@ from data_bridges_client.models.paged_commodity_list_dto import PagedCommodityLi 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -101,7 +101,7 @@ Name | Type | Description | Notes Provides the detailed list of the unit of measure 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_commodityunits-list_get\" **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_commodityunits-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -113,10 +113,10 @@ from data_bridges_client.models.paged_commodity_list_dto import PagedCommodityLi 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters diff --git a/docs/CurrencyApi.md b/docs/CurrencyApi.md index dbd8824..29b344f 100644 --- a/docs/CurrencyApi.md +++ b/docs/CurrencyApi.md @@ -1,6 +1,6 @@ # data_bridges_client.CurrencyApi -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* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -13,7 +13,7 @@ Method | HTTP request | Description Returns the list of currencies available in the internal VAM database, with Currency 3-letter code, matching with ISO 4217. - [![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_currency-list_get\" **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_currency-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -25,10 +25,10 @@ from data_bridges_client.models.paged_currency_list_dto import PagedCurrencyList 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -99,7 +99,7 @@ Name | Type | Description | Notes Returns the value of the Exchange rates from Trading Economics, for official rates, and DataViz for unofficial rates. - [![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_currency-usdindirectquotation_get\" Returns the time series of values of the Exchange rate of the Local Currency for buying 1 USD in the official market. Original frequency for official rates is daily, non-indicated. Unofficial rates are aggregated at national level by the original frequency of collection. For greater detail on unofficial exchange rates, explore the Exchange Rate (unofficial) commodity in Market Prices Prices. 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_currency-usdindirectquotation_get\" Returns the time series of values of the Exchange rate of the Local Currency for buying 1 USD in the official market. Original frequency for official rates is daily, non-indicated. Unofficial rates are aggregated at national level by the original frequency of collection. For greater detail on unofficial exchange rates, explore the Exchange Rate (unofficial) commodity in Market Prices Prices. No mandatory parameter. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -111,10 +111,10 @@ from data_bridges_client.models.usd_indirect_quotation_paged_result import UsdIn 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters diff --git a/docs/EconomicDataApi.md b/docs/EconomicDataApi.md index febe502..72a365b 100644 --- a/docs/EconomicDataApi.md +++ b/docs/EconomicDataApi.md @@ -1,6 +1,6 @@ # data_bridges_client.EconomicDataApi -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* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -13,7 +13,7 @@ Method | HTTP request | Description Returns the lists of indicators. - [![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_economicdata-indicatorlist_get\" Returns the lists of indicators for which Vulnerability Analysis and Mapping - Economic and Market Analysis Unit has redistribution licensing from Trading Economics. 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_economicdata-indicatorlist_get\" Returns the lists of indicators for which Vulnerability Analysis and Mapping - Economic and Market Analysis Unit has redistribution licensing from Trading Economics. No mandatory parameter. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -25,10 +25,10 @@ from data_bridges_client.models.economic_indicator_property_paged_result import 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -97,7 +97,7 @@ Name | Type | Description | Notes Returns the time series of values for different indicators. - [![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_economicdata_get\" Indicator name as retrieved from /EconomicData/IndicatorList is mandatory. **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_economicdata_get\" Indicator name as retrieved from /EconomicData/IndicatorList is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -109,10 +109,10 @@ from data_bridges_client.models.paged_economic_data_dto import PagedEconomicData 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters diff --git a/docs/FoodSecurityApi.md b/docs/FoodSecurityApi.md index ecaa612..424741b 100644 --- a/docs/FoodSecurityApi.md +++ b/docs/FoodSecurityApi.md @@ -1,6 +1,6 @@ # data_bridges_client.FoodSecurityApi -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* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -12,7 +12,7 @@ Method | HTTP request | Description - [![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_foodsecurity-list_get\" **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_foodsecurity-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -24,10 +24,10 @@ from data_bridges_client.models.ipc_value_paged_result import IpcValuePagedResul 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters diff --git a/docs/GorpApi.md b/docs/GorpApi.md index 16e2485..ae8cf66 100644 --- a/docs/GorpApi.md +++ b/docs/GorpApi.md @@ -1,19 +1,174 @@ # data_bridges_client.GorpApi -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* Method | HTTP request | Description ------------- | ------------- | ------------- +[**gorp_country_latest_get**](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. +[**gorp_global_latest_get**](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. [**gorp_latest_get**](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. [**gorp_list_get**](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. +[**gorp_regional_latest_get**](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. +# **gorp_country_latest_get** +> List[GorpCountryApiDto] gorp_country_latest_get(env=env) + +Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan. + + [![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_gorp-countrylatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + +### Example + +* OAuth Authentication (default): + +```python +import data_bridges_client +from data_bridges_client.models.gorp_country_api_dto import GorpCountryApiDto +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 +# 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" +) + +# 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"] + +# 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.GorpApi(api_client) + env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) + + try: + # Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan. + api_response = api_instance.gorp_country_latest_get(env=env) + print("The response of GorpApi->gorp_country_latest_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GorpApi->gorp_country_latest_get: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] + +### Return type + +[**List[GorpCountryApiDto]**](GorpCountryApiDto.md) + +### Authorization + +[default](../README.md#default) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | + +[[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) + +# **gorp_global_latest_get** +> GorpGlobalApiDto gorp_global_latest_get(env=env) + +Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + + [![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_gorp-globallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + +### Example + +* OAuth Authentication (default): + +```python +import data_bridges_client +from data_bridges_client.models.gorp_global_api_dto import GorpGlobalApiDto +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 +# 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" +) + +# 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"] + +# 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.GorpApi(api_client) + env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) + + try: + # Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + api_response = api_instance.gorp_global_latest_get(env=env) + print("The response of GorpApi->gorp_global_latest_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GorpApi->gorp_global_latest_get: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] + +### Return type + +[**GorpGlobalApiDto**](GorpGlobalApiDto.md) + +### Authorization + +[default](../README.md#default) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | + +[[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) + # **gorp_latest_get** > GorpValueWithChangesPagedResult gorp_latest_get(page=page, env=env) Return the latest dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. - [![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_gorp-latest_get\" **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_gorp-latest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -25,10 +180,10 @@ from data_bridges_client.models.gorp_value_with_changes_paged_result import Gorp 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -91,7 +246,7 @@ Name | Type | Description | Notes Return the full dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. - [![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_gorp-list_get\" **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_gorp-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -103,10 +258,10 @@ from data_bridges_client.models.gorp_value_with_changes_paged_result import Gorp 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -164,3 +319,79 @@ 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) +# **gorp_regional_latest_get** +> List[GorpRegionalApiDto] gorp_regional_latest_get(env=env) + +Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + + [![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_gorp-regionallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + +### Example + +* OAuth Authentication (default): + +```python +import data_bridges_client +from data_bridges_client.models.gorp_regional_api_dto import GorpRegionalApiDto +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 +# 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" +) + +# 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"] + +# 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.GorpApi(api_client) + env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) + + try: + # Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + api_response = api_instance.gorp_regional_latest_get(env=env) + print("The response of GorpApi->gorp_regional_latest_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GorpApi->gorp_regional_latest_get: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] + +### Return type + +[**List[GorpRegionalApiDto]**](GorpRegionalApiDto.md) + +### Authorization + +[default](../README.md#default) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/plain, application/json, text/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**400** | Bad Request | - | + +[[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/GorpCountryApiDto.md b/docs/GorpCountryApiDto.md new file mode 100644 index 0000000..b338758 --- /dev/null +++ b/docs/GorpCountryApiDto.md @@ -0,0 +1,32 @@ +# GorpCountryApiDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**gorp_date** | **str** | | [optional] +**country_office_iso3** | **str** | | [optional] +**gorp_total_value** | **float** | | [optional] +**gorp_comment** | **str** | | [optional] + +## Example + +```python +from data_bridges_client.models.gorp_country_api_dto import GorpCountryApiDto + +# TODO update the JSON string below +json = "{}" +# create an instance of GorpCountryApiDto from a JSON string +gorp_country_api_dto_instance = GorpCountryApiDto.from_json(json) +# print the JSON string representation of the object +print(GorpCountryApiDto.to_json()) + +# convert the object into a dict +gorp_country_api_dto_dict = gorp_country_api_dto_instance.to_dict() +# create an instance of GorpCountryApiDto from a dict +gorp_country_api_dto_from_dict = GorpCountryApiDto.from_dict(gorp_country_api_dto_dict) +``` +[[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/GorpGlobalApiDto.md b/docs/GorpGlobalApiDto.md new file mode 100644 index 0000000..bd1a0ff --- /dev/null +++ b/docs/GorpGlobalApiDto.md @@ -0,0 +1,33 @@ +# GorpGlobalApiDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**gorp_date** | **str** | | [optional] +**gorp_region_name** | **str** | | [optional] +**gorp_total_value** | **float** | | [optional] +**number_of_countries** | **int** | | [optional] +**gorp_comment** | **str** | | [optional] + +## Example + +```python +from data_bridges_client.models.gorp_global_api_dto import GorpGlobalApiDto + +# TODO update the JSON string below +json = "{}" +# create an instance of GorpGlobalApiDto from a JSON string +gorp_global_api_dto_instance = GorpGlobalApiDto.from_json(json) +# print the JSON string representation of the object +print(GorpGlobalApiDto.to_json()) + +# convert the object into a dict +gorp_global_api_dto_dict = gorp_global_api_dto_instance.to_dict() +# create an instance of GorpGlobalApiDto from a dict +gorp_global_api_dto_from_dict = GorpGlobalApiDto.from_dict(gorp_global_api_dto_dict) +``` +[[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/GorpRegionalApiDto.md b/docs/GorpRegionalApiDto.md new file mode 100644 index 0000000..9b2bd69 --- /dev/null +++ b/docs/GorpRegionalApiDto.md @@ -0,0 +1,33 @@ +# GorpRegionalApiDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**gorp_date** | **str** | | [optional] +**gorp_region_name** | **str** | | [optional] +**gorp_total_value** | **float** | | [optional] +**number_of_countries** | **int** | | [optional] +**gorp_comment** | **str** | | [optional] + +## Example + +```python +from data_bridges_client.models.gorp_regional_api_dto import GorpRegionalApiDto + +# TODO update the JSON string below +json = "{}" +# create an instance of GorpRegionalApiDto from a JSON string +gorp_regional_api_dto_instance = GorpRegionalApiDto.from_json(json) +# print the JSON string representation of the object +print(GorpRegionalApiDto.to_json()) + +# convert the object into a dict +gorp_regional_api_dto_dict = gorp_regional_api_dto_instance.to_dict() +# create an instance of GorpRegionalApiDto from a dict +gorp_regional_api_dto_from_dict = GorpRegionalApiDto.from_dict(gorp_regional_api_dto_dict) +``` +[[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/HouseholdSurveyListDTO.md b/docs/HouseholdSurveyListDTO.md index d9ea20f..c8332b1 100644 --- a/docs/HouseholdSurveyListDTO.md +++ b/docs/HouseholdSurveyListDTO.md @@ -27,9 +27,11 @@ Name | Type | Description | Notes **survey_category_name** | **str** | | [optional] **survey_sub_category_name** | **str** | | [optional] **survey_phase_name** | **str** | | [optional] -**survey_visibilty** | **str** | | [optional] +**survey_visibility** | **str** | | [optional] **is_continuous_monitoring** | **bool** | | [optional] **survey_name** | **str** | | [optional] +**xls_form_id** | **int** | | [optional] +**base_xls_form_id** | **int** | | [optional] ## Example diff --git a/docs/IncubationApi.md b/docs/IncubationApi.md index 1635c2b..11a7b09 100644 --- a/docs/IncubationApi.md +++ b/docs/IncubationApi.md @@ -1,23 +1,173 @@ # data_bridges_client.IncubationApi -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* Method | HTTP request | Description ------------- | ------------- | ------------- -[**household_draft_internal_base_data_get**](IncubationApi.md#household_draft_internal_base_data_get) | **GET** /Household/DraftInternalBaseData | Get data that includes the core household fields only by Survey ID -[**household_full_data_get**](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. +[**aims_download_all_analysis_rounds_get**](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). +[**aims_download_polygon_files_get**](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). +[**household_draft_internal_base_data_get**](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. +[**household_full_data_get**](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. [**household_official_use_base_data_get**](IncubationApi.md#household_official_use_base_data_get) | **GET** /Household/OfficialUseBaseData | Get data that includes the core household fields only by Survey ID [**household_public_base_data_get**](IncubationApi.md#household_public_base_data_get) | **GET** /Household/PublicBaseData | Get data that includes the core household fields only by Survey ID [**household_surveys_get**](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. [**xls_forms_definition_get**](IncubationApi.md#xls_forms_definition_get) | **GET** /XlsForms/definition | Get a complete set of XLS Form definitions of a given XLS Form ID. This is the digital version of the questionnaire used during the data collection exercise. +# **aims_download_all_analysis_rounds_get** +> aims_download_all_analysis_rounds_get(adm0_code, env=env) + +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). + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadallanalysisrounds_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + +### Example + +* OAuth Authentication (default): + +```python +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 +# 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" +) + +# 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"] + +# 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.IncubationApi(api_client) + adm0_code = 56 # int | The country adm0Code + env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) + + try: + # 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). + api_instance.aims_download_all_analysis_rounds_get(adm0_code, env=env) + except Exception as e: + print("Exception when calling IncubationApi->aims_download_all_analysis_rounds_get: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **adm0_code** | **int**| The country adm0Code | + **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[default](../README.md#default) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | + +[[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) + +# **aims_download_polygon_files_get** +> aims_download_polygon_files_get(adm0_code, env=env) + +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). + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadpolygonfiles_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + +### Example + +* OAuth Authentication (default): + +```python +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 +# 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" +) + +# 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"] + +# 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.IncubationApi(api_client) + adm0_code = 56 # int | The country adm0Code + env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) + + try: + # 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). + api_instance.aims_download_polygon_files_get(adm0_code, env=env) + except Exception as e: + print("Exception when calling IncubationApi->aims_download_polygon_files_get: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **adm0_code** | **int**| The country adm0Code | + **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[default](../README.md#default) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | + +[[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) + # **household_draft_internal_base_data_get** -> PagedSurveyResponsesDTO household_draft_internal_base_data_get(survey_id=survey_id, page=page, page_size=page_size, env=env) +> PagedSurveyResponsesDTO household_draft_internal_base_data_get(api_key, survey_id=survey_id, page=page, page_size=page_size, env=env) -Get data that includes the core household fields only by Survey ID +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. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-draftinternalbasedata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-draftinternalbasedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -29,10 +179,10 @@ from data_bridges_client.models.paged_survey_responses_dto import PagedSurveyRes 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -46,14 +196,15 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] with data_bridges_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = data_bridges_client.IncubationApi(api_client) + api_key = 'api_key_example' # str | survey_id = 56 # int | unique identifier for the collected data, as retrieved from /Surveys API. (optional) page = 1 # int | page number for paged results (optional) (default to 1) page_size = 20 # int | page size for paged results, default value is 20. (optional) (default to 20) env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) try: - # Get data that includes the core household fields only by Survey ID - api_response = api_instance.household_draft_internal_base_data_get(survey_id=survey_id, page=page, page_size=page_size, env=env) + # 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. + api_response = api_instance.household_draft_internal_base_data_get(api_key, survey_id=survey_id, page=page, page_size=page_size, env=env) print("The response of IncubationApi->household_draft_internal_base_data_get:\n") pprint(api_response) except Exception as e: @@ -67,6 +218,7 @@ with data_bridges_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **api_key** | **str**| | **survey_id** | **int**| unique identifier for the collected data, as retrieved from /Surveys API. | [optional] **page** | **int**| page number for paged results | [optional] [default to 1] **page_size** | **int**| page size for paged results, default value is 20. | [optional] [default to 20] @@ -91,16 +243,17 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Success | - | **400** | Bad Request | - | +**403** | Forbidden | - | **404** | Not Found | - | [[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) # **household_full_data_get** -> PagedSurveyResponsesDTO household_full_data_get(survey_id=survey_id, format=format, page=page, page_size=page_size, env=env) +> PagedSurveyResponsesDTO household_full_data_get(api_key, survey_id=survey_id, format=format, page=page, page_size=page_size, env=env) -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. +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. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-fulldata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-fulldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -112,10 +265,10 @@ from data_bridges_client.models.paged_survey_responses_dto import PagedSurveyRes 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -129,6 +282,7 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] with data_bridges_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = data_bridges_client.IncubationApi(api_client) + api_key = 'api_key_example' # str | survey_id = 56 # int | unique identifier for the collected data, as retrieved from /Surveys API. (optional) format = 'json' # str | Output format: [JSON|CSV] Json is the default value (optional) (default to 'json') page = 1 # int | page number for paged results (optional) (default to 1) @@ -136,8 +290,8 @@ with data_bridges_client.ApiClient(configuration) as api_client: env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) try: - # 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. - api_response = api_instance.household_full_data_get(survey_id=survey_id, format=format, page=page, page_size=page_size, env=env) + # 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. + api_response = api_instance.household_full_data_get(api_key, survey_id=survey_id, format=format, page=page, page_size=page_size, env=env) print("The response of IncubationApi->household_full_data_get:\n") pprint(api_response) except Exception as e: @@ -151,6 +305,7 @@ with data_bridges_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **api_key** | **str**| | **survey_id** | **int**| unique identifier for the collected data, as retrieved from /Surveys API. | [optional] **format** | **str**| Output format: [JSON|CSV] Json is the default value | [optional] [default to 'json'] **page** | **int**| page number for paged results | [optional] [default to 1] @@ -176,6 +331,7 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Success | - | **400** | Bad Request | - | +**403** | Forbidden | - | **404** | Not Found | - | [[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) @@ -185,7 +341,7 @@ Name | Type | Description | Notes Get data that includes the core household fields only by Survey ID - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-officialusebasedata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-officialusebasedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -197,10 +353,10 @@ from data_bridges_client.models.paged_survey_responses_dto import PagedSurveyRes 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -268,7 +424,7 @@ Name | Type | Description | Notes Get data that includes the core household fields only by Survey ID - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-publicbasedata_get\" **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-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-publicbasedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -280,10 +436,10 @@ from data_bridges_client.models.paged_survey_responses_dto import PagedSurveyRes 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -347,11 +503,11 @@ 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) # **household_surveys_get** -> HouseholdSurveyListDTOPagedResult household_surveys_get(adm0_code=adm0_code, page=page, start_date=start_date, end_date=end_date, env=env) +> HouseholdSurveyListDTOPagedResult household_surveys_get(adm0_code=adm0_code, page=page, start_date=start_date, end_date=end_date, survey_id=survey_id, env=env) 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. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![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_household-surveys_get\" **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-Incubation-red)]() [![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_household-surveys_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -363,10 +519,10 @@ from data_bridges_client.models.household_survey_list_dto_paged_result import Ho 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -384,11 +540,12 @@ with data_bridges_client.ApiClient(configuration) as api_client: page = 1 # int | page number for paged results (optional) (default to 1) start_date = '2013-10-20T19:20:30+01:00' # datetime | starting date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24) (optional) end_date = '2013-10-20T19:20:30+01:00' # datetime | ending date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24) (optional) + survey_id = 56 # int | (optional) env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) try: # 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. - api_response = api_instance.household_surveys_get(adm0_code=adm0_code, page=page, start_date=start_date, end_date=end_date, env=env) + api_response = api_instance.household_surveys_get(adm0_code=adm0_code, page=page, start_date=start_date, end_date=end_date, survey_id=survey_id, env=env) print("The response of IncubationApi->household_surveys_get:\n") pprint(api_response) except Exception as e: @@ -406,6 +563,7 @@ Name | Type | Description | Notes **page** | **int**| page number for paged results | [optional] [default to 1] **start_date** | **datetime**| starting date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24) | [optional] **end_date** | **datetime**| ending date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24) | [optional] + **survey_id** | **int**| | [optional] **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] ### Return type @@ -435,7 +593,7 @@ Name | Type | Description | Notes Get a complete set of XLS Form definitions of a given XLS Form ID. This is the digital version of the questionnaire used during the data collection exercise. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![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_xlsforms-definition_get\" **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-Incubation-red)]() [![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_xlsforms-definition_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -447,10 +605,10 @@ from data_bridges_client.models.xls_form_definition_new_schema_dto import XlsFor 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters diff --git a/docs/MarketPricesApi.md b/docs/MarketPricesApi.md index 11a7e97..d8b14d0 100644 --- a/docs/MarketPricesApi.md +++ b/docs/MarketPricesApi.md @@ -1,6 +1,6 @@ # data_bridges_client.MarketPricesApi -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* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -16,7 +16,7 @@ Method | HTTP request | Description Returns time series values of ALPS and PEWI. - [![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_marketprices-alps_get\" Returns the full time series of the Alert for Price Spikes (ALPS) and the value of the Price Early Warning Index (PEWI). Methodology is available in [DataViz](https://dataviz.vam.wfp.org/) and [VAM-Resource Centre](https://resources.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-alps_get\" Returns the full time series of the Alert for Price Spikes (ALPS) and the value of the Price Early Warning Index (PEWI). Methodology is available in [DataViz](https://dataviz.vam.wfp.org/) and [VAM-Resource Centre](https://resources.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -28,10 +28,10 @@ from data_bridges_client.models.view_extended_alps_value_paged_result import Vie 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -114,7 +114,7 @@ Name | Type | Description | Notes Returns a daily time series of commodity market prices. - [![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_marketprices-pricedaily_get\" This is the highest frequency available. Data is flagged according to its pre-processing characteristics. Actual data is collected originally with daily frequency; aggregated data returns an empty list; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in DataLibrary. For specific methodological notes on forecasts and imputations refer to the dedicated page in DataViz. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-pricedaily_get\" This is the highest frequency available. Data is flagged according to its pre-processing characteristics. Actual data is collected originally with daily frequency; aggregated data returns an empty list; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in DataLibrary. For specific methodological notes on forecasts and imputations refer to the dedicated page in DataViz. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -126,10 +126,10 @@ from data_bridges_client.models.view_extended_aggregated_price_paged_result impo 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -212,7 +212,7 @@ Name | Type | Description | Notes Returns a monthly time series of commodity market prices. - [![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_marketprices-pricemonthly_get\" This is the lowest frequency available and the most complete data source. Data is flagged according to its pre-processing characteristics. actual data is collected originally with monthly frequency; aggregated data is collected with higher frequency (daily or weekly) averaged through a weighted mean to monthly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-pricemonthly_get\" This is the lowest frequency available and the most complete data source. Data is flagged according to its pre-processing characteristics. actual data is collected originally with monthly frequency; aggregated data is collected with higher frequency (daily or weekly) averaged through a weighted mean to monthly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -224,10 +224,10 @@ from data_bridges_client.models.view_extended_aggregated_price_paged_result impo 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -310,7 +310,7 @@ Name | Type | Description | Notes Returns original commodity market prices - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-priceraw_get\" Restricted endpoint. Returns the original data with the entire Commodity Price Metadata as inserted by the focal point, which might contain sensitive or personal informatio. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-priceraw_get\" Restricted endpoint. Returns the original data with the entire Commodity Price Metadata as inserted by the focal point, which might contain sensitive or personal informatio. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -322,10 +322,10 @@ from data_bridges_client.models.paged_commodity_price_list_dto import PagedCommo 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -408,7 +408,7 @@ Name | Type | Description | Notes Returns a weekly time series of commodity market prices. - [![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_marketprices-priceweekly_get\" Weeks used as reference are the International Organization for Standardization (ISO) week-numbering year (ISO-8601). Data is flagged according to its pre-processing characteristics. Aactual data is collected originally with weekly frequency; aggregated data is collected with higher frequency (daily) averaged through a weighted mean to weekly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **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_marketprices-priceweekly_get\" Weeks used as reference are the International Organization for Standardization (ISO) week-numbering year (ISO-8601). Data is flagged according to its pre-processing characteristics. Aactual data is collected originally with weekly frequency; aggregated data is collected with higher frequency (daily) averaged through a weighted mean to weekly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -420,10 +420,10 @@ from data_bridges_client.models.paged_commodity_weekly_aggregated_price_list_dto 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters diff --git a/docs/MarketsApi.md b/docs/MarketsApi.md index 29a3925..540a80d 100644 --- a/docs/MarketsApi.md +++ b/docs/MarketsApi.md @@ -1,6 +1,6 @@ # data_bridges_client.MarketsApi -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* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -15,7 +15,7 @@ Method | HTTP request | Description Provide a list of geo referenced markets in a specific country - [![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_markets-geojsonlist_get\" **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_markets-geojsonlist_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -27,10 +27,10 @@ from data_bridges_client.models.market_geo_json_root import MarketGeoJsonRoot 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -93,7 +93,7 @@ Name | Type | Description | Notes Get a complete list of markets in a country - [![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_markets-list_get\" **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_markets-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -105,10 +105,10 @@ from data_bridges_client.models.paged_market_list_dto import PagedMarketListDTO 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -174,7 +174,7 @@ Name | Type | Description | Notes Get a complete list of markets in a country - [![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_markets-marketsascsv_get\" **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_markets-marketsascsv_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -185,10 +185,10 @@ 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -252,7 +252,7 @@ Name | Type | Description | Notes Find markets near a given location by longitude and latitude within a 15Km distance - [![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_markets-nearbymarkets_get\" **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_markets-nearbymarkets_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -264,10 +264,10 @@ from data_bridges_client.models.nearby_markets_dto import NearbyMarketsDTO 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters diff --git a/docs/RpmeApi.md b/docs/RpmeApi.md index 183eb28..5951deb 100644 --- a/docs/RpmeApi.md +++ b/docs/RpmeApi.md @@ -1,6 +1,6 @@ # data_bridges_client.RpmeApi -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* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -17,7 +17,7 @@ Method | HTTP request | Description Get data that includes the core RPME fields only by Survey ID - [![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_rpme-basedata_get\" **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_rpme-basedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -29,10 +29,10 @@ from data_bridges_client.models.paged_survey_responses_dto import PagedSurveyRes 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -100,7 +100,7 @@ Name | Type | Description | Notes Get a full dataset that includes all the fields included in the survey in addition to the core RPME fields by Survey ID. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_rpme-fulldata_get\" **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%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_rpme-fulldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -112,10 +112,10 @@ from data_bridges_client.models.paged_survey_responses_dto import PagedSurveyRes 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -185,7 +185,7 @@ Name | Type | Description | Notes Processed values for each variable used in the assessments - [![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_rpme-outputvalues_get\" **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_rpme-outputvalues_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -197,10 +197,10 @@ from data_bridges_client.models.rpme_assessment_paged_result import RpmeAssessme 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -273,7 +273,7 @@ Name | Type | Description | Notes Retrieve 1) Survey IDs, 2) their corresponding XLS Form IDs, and 3) Base XLS Form of all RPME surveys conducted in a country. The date of reference, SurveyDate, for the data collection is set by the officer responsible for the upload of each survey. - [![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_rpme-surveys_get\" **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_rpme-surveys_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -285,10 +285,10 @@ from data_bridges_client.models.paged_survey_list_dto import PagedSurveyListDTO 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -357,7 +357,7 @@ Name | Type | Description | Notes List of variables - [![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_rpme-variables_get\" **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_rpme-variables_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -369,10 +369,10 @@ from data_bridges_client.models.rpme_variable_paged_result import RpmeVariablePa 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -435,7 +435,7 @@ Name | Type | Description | Notes Get a complete list of XLS Forms uploaded on the RPME in a given period of data collection. This is the digital version of the questionnaire used during the data collection exercise. - [![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_rpme-xlsforms_get\" **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_rpme-xlsforms_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -447,10 +447,10 @@ from data_bridges_client.models.paged_xls_form_list_dto import PagedXlsFormListD 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters diff --git a/docs/SurveysApi.md b/docs/SurveysApi.md index daf0248..1a7784a 100644 --- a/docs/SurveysApi.md +++ b/docs/SurveysApi.md @@ -1,6 +1,6 @@ # data_bridges_client.SurveysApi -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* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -15,7 +15,7 @@ Method | HTTP request | Description Get data that includes the core Market Functionality Index (MFI) fields only by Survey ID - [![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_mfi-surveys-basedata_get\" **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_mfi-surveys-basedata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -27,10 +27,10 @@ from data_bridges_client.models.paged_survey_responses_dto import PagedSurveyRes 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -98,7 +98,7 @@ Name | Type | Description | Notes Get a full dataset that includes all the fields included in the survey in addition to the core Market Functionality Index (MFI) fields by Survey ID. To access this data, please contact global.mfi@wfp.org for authorization. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-Restricted-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_mfi-surveys-fulldata_get\" **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%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_mfi-surveys-fulldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -110,10 +110,10 @@ from data_bridges_client.models.paged_survey_responses_dto import PagedSurveyRes 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -183,7 +183,7 @@ Name | Type | Description | Notes Retrieve 1) Survey IDs, 2) their corresponding XLS Form IDs, and 3) Base XLS Form of all MFI 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. - [![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_mfi-surveys_get\" **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_mfi-surveys_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -195,10 +195,10 @@ from data_bridges_client.models.paged_survey_list_dto import PagedSurveyListDTO 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters @@ -267,7 +267,7 @@ Name | Type | Description | Notes Get a MFI processed data in long format; levels indicate the data aggregation level 1) Normalized Score, 2) Trader Aggregate Score, 3) Market Aggregate Score, 4) Trader Median, 5) Trader Mean, 6) Market Mean; each line corresponds to one of the nine dimensions of scores plus the final MFI aggregate score; 1) Assortment, 2) Availability, 3) Price, 4) Resilience, 5) Competition, 6) Infrastructure, 7) Service, 8) Quality, 9) Access and Protection, and 10) MFI final score; the variable label describes each variable and its value range - [![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_mfi-surveys-processeddata_get\" **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_mfi-surveys-processeddata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -279,10 +279,10 @@ from data_bridges_client.models.paged_processed_data_dto import PagedProcessedDa 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters diff --git a/docs/XlsFormsApi.md b/docs/XlsFormsApi.md index c60734d..04ddefd 100644 --- a/docs/XlsFormsApi.md +++ b/docs/XlsFormsApi.md @@ -1,6 +1,6 @@ # data_bridges_client.XlsFormsApi -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* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -12,7 +12,7 @@ Method | HTTP request | Description Get a complete list of XLS Forms uploaded on the MFI Data Bridge in a given period of data collection. This is the digital version of the questionnaire used during the data collection exercise. - [![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_mfi-xlsforms_get\" **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_mfi-xlsforms_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -24,10 +24,10 @@ from data_bridges_client.models.paged_xls_form_list_dto import PagedXlsFormListD 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/4.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.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" ) # The client must configure the authentication and authorization parameters diff --git a/generate/README.md b/generate/README.md index 0727273..7df193e 100644 --- a/generate/README.md +++ b/generate/README.md @@ -6,7 +6,10 @@ Every time 1. Create a new branch `git checkout -b new_branch_name` 2. Install openapi-generator -```npm install @openapitools/openapi-generator-cli -g``` +```npm install @openapitools/openapi-generator-cli -g`` + +Make sure that the npm and its packages are in the PATH. + 2. Place the latest swagger.json in `./generate/swagger.json` diff --git a/openapitools.json b/openapitools.json new file mode 100644 index 0000000..2f4612c --- /dev/null +++ b/openapitools.json @@ -0,0 +1,7 @@ +{ + "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json", + "spaces": 2, + "generator-cli": { + "version": "7.8.0" + } +} diff --git a/pyproject.toml b/pyproject.toml index 296c6ff..29fd210 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "data_bridges_client" -version = "4.0.0" +version = "1.0.0" description = "VAM-Data-Bridges" authors = ["VAM-INFO "] license = "NoLicense" diff --git a/setup.py b/setup.py index 52659bb..2096e98 100644 --- a/setup.py +++ b/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: 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) @@ -26,7 +26,6 @@ PYTHON_REQUIRES = ">=3.7" REQUIRES = [ "urllib3 >= 1.25.3, < 2.1.0", - "httpx", "python-dateutil", "pydantic >= 2", "typing-extensions >= 4.7.1", diff --git a/test/test_bad_request_dto.py b/test/test_bad_request_dto.py index 287c204..245fda5 100644 --- a/test/test_bad_request_dto.py +++ b/test/test_bad_request_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> BadRequestDTO: """Test BadRequestDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `BadRequestDTO` diff --git a/test/test_commodities_api.py b/test/test_commodities_api.py index b55477b..3849ebb 100644 --- a/test/test_commodities_api.py +++ b/test/test_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) diff --git a/test/test_commodity_dto.py b/test/test_commodity_dto.py index 0ea9d0d..bdf93e5 100644 --- a/test/test_commodity_dto.py +++ b/test/test_commodity_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> CommodityDTO: """Test CommodityDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `CommodityDTO` diff --git a/test/test_commodity_price_dto.py b/test/test_commodity_price_dto.py index 7764dda..fe6e30c 100644 --- a/test/test_commodity_price_dto.py +++ b/test/test_commodity_price_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> CommodityPriceDTO: """Test CommodityPriceDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `CommodityPriceDTO` diff --git a/test/test_commodity_processing_dto.py b/test/test_commodity_processing_dto.py index 5ffdb7e..7cbdced 100644 --- a/test/test_commodity_processing_dto.py +++ b/test/test_commodity_processing_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> CommodityProcessingDTO: """Test CommodityProcessingDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `CommodityProcessingDTO` diff --git a/test/test_commodity_quality_dto.py b/test/test_commodity_quality_dto.py index 4590647..4933793 100644 --- a/test/test_commodity_quality_dto.py +++ b/test/test_commodity_quality_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> CommodityQualityDTO: """Test CommodityQualityDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `CommodityQualityDTO` diff --git a/test/test_commodity_units_api.py b/test/test_commodity_units_api.py index 35a432d..7432f03 100644 --- a/test/test_commodity_units_api.py +++ b/test/test_commodity_units_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) diff --git a/test/test_currency_api.py b/test/test_currency_api.py index b9a1d79..0ed0b19 100644 --- a/test/test_currency_api.py +++ b/test/test_currency_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) diff --git a/test/test_currency_dto.py b/test/test_currency_dto.py index 74d1240..6059572 100644 --- a/test/test_currency_dto.py +++ b/test/test_currency_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> CurrencyDTO: """Test CurrencyDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `CurrencyDTO` diff --git a/test/test_economic_data_api.py b/test/test_economic_data_api.py index a16c7ef..7ba73ef 100644 --- a/test/test_economic_data_api.py +++ b/test/test_economic_data_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) diff --git a/test/test_economic_data_dto.py b/test/test_economic_data_dto.py index 4b8cd7d..fbdbfc4 100644 --- a/test/test_economic_data_dto.py +++ b/test/test_economic_data_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> EconomicDataDTO: """Test EconomicDataDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `EconomicDataDTO` diff --git a/test/test_economic_indicator_property.py b/test/test_economic_indicator_property.py index 84ba7a4..31bdb7c 100644 --- a/test/test_economic_indicator_property.py +++ b/test/test_economic_indicator_property.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> EconomicIndicatorProperty: """Test EconomicIndicatorProperty - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `EconomicIndicatorProperty` diff --git a/test/test_economic_indicator_property_paged_result.py b/test/test_economic_indicator_property_paged_result.py index ced5d50..2031a19 100644 --- a/test/test_economic_indicator_property_paged_result.py +++ b/test/test_economic_indicator_property_paged_result.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> EconomicIndicatorPropertyPagedResult: """Test EconomicIndicatorPropertyPagedResult - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `EconomicIndicatorPropertyPagedResult` diff --git a/test/test_feature.py b/test/test_feature.py index c8d3efd..24d5b15 100644 --- a/test/test_feature.py +++ b/test/test_feature.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> Feature: """Test Feature - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `Feature` diff --git a/test/test_food_security_api.py b/test/test_food_security_api.py index e1be833..dc82b48 100644 --- a/test/test_food_security_api.py +++ b/test/test_food_security_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) diff --git a/test/test_geometry.py b/test/test_geometry.py index 56bb205..efbaaf4 100644 --- a/test/test_geometry.py +++ b/test/test_geometry.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> Geometry: """Test Geometry - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `Geometry` diff --git a/test/test_gorp_api.py b/test/test_gorp_api.py index e31a281..58af78f 100644 --- a/test/test_gorp_api.py +++ b/test/test_gorp_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) @@ -27,6 +27,20 @@ def setUp(self) -> None: def tearDown(self) -> None: pass + def test_gorp_country_latest_get(self) -> None: + """Test case for gorp_country_latest_get + + Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan. + """ + pass + + def test_gorp_global_latest_get(self) -> None: + """Test case for gorp_global_latest_get + + Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + """ + pass + def test_gorp_latest_get(self) -> None: """Test case for gorp_latest_get @@ -41,6 +55,13 @@ def test_gorp_list_get(self) -> None: """ pass + def test_gorp_regional_latest_get(self) -> None: + """Test case for gorp_regional_latest_get + + Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + """ + pass + if __name__ == '__main__': unittest.main() diff --git a/test/test_gorp_country_api_dto.py b/test/test_gorp_country_api_dto.py new file mode 100644 index 0000000..e62c2ed --- /dev/null +++ b/test/test_gorp_country_api_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + 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 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.gorp_country_api_dto import GorpCountryApiDto + +class TestGorpCountryApiDto(unittest.TestCase): + """GorpCountryApiDto unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GorpCountryApiDto: + """Test GorpCountryApiDto + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `GorpCountryApiDto` + """ + model = GorpCountryApiDto() + if include_optional: + return GorpCountryApiDto( + gorp_date = '', + country_office_iso3 = '', + gorp_total_value = 1.337, + gorp_comment = '' + ) + else: + return GorpCountryApiDto( + ) + """ + + def testGorpCountryApiDto(self): + """Test GorpCountryApiDto""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_gorp_global_api_dto.py b/test/test_gorp_global_api_dto.py new file mode 100644 index 0000000..53cf365 --- /dev/null +++ b/test/test_gorp_global_api_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + 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 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.gorp_global_api_dto import GorpGlobalApiDto + +class TestGorpGlobalApiDto(unittest.TestCase): + """GorpGlobalApiDto unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GorpGlobalApiDto: + """Test GorpGlobalApiDto + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `GorpGlobalApiDto` + """ + model = GorpGlobalApiDto() + if include_optional: + return GorpGlobalApiDto( + gorp_date = '', + gorp_region_name = '', + gorp_total_value = 1.337, + number_of_countries = 56, + gorp_comment = '' + ) + else: + return GorpGlobalApiDto( + ) + """ + + def testGorpGlobalApiDto(self): + """Test GorpGlobalApiDto""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_gorp_regional_api_dto.py b/test/test_gorp_regional_api_dto.py new file mode 100644 index 0000000..6d09b23 --- /dev/null +++ b/test/test_gorp_regional_api_dto.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + 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 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.gorp_regional_api_dto import GorpRegionalApiDto + +class TestGorpRegionalApiDto(unittest.TestCase): + """GorpRegionalApiDto unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GorpRegionalApiDto: + """Test GorpRegionalApiDto + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `GorpRegionalApiDto` + """ + model = GorpRegionalApiDto() + if include_optional: + return GorpRegionalApiDto( + gorp_date = '', + gorp_region_name = '', + gorp_total_value = 1.337, + number_of_countries = 56, + gorp_comment = '' + ) + else: + return GorpRegionalApiDto( + ) + """ + + def testGorpRegionalApiDto(self): + """Test GorpRegionalApiDto""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_gorp_value_with_changes.py b/test/test_gorp_value_with_changes.py index 9bfd214..8bb6cb8 100644 --- a/test/test_gorp_value_with_changes.py +++ b/test/test_gorp_value_with_changes.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> GorpValueWithChanges: """Test GorpValueWithChanges - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `GorpValueWithChanges` diff --git a/test/test_gorp_value_with_changes_paged_result.py b/test/test_gorp_value_with_changes_paged_result.py index e090a07..2f06fe0 100644 --- a/test/test_gorp_value_with_changes_paged_result.py +++ b/test/test_gorp_value_with_changes_paged_result.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> GorpValueWithChangesPagedResult: """Test GorpValueWithChangesPagedResult - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `GorpValueWithChangesPagedResult` diff --git a/test/test_household_survey_list_dto.py b/test/test_household_survey_list_dto.py index 59b1ccc..df52389 100644 --- a/test/test_household_survey_list_dto.py +++ b/test/test_household_survey_list_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> HouseholdSurveyListDTO: """Test HouseholdSurveyListDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `HouseholdSurveyListDTO` @@ -66,9 +66,11 @@ def make_instance(self, include_optional) -> HouseholdSurveyListDTO: survey_category_name = '', survey_sub_category_name = '', survey_phase_name = '', - survey_visibilty = '', + survey_visibility = '', is_continuous_monitoring = True, - survey_name = '' + survey_name = '', + xls_form_id = 56, + base_xls_form_id = 56 ) else: return HouseholdSurveyListDTO( diff --git a/test/test_household_survey_list_dto_paged_result.py b/test/test_household_survey_list_dto_paged_result.py index 5c283f1..19c8ba6 100644 --- a/test/test_household_survey_list_dto_paged_result.py +++ b/test/test_household_survey_list_dto_paged_result.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> HouseholdSurveyListDTOPagedResult: """Test HouseholdSurveyListDTOPagedResult - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `HouseholdSurveyListDTOPagedResult` diff --git a/test/test_incubation_api.py b/test/test_incubation_api.py index a58cafe..77b869f 100644 --- a/test/test_incubation_api.py +++ b/test/test_incubation_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) @@ -27,17 +27,31 @@ def setUp(self) -> None: def tearDown(self) -> None: pass + def test_aims_download_all_analysis_rounds_get(self) -> None: + """Test case for aims_download_all_analysis_rounds_get + + 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). + """ + pass + + def test_aims_download_polygon_files_get(self) -> None: + """Test case for aims_download_polygon_files_get + + 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). + """ + pass + def test_household_draft_internal_base_data_get(self) -> None: """Test case for household_draft_internal_base_data_get - Get data that includes the core household fields only by Survey ID + 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. """ pass def test_household_full_data_get(self) -> None: """Test case for household_full_data_get - 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. + 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. """ pass diff --git a/test/test_ipc_value.py b/test/test_ipc_value.py index 874bf90..e3331b4 100644 --- a/test/test_ipc_value.py +++ b/test/test_ipc_value.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> IpcValue: """Test IpcValue - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `IpcValue` diff --git a/test/test_ipc_value_paged_result.py b/test/test_ipc_value_paged_result.py index 0da8eda..c0b936b 100644 --- a/test/test_ipc_value_paged_result.py +++ b/test/test_ipc_value_paged_result.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> IpcValuePagedResult: """Test IpcValuePagedResult - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `IpcValuePagedResult` diff --git a/test/test_key_name_dto.py b/test/test_key_name_dto.py index 182de66..6680a56 100644 --- a/test/test_key_name_dto.py +++ b/test/test_key_name_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> KeyNameDto: """Test KeyNameDto - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `KeyNameDto` diff --git a/test/test_market_dto.py b/test/test_market_dto.py index 3b25bf6..4731783 100644 --- a/test/test_market_dto.py +++ b/test/test_market_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> MarketDTO: """Test MarketDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `MarketDTO` diff --git a/test/test_market_geo_json_root.py b/test/test_market_geo_json_root.py index aa4c0d8..babe31d 100644 --- a/test/test_market_geo_json_root.py +++ b/test/test_market_geo_json_root.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> MarketGeoJsonRoot: """Test MarketGeoJsonRoot - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `MarketGeoJsonRoot` diff --git a/test/test_market_prices_api.py b/test/test_market_prices_api.py index e1d738a..d4154e5 100644 --- a/test/test_market_prices_api.py +++ b/test/test_market_prices_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) diff --git a/test/test_markets_api.py b/test/test_markets_api.py index 6c30c79..b19c004 100644 --- a/test/test_markets_api.py +++ b/test/test_markets_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) diff --git a/test/test_mfi_processed_data_dto.py b/test/test_mfi_processed_data_dto.py index 3c487e0..b648be2 100644 --- a/test/test_mfi_processed_data_dto.py +++ b/test/test_mfi_processed_data_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> MFIProcessedDataDTO: """Test MFIProcessedDataDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `MFIProcessedDataDTO` diff --git a/test/test_nearby_markets_dto.py b/test/test_nearby_markets_dto.py index 485874a..8e8a75c 100644 --- a/test/test_nearby_markets_dto.py +++ b/test/test_nearby_markets_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> NearbyMarketsDTO: """Test NearbyMarketsDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `NearbyMarketsDTO` diff --git a/test/test_paged_commodity_list_dto.py b/test/test_paged_commodity_list_dto.py index 2bb2aa7..db23ee9 100644 --- a/test/test_paged_commodity_list_dto.py +++ b/test/test_paged_commodity_list_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> PagedCommodityListDTO: """Test PagedCommodityListDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `PagedCommodityListDTO` diff --git a/test/test_paged_commodity_price_list_dto.py b/test/test_paged_commodity_price_list_dto.py index 5569ba5..0894952 100644 --- a/test/test_paged_commodity_price_list_dto.py +++ b/test/test_paged_commodity_price_list_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> PagedCommodityPriceListDTO: """Test PagedCommodityPriceListDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `PagedCommodityPriceListDTO` diff --git a/test/test_paged_commodity_weekly_aggregated_price_list_dto.py b/test/test_paged_commodity_weekly_aggregated_price_list_dto.py index 9167c5d..5667a54 100644 --- a/test/test_paged_commodity_weekly_aggregated_price_list_dto.py +++ b/test/test_paged_commodity_weekly_aggregated_price_list_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> PagedCommodityWeeklyAggregatedPriceListDTO: """Test PagedCommodityWeeklyAggregatedPriceListDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `PagedCommodityWeeklyAggregatedPriceListDTO` diff --git a/test/test_paged_currency_list_dto.py b/test/test_paged_currency_list_dto.py index c52ef3f..ce6e29b 100644 --- a/test/test_paged_currency_list_dto.py +++ b/test/test_paged_currency_list_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> PagedCurrencyListDTO: """Test PagedCurrencyListDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `PagedCurrencyListDTO` diff --git a/test/test_paged_economic_data_dto.py b/test/test_paged_economic_data_dto.py index 9008948..64e4262 100644 --- a/test/test_paged_economic_data_dto.py +++ b/test/test_paged_economic_data_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> PagedEconomicDataDTO: """Test PagedEconomicDataDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `PagedEconomicDataDTO` diff --git a/test/test_paged_market_list_dto.py b/test/test_paged_market_list_dto.py index ac28658..d8da139 100644 --- a/test/test_paged_market_list_dto.py +++ b/test/test_paged_market_list_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> PagedMarketListDTO: """Test PagedMarketListDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `PagedMarketListDTO` diff --git a/test/test_paged_processed_data_dto.py b/test/test_paged_processed_data_dto.py index 60d9627..003da51 100644 --- a/test/test_paged_processed_data_dto.py +++ b/test/test_paged_processed_data_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> PagedProcessedDataDTO: """Test PagedProcessedDataDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `PagedProcessedDataDTO` diff --git a/test/test_paged_survey_list_dto.py b/test/test_paged_survey_list_dto.py index 983034c..26070b5 100644 --- a/test/test_paged_survey_list_dto.py +++ b/test/test_paged_survey_list_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> PagedSurveyListDTO: """Test PagedSurveyListDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `PagedSurveyListDTO` diff --git a/test/test_paged_survey_responses_dto.py b/test/test_paged_survey_responses_dto.py index 8b553aa..158d80b 100644 --- a/test/test_paged_survey_responses_dto.py +++ b/test/test_paged_survey_responses_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> PagedSurveyResponsesDTO: """Test PagedSurveyResponsesDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `PagedSurveyResponsesDTO` diff --git a/test/test_paged_xls_form_list_dto.py b/test/test_paged_xls_form_list_dto.py index 8eb3b05..2cf960b 100644 --- a/test/test_paged_xls_form_list_dto.py +++ b/test/test_paged_xls_form_list_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> PagedXlsFormListDTO: """Test PagedXlsFormListDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `PagedXlsFormListDTO` diff --git a/test/test_problem_details.py b/test/test_problem_details.py index d56d565..767f4de 100644 --- a/test/test_problem_details.py +++ b/test/test_problem_details.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> ProblemDetails: """Test ProblemDetails - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `ProblemDetails` diff --git a/test/test_properties.py b/test/test_properties.py index 31f54d3..004dd03 100644 --- a/test/test_properties.py +++ b/test/test_properties.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> Properties: """Test Properties - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `Properties` diff --git a/test/test_rpme_api.py b/test/test_rpme_api.py index 2d33f19..c3f410a 100644 --- a/test/test_rpme_api.py +++ b/test/test_rpme_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) diff --git a/test/test_rpme_assessment.py b/test/test_rpme_assessment.py index 3f66ed3..eb55875 100644 --- a/test/test_rpme_assessment.py +++ b/test/test_rpme_assessment.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> RpmeAssessment: """Test RpmeAssessment - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `RpmeAssessment` diff --git a/test/test_rpme_assessment_paged_result.py b/test/test_rpme_assessment_paged_result.py index 0ee4543..fe218e9 100644 --- a/test/test_rpme_assessment_paged_result.py +++ b/test/test_rpme_assessment_paged_result.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> RpmeAssessmentPagedResult: """Test RpmeAssessmentPagedResult - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `RpmeAssessmentPagedResult` diff --git a/test/test_rpme_output_values.py b/test/test_rpme_output_values.py index cd4c109..3de4879 100644 --- a/test/test_rpme_output_values.py +++ b/test/test_rpme_output_values.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> RpmeOutputValues: """Test RpmeOutputValues - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `RpmeOutputValues` diff --git a/test/test_rpme_variable.py b/test/test_rpme_variable.py index 41c7eac..974f518 100644 --- a/test/test_rpme_variable.py +++ b/test/test_rpme_variable.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> RpmeVariable: """Test RpmeVariable - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `RpmeVariable` diff --git a/test/test_rpme_variable_paged_result.py b/test/test_rpme_variable_paged_result.py index 79eaf5d..e653908 100644 --- a/test/test_rpme_variable_paged_result.py +++ b/test/test_rpme_variable_paged_result.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> RpmeVariablePagedResult: """Test RpmeVariablePagedResult - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `RpmeVariablePagedResult` diff --git a/test/test_survey_list_dto.py b/test/test_survey_list_dto.py index 2a4e33f..9d9f07f 100644 --- a/test/test_survey_list_dto.py +++ b/test/test_survey_list_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> SurveyListDTO: """Test SurveyListDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `SurveyListDTO` diff --git a/test/test_surveys_api.py b/test/test_surveys_api.py index ff6e116..cadaafb 100644 --- a/test/test_surveys_api.py +++ b/test/test_surveys_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) diff --git a/test/test_usd_indirect_quotation.py b/test/test_usd_indirect_quotation.py index f1f75aa..7636bab 100644 --- a/test/test_usd_indirect_quotation.py +++ b/test/test_usd_indirect_quotation.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> UsdIndirectQuotation: """Test UsdIndirectQuotation - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `UsdIndirectQuotation` diff --git a/test/test_usd_indirect_quotation_paged_result.py b/test/test_usd_indirect_quotation_paged_result.py index bd8695d..2c53e13 100644 --- a/test/test_usd_indirect_quotation_paged_result.py +++ b/test/test_usd_indirect_quotation_paged_result.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> UsdIndirectQuotationPagedResult: """Test UsdIndirectQuotationPagedResult - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `UsdIndirectQuotationPagedResult` diff --git a/test/test_view_extended_aggregated_price.py b/test/test_view_extended_aggregated_price.py index 1d13943..f613236 100644 --- a/test/test_view_extended_aggregated_price.py +++ b/test/test_view_extended_aggregated_price.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> ViewExtendedAggregatedPrice: """Test ViewExtendedAggregatedPrice - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `ViewExtendedAggregatedPrice` diff --git a/test/test_view_extended_aggregated_price_paged_result.py b/test/test_view_extended_aggregated_price_paged_result.py index 6500ac2..e5edb02 100644 --- a/test/test_view_extended_aggregated_price_paged_result.py +++ b/test/test_view_extended_aggregated_price_paged_result.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> ViewExtendedAggregatedPricePagedResult: """Test ViewExtendedAggregatedPricePagedResult - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `ViewExtendedAggregatedPricePagedResult` diff --git a/test/test_view_extended_alps_value.py b/test/test_view_extended_alps_value.py index 44ea75a..3d64d71 100644 --- a/test/test_view_extended_alps_value.py +++ b/test/test_view_extended_alps_value.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> ViewExtendedAlpsValue: """Test ViewExtendedAlpsValue - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `ViewExtendedAlpsValue` diff --git a/test/test_view_extended_alps_value_paged_result.py b/test/test_view_extended_alps_value_paged_result.py index ff58635..d0e7191 100644 --- a/test/test_view_extended_alps_value_paged_result.py +++ b/test/test_view_extended_alps_value_paged_result.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> ViewExtendedAlpsValuePagedResult: """Test ViewExtendedAlpsValuePagedResult - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `ViewExtendedAlpsValuePagedResult` diff --git a/test/test_weekly_aggregated_price.py b/test/test_weekly_aggregated_price.py index 85f4abe..4f9067e 100644 --- a/test/test_weekly_aggregated_price.py +++ b/test/test_weekly_aggregated_price.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> WeeklyAggregatedPrice: """Test WeeklyAggregatedPrice - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `WeeklyAggregatedPrice` diff --git a/test/test_xls_form_definition_new_schema_dto.py b/test/test_xls_form_definition_new_schema_dto.py index 81ff9df..63a2bb6 100644 --- a/test/test_xls_form_definition_new_schema_dto.py +++ b/test/test_xls_form_definition_new_schema_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> XlsFormDefinitionNewSchemaDTO: """Test XlsFormDefinitionNewSchemaDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `XlsFormDefinitionNewSchemaDTO` diff --git a/test/test_xls_form_dto.py b/test/test_xls_form_dto.py index b934775..742d6da 100644 --- a/test/test_xls_form_dto.py +++ b/test/test_xls_form_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> XlsFormDTO: """Test XlsFormDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `XlsFormDTO` diff --git a/test/test_xls_form_fields_dto.py b/test/test_xls_form_fields_dto.py index ea87a61..f318cfd 100644 --- a/test/test_xls_form_fields_dto.py +++ b/test/test_xls_form_fields_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> XlsFormFieldsDTO: """Test XlsFormFieldsDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `XlsFormFieldsDTO` diff --git a/test/test_xls_form_list_choice_dto.py b/test/test_xls_form_list_choice_dto.py index 0a3e1ed..20815ab 100644 --- a/test/test_xls_form_list_choice_dto.py +++ b/test/test_xls_form_list_choice_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> XlsFormListChoiceDTO: """Test XlsFormListChoiceDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `XlsFormListChoiceDTO` diff --git a/test/test_xls_form_list_choices_dto.py b/test/test_xls_form_list_choices_dto.py index 805d82b..787323c 100644 --- a/test/test_xls_form_list_choices_dto.py +++ b/test/test_xls_form_list_choices_dto.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) @@ -28,7 +28,7 @@ def tearDown(self): def make_instance(self, include_optional) -> XlsFormListChoicesDTO: """Test XlsFormListChoicesDTO - include_option is a boolean, when False only required + include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ # uncomment below to create an instance of `XlsFormListChoicesDTO` diff --git a/test/test_xls_forms_api.py b/test/test_xls_forms_api.py index 8c11b42..27011c2 100644 --- a/test/test_xls_forms_api.py +++ b/test/test_xls_forms_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) From 1e4c765f80e40036178a1ca157abe20920bc10f0 Mon Sep 17 00:00:00 2001 From: Alessandra Gherardelli Date: Wed, 11 Sep 2024 10:30:05 +0200 Subject: [PATCH 3/7] docs: corrected version number --- README.md | 2 +- pyproject.toml | 2 +- setup.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0eb630a..801d065 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ 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: 5.0.0 -- Package version: 1.0.0 +- Package version: 5.0.0 - Generator version: 7.8.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen diff --git a/pyproject.toml b/pyproject.toml index 29fd210..a4c41e7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "data_bridges_client" -version = "1.0.0" +version = "5.0.0" description = "VAM-Data-Bridges" authors = ["VAM-INFO "] license = "NoLicense" diff --git a/setup.py b/setup.py index 2096e98..9fd6a69 100644 --- a/setup.py +++ b/setup.py @@ -22,7 +22,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "data-bridges-client" -VERSION = "1.0.0" +VERSION = "5.0.0" PYTHON_REQUIRES = ">=3.7" REQUIRES = [ "urllib3 >= 1.25.3, < 2.1.0", From bd85c0960eb98a7be0faa84786538b8373c50f91 Mon Sep 17 00:00:00 2001 From: Alessandra Gherardelli Date: Wed, 11 Sep 2024 10:49:00 +0200 Subject: [PATCH 4/7] docs: reverted README and setup.py to include custom features --- README.md | 41 +++++++++++++---------------------------- setup.py | 5 +++-- 2 files changed, 16 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 801d065..2cf6dbf 100644 --- a/README.md +++ b/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,11 +216,9 @@ 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 @@ -238,15 +226,12 @@ Authentication schemes defined for the API: - **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/setup.py b/setup.py index 9fd6a69..df39ad3 100644 --- a/setup.py +++ b/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=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 """, # noqa: E501 package_data={"data_bridges_client": ["py.typed"]}, -) +) \ No newline at end of file From 577d92fa14769aa5744ca8d76a4250fea52a1aee Mon Sep 17 00:00:00 2001 From: Alessandra Gherardelli Date: Wed, 11 Sep 2024 10:50:46 +0200 Subject: [PATCH 5/7] docs: updated readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2cf6dbf..e5ce76d 100644 --- a/README.md +++ b/README.md @@ -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@release/v4.1 +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`) From 200a2ee9be194e41d6a366be1b1a4c2194d616bb Mon Sep 17 00:00:00 2001 From: Alessandra Gherardelli Date: Wed, 11 Sep 2024 16:52:06 +0200 Subject: [PATCH 6/7] Updated example main --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e5ce76d..9061e41 100644 --- a/README.md +++ b/README.md @@ -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 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.1.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.1.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.0.0* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- From 8959222152a8a2a0f57ed66bccdc0efd35873fbc Mon Sep 17 00:00:00 2001 From: Alessandra Gherardelli Date: Thu, 12 Sep 2024 15:56:02 +0200 Subject: [PATCH 7/7] docs: updated README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9061e41..13c05a2 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ 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 +from data_bridges_client.token import WfpApiToken from pprint import pprint # Configure OAuth2 access token for authorization: default