From 5d9508995bf96024b35c43839aee791b26b15cc6 Mon Sep 17 00:00:00 2001 From: Alessandra Gherardelli Date: Thu, 12 Dec 2024 12:11:08 +0100 Subject: [PATCH 1/6] feature: DataBrides client for API v5.1.0 --- .gitignore | 2 - README.md | 47 +- data_bridges_client/__init__.py | 2 +- data_bridges_client/api/commodities_api.py | 2 +- .../api/commodity_units_api.py | 2 +- data_bridges_client/api/currency_api.py | 2 +- data_bridges_client/api/economic_data_api.py | 2 +- data_bridges_client/api/food_security_api.py | 2 +- data_bridges_client/api/gorp_api.py | 2 +- data_bridges_client/api/incubation_api.py | 423 +- data_bridges_client/api/market_prices_api.py | 2 +- data_bridges_client/api/markets_api.py | 2 +- data_bridges_client/api/rpme_api.py | 2 +- data_bridges_client/api/surveys_api.py | 2 +- data_bridges_client/api/xls_forms_api.py | 2 +- data_bridges_client/api_client.py | 2 +- data_bridges_client/configuration.py | 8 +- data_bridges_client/exceptions.py | 2 +- data_bridges_client/models/__init__.py | 2 +- data_bridges_client/models/bad_request_dto.py | 2 +- data_bridges_client/models/commodity_dto.py | 2 +- .../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 | 2 +- data_bridges_client/models/feature.py | 2 +- data_bridges_client/models/geometry.py | 2 +- .../models/gorp_country_api_dto.py | 2 +- .../models/gorp_global_api_dto.py | 2 +- .../models/gorp_regional_api_dto.py | 2 +- .../models/gorp_value_with_changes.py | 2 +- .../gorp_value_with_changes_paged_result.py | 2 +- .../models/household_survey_list_dto.py | 2 +- .../household_survey_list_dto_paged_result.py | 2 +- data_bridges_client/models/ipc_value.py | 2 +- .../models/ipc_value_paged_result.py | 2 +- data_bridges_client/models/key_name_dto.py | 2 +- data_bridges_client/models/market_dto.py | 2 +- .../models/market_geo_json_root.py | 2 +- .../models/mfi_processed_data_dto.py | 2 +- .../models/nearby_markets_dto.py | 2 +- .../models/paged_commodity_list_dto.py | 2 +- .../models/paged_commodity_price_list_dto.py | 2 +- ...modity_weekly_aggregated_price_list_dto.py | 2 +- .../models/paged_currency_list_dto.py | 2 +- .../models/paged_economic_data_dto.py | 2 +- .../models/paged_market_list_dto.py | 2 +- .../models/paged_processed_data_dto.py | 6 +- .../models/paged_survey_list_dto.py | 2 +- .../models/paged_survey_responses_dto.py | 2 +- .../models/paged_xls_form_list_dto.py | 2 +- data_bridges_client/models/problem_details.py | 2 +- data_bridges_client/models/properties.py | 2 +- data_bridges_client/models/rpme_assessment.py | 2 +- .../models/rpme_assessment_paged_result.py | 2 +- .../models/rpme_output_values.py | 2 +- data_bridges_client/models/rpme_variable.py | 2 +- .../models/rpme_variable_paged_result.py | 2 +- data_bridges_client/models/survey_list_dto.py | 2 +- .../models/usd_indirect_quotation.py | 2 +- .../usd_indirect_quotation_paged_result.py | 2 +- .../models/view_extended_aggregated_price.py | 2 +- ..._extended_aggregated_price_paged_result.py | 2 +- .../models/view_extended_alps_value.py | 2 +- .../view_extended_alps_value_paged_result.py | 2 +- .../models/weekly_aggregated_price.py | 2 +- .../xls_form_definition_new_schema_dto.py | 2 +- 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 | 2 +- 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 | 32 +- docs/IncubationApi.md | 143 +- docs/MarketPricesApi.md | 32 +- docs/MarketsApi.md | 26 +- docs/PagedProcessedDataDTO.md | 1 + docs/RpmeApi.md | 38 +- docs/SurveysApi.md | 26 +- docs/XlsFormsApi.md | 8 +- generate/swagger_v5.1.0.json | 7229 +++++++++++++++++ pyproject.toml | 2 +- setup.py | 7 +- test/test_bad_request_dto.py | 2 +- test/test_commodities_api.py | 2 +- test/test_commodity_dto.py | 2 +- test/test_commodity_price_dto.py | 2 +- test/test_commodity_processing_dto.py | 2 +- test/test_commodity_quality_dto.py | 2 +- test/test_commodity_units_api.py | 2 +- test/test_currency_api.py | 2 +- test/test_currency_dto.py | 2 +- test/test_economic_data_api.py | 2 +- test/test_economic_data_dto.py | 2 +- test/test_economic_indicator_property.py | 2 +- ...conomic_indicator_property_paged_result.py | 2 +- test/test_feature.py | 2 +- test/test_food_security_api.py | 2 +- test/test_geometry.py | 2 +- test/test_gorp_api.py | 2 +- test/test_gorp_country_api_dto.py | 2 +- test/test_gorp_global_api_dto.py | 2 +- test/test_gorp_regional_api_dto.py | 2 +- test/test_gorp_value_with_changes.py | 2 +- ...st_gorp_value_with_changes_paged_result.py | 2 +- test/test_household_survey_list_dto.py | 2 +- ..._household_survey_list_dto_paged_result.py | 2 +- test/test_incubation_api.py | 9 +- test/test_ipc_value.py | 2 +- test/test_ipc_value_paged_result.py | 2 +- test/test_key_name_dto.py | 2 +- test/test_market_dto.py | 2 +- test/test_market_geo_json_root.py | 2 +- test/test_market_prices_api.py | 2 +- test/test_markets_api.py | 2 +- test/test_mfi_processed_data_dto.py | 2 +- test/test_nearby_markets_dto.py | 2 +- test/test_paged_commodity_list_dto.py | 2 +- test/test_paged_commodity_price_list_dto.py | 2 +- ...modity_weekly_aggregated_price_list_dto.py | 2 +- test/test_paged_currency_list_dto.py | 2 +- test/test_paged_economic_data_dto.py | 2 +- test/test_paged_market_list_dto.py | 2 +- test/test_paged_processed_data_dto.py | 3 +- test/test_paged_survey_list_dto.py | 2 +- test/test_paged_survey_responses_dto.py | 2 +- test/test_paged_xls_form_list_dto.py | 2 +- test/test_problem_details.py | 2 +- test/test_properties.py | 2 +- test/test_rpme_api.py | 2 +- test/test_rpme_assessment.py | 2 +- test/test_rpme_assessment_paged_result.py | 2 +- test/test_rpme_output_values.py | 2 +- test/test_rpme_variable.py | 2 +- test/test_rpme_variable_paged_result.py | 2 +- test/test_survey_list_dto.py | 2 +- test/test_surveys_api.py | 2 +- test/test_usd_indirect_quotation.py | 2 +- ...est_usd_indirect_quotation_paged_result.py | 2 +- test/test_view_extended_aggregated_price.py | 2 +- ..._extended_aggregated_price_paged_result.py | 2 +- test/test_view_extended_alps_value.py | 2 +- ...t_view_extended_alps_value_paged_result.py | 2 +- test/test_weekly_aggregated_price.py | 2 +- ...test_xls_form_definition_new_schema_dto.py | 2 +- test/test_xls_form_dto.py | 2 +- test/test_xls_form_fields_dto.py | 2 +- test/test_xls_form_list_choice_dto.py | 2 +- test/test_xls_form_list_choices_dto.py | 2 +- test/test_xls_forms_api.py | 2 +- 158 files changed, 8071 insertions(+), 305 deletions(-) create mode 100644 generate/swagger_v5.1.0.json 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/README.md b/README.md index cdff38a..d34cc04 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: 5.0.0 -- Package version: 5.0.0 -- Generator version: 7.5.0 +- API version: 5.1.0 +- Package version: 1.0.0 +- Generator version: 7.8.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen ## Requirements. @@ -53,21 +53,21 @@ Please follow the [installation procedure](#installation--usage) and then run th import data_bridges_client from data_bridges_client.rest import ApiException -from data_bridges_client.token import WfpApiToken from pprint import pprint -# Configure OAuth2 access token for authorization: default -KEY = '' -SECRET = '' -SCOPES = ['', ''] -token = WfpApiToken(api_key=KEY, api_secret=SECRET) - -# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/1.4.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) -configuration.access_token = token.refresh(scopes=SCOPES) + +# 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: @@ -92,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/5.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.1.0* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- @@ -105,13 +105,19 @@ 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. +*IncubationApi* | [**m_fi_surveys_processed_data_with_keyset_pagination_get**](docs/IncubationApi.md#m_fi_surveys_processed_data_with_keyset_pagination_get) | **GET** /MFI/Surveys/ProcessedDataWithKeysetPagination | Please use this endpoint only for large data retrieval - Response will include only JSON format - 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 *IncubationApi* | [**xls_forms_definition_get**](docs/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. *MarketPricesApi* | [**market_prices_alps_get**](docs/MarketPricesApi.md#market_prices_alps_get) | **GET** /MarketPrices/Alps | Returns time series values of ALPS and PEWI. *MarketPricesApi* | [**market_prices_price_daily_get**](docs/MarketPricesApi.md#market_prices_price_daily_get) | **GET** /MarketPrices/PriceDaily | Returns a daily time series of commodity market prices. @@ -148,6 +154,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) @@ -218,9 +227,12 @@ 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_mfi-surveys-processeddatakeysetpagination_get**: vamdatabridges_mfi-surveys-processeddatakeysetpagination_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 @@ -228,12 +240,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 2337b93..0a5f7d8 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/api/commodities_api.py b/data_bridges_client/api/commodities_api.py index 503a405..fabf171 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/api/commodity_units_api.py b/data_bridges_client/api/commodity_units_api.py index 7d315ae..72295b5 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/api/currency_api.py b/data_bridges_client/api/currency_api.py index f60a306..d7b9016 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/api/economic_data_api.py b/data_bridges_client/api/economic_data_api.py index 6e1d1e2..bbde3eb 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/api/food_security_api.py b/data_bridges_client/api/food_security_api.py index dddc430..1a22c42 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/api/gorp_api.py b/data_bridges_client/api/gorp_api.py index d2b498e..3aa43da 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/api/incubation_api.py b/data_bridges_client/api/incubation_api.py index fab1f95..6d30c70 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -22,6 +22,7 @@ from typing import List, Optional from typing_extensions import Annotated from data_bridges_client.models.household_survey_list_dto_paged_result import HouseholdSurveyListDTOPagedResult +from data_bridges_client.models.paged_processed_data_dto import PagedProcessedDataDTO from data_bridges_client.models.paged_survey_responses_dto import PagedSurveyResponsesDTO from data_bridges_client.models.xls_form_definition_new_schema_dto import XlsFormDefinitionNewSchemaDTO @@ -2289,6 +2290,426 @@ def _household_surveys_get_serialize( + @validate_call + def m_fi_surveys_processed_data_with_keyset_pagination_get( + self, + survey_id: Annotated[Optional[StrictInt], Field(description="The ID of the survey")] = None, + scroll_id: Annotated[Optional[StrictInt], Field(description="The pointer to the next paged results")] = None, + page_size: Optional[StrictInt] = 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, + adm0_codes: Annotated[Optional[StrictStr], Field(description="Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion")] = None, + market_id: Annotated[Optional[StrictInt], Field(description="The ID of the market")] = None, + survey_type: Annotated[Optional[StrictStr], Field(description="The survey type")] = None, + 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, + ) -> PagedProcessedDataDTO: + """Please use this endpoint only for large data retrieval - Response will include only JSON format - 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-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_mfi-surveys-processeddatakeysetpagination_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 + :param scroll_id: The pointer to the next paged results + :type scroll_id: int + :param page_size: + :type page_size: int + :param start_date: 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) + :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 adm0_codes: Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion + :type adm0_codes: str + :param market_id: The ID of the market + :type market_id: int + :param survey_type: The survey type + :type survey_type: str + :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._m_fi_surveys_processed_data_with_keyset_pagination_get_serialize( + survey_id=survey_id, + scroll_id=scroll_id, + page_size=page_size, + start_date=start_date, + end_date=end_date, + adm0_codes=adm0_codes, + market_id=market_id, + survey_type=survey_type, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PagedProcessedDataDTO", + '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 m_fi_surveys_processed_data_with_keyset_pagination_get_with_http_info( + self, + survey_id: Annotated[Optional[StrictInt], Field(description="The ID of the survey")] = None, + scroll_id: Annotated[Optional[StrictInt], Field(description="The pointer to the next paged results")] = None, + page_size: Optional[StrictInt] = 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, + adm0_codes: Annotated[Optional[StrictStr], Field(description="Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion")] = None, + market_id: Annotated[Optional[StrictInt], Field(description="The ID of the market")] = None, + survey_type: Annotated[Optional[StrictStr], Field(description="The survey type")] = None, + 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[PagedProcessedDataDTO]: + """Please use this endpoint only for large data retrieval - Response will include only JSON format - 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-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_mfi-surveys-processeddatakeysetpagination_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 + :param scroll_id: The pointer to the next paged results + :type scroll_id: int + :param page_size: + :type page_size: int + :param start_date: 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) + :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 adm0_codes: Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion + :type adm0_codes: str + :param market_id: The ID of the market + :type market_id: int + :param survey_type: The survey type + :type survey_type: str + :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._m_fi_surveys_processed_data_with_keyset_pagination_get_serialize( + survey_id=survey_id, + scroll_id=scroll_id, + page_size=page_size, + start_date=start_date, + end_date=end_date, + adm0_codes=adm0_codes, + market_id=market_id, + survey_type=survey_type, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PagedProcessedDataDTO", + '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 m_fi_surveys_processed_data_with_keyset_pagination_get_without_preload_content( + self, + survey_id: Annotated[Optional[StrictInt], Field(description="The ID of the survey")] = None, + scroll_id: Annotated[Optional[StrictInt], Field(description="The pointer to the next paged results")] = None, + page_size: Optional[StrictInt] = 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, + adm0_codes: Annotated[Optional[StrictStr], Field(description="Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion")] = None, + market_id: Annotated[Optional[StrictInt], Field(description="The ID of the market")] = None, + survey_type: Annotated[Optional[StrictStr], Field(description="The survey type")] = None, + 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: + """Please use this endpoint only for large data retrieval - Response will include only JSON format - 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-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_mfi-surveys-processeddatakeysetpagination_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 + :param scroll_id: The pointer to the next paged results + :type scroll_id: int + :param page_size: + :type page_size: int + :param start_date: 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) + :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 adm0_codes: Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion + :type adm0_codes: str + :param market_id: The ID of the market + :type market_id: int + :param survey_type: The survey type + :type survey_type: str + :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._m_fi_surveys_processed_data_with_keyset_pagination_get_serialize( + survey_id=survey_id, + scroll_id=scroll_id, + page_size=page_size, + start_date=start_date, + end_date=end_date, + adm0_codes=adm0_codes, + market_id=market_id, + survey_type=survey_type, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PagedProcessedDataDTO", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _m_fi_surveys_processed_data_with_keyset_pagination_get_serialize( + self, + survey_id, + scroll_id, + page_size, + start_date, + end_date, + adm0_codes, + market_id, + survey_type, + 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 survey_id is not None: + + _query_params.append(('surveyID', survey_id)) + + if scroll_id is not None: + + _query_params.append(('scrollId', scroll_id)) + + if page_size is not None: + + _query_params.append(('pageSize', page_size)) + + if start_date is not None: + if isinstance(start_date, datetime): + _query_params.append( + ( + 'startDate', + start_date.strftime( + self.api_client.configuration.datetime_format + ) + ) + ) + else: + _query_params.append(('startDate', start_date)) + + if end_date is not None: + if isinstance(end_date, datetime): + _query_params.append( + ( + 'endDate', + end_date.strftime( + self.api_client.configuration.datetime_format + ) + ) + ) + else: + _query_params.append(('endDate', end_date)) + + if adm0_codes is not None: + + _query_params.append(('adm0Codes', adm0_codes)) + + if market_id is not None: + + _query_params.append(('marketID', market_id)) + + if survey_type is not None: + + _query_params.append(('surveyType', survey_type)) + + 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='/MFI/Surveys/ProcessedDataWithKeysetPagination', + 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 xls_forms_definition_get( self, diff --git a/data_bridges_client/api/market_prices_api.py b/data_bridges_client/api/market_prices_api.py index 63110a2..7e81281 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/api/markets_api.py b/data_bridges_client/api/markets_api.py index 2bfd53d..8c05c6d 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/api/rpme_api.py b/data_bridges_client/api/rpme_api.py index db3134e..51b3258 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/api/surveys_api.py b/data_bridges_client/api/surveys_api.py index f9c4371..2b92e49 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/api/xls_forms_api.py b/data_bridges_client/api/xls_forms_api.py index 23ccacf..403222d 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/api_client.py b/data_bridges_client/api_client.py index bca2b8a..87e943d 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/configuration.py b/data_bridges_client/configuration.py index 43265ca..8c62f9b 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -79,7 +79,7 @@ def __init__(self, host=None, ) -> None: """Constructor """ - self._base_path = "https://api.wfp.org/vam-data-bridges/5.0.0" if host is None else host + self._base_path = "https://api.wfp.org/vam-data-bridges/5.1.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 @@ -392,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: 5.0.0\n"\ + "Version of the API: 5.1.0\n"\ "SDK Package Version: 1.0.0".\ format(env=sys.platform, pyversion=sys.version) @@ -403,7 +403,7 @@ def get_host_settings(self): """ return [ { - 'url': "https://api.wfp.org/vam-data-bridges/5.0.0", + 'url': "https://api.wfp.org/vam-data-bridges/5.1.0", 'description': "No description provided", } ] diff --git a/data_bridges_client/exceptions.py b/data_bridges_client/exceptions.py index 17c4acc..e5ce7e1 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 0ece5de..afcec87 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/bad_request_dto.py b/data_bridges_client/models/bad_request_dto.py index e6cf622..29b644f 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 d8315c5..4f2378e 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/commodity_price_dto.py b/data_bridges_client/models/commodity_price_dto.py index 02cf949..ab2e913 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 466c8ab..f2f2cf9 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 e5cc5ea..cb98b40 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 f1333d6..8789e80 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 cd8ade8..29c31db 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 36a0a15..cac9aa7 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 09fc404..d75f4e2 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/feature.py b/data_bridges_client/models/feature.py index 5eec78f..9dbf00c 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 4fbb23e..5a2b9c0 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 index d8e7253..31a01ce 100644 --- a/data_bridges_client/models/gorp_country_api_dto.py +++ b/data_bridges_client/models/gorp_country_api_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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/gorp_global_api_dto.py b/data_bridges_client/models/gorp_global_api_dto.py index 7bc87f5..129c19e 100644 --- a/data_bridges_client/models/gorp_global_api_dto.py +++ b/data_bridges_client/models/gorp_global_api_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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/gorp_regional_api_dto.py b/data_bridges_client/models/gorp_regional_api_dto.py index cbdee84..cee9dd5 100644 --- a/data_bridges_client/models/gorp_regional_api_dto.py +++ b/data_bridges_client/models/gorp_regional_api_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: 5.0.0 + The version of the OpenAPI document: 5.1.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.py b/data_bridges_client/models/gorp_value_with_changes.py index f8a7240..2bf15f7 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 795f44d..43d8497 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/household_survey_list_dto.py b/data_bridges_client/models/household_survey_list_dto.py index 216009f..891a614 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) 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 414ff9e..deac34a 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/ipc_value.py b/data_bridges_client/models/ipc_value.py index f975bc5..2450450 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 306a145..6bb94e5 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/key_name_dto.py b/data_bridges_client/models/key_name_dto.py index 1e74d98..4e67852 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 57b4619..c88a299 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 356dc2f..b569334 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/mfi_processed_data_dto.py b/data_bridges_client/models/mfi_processed_data_dto.py index 3a081e0..5f47c8f 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 c62eb4b..e12ba19 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 505285a..861e692 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) 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 1301657..b6ea5f2 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) 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 08caa94..3a70d55 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/paged_currency_list_dto.py b/data_bridges_client/models/paged_currency_list_dto.py index b4d6130..b5f5042 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/paged_economic_data_dto.py b/data_bridges_client/models/paged_economic_data_dto.py index e34c11f..8963bbb 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/paged_market_list_dto.py b/data_bridges_client/models/paged_market_list_dto.py index 0cb7cee..bb090a9 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/paged_processed_data_dto.py b/data_bridges_client/models/paged_processed_data_dto.py index e12f3f9..6b8a128 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -30,9 +30,10 @@ class PagedProcessedDataDTO(BaseModel): """ # noqa: E501 total_items: Optional[StrictInt] = Field(default=None, description="The total number of items", alias="totalItems") page: Optional[StrictInt] = Field(default=None, description="The current page") + scroll_id: Optional[StrictInt] = Field(default=None, alias="scrollId") items: Optional[List[MFIProcessedDataDTO]] = Field(default=None, description="The list of processed data") additional_properties: Dict[str, Any] = {} - __properties: ClassVar[List[str]] = ["totalItems", "page", "items"] + __properties: ClassVar[List[str]] = ["totalItems", "page", "scrollId", "items"] model_config = ConfigDict( populate_by_name=True, @@ -106,6 +107,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "totalItems": obj.get("totalItems"), "page": obj.get("page"), + "scrollId": obj.get("scrollId"), "items": [MFIProcessedDataDTO.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None }) # store additional fields in additional_properties diff --git a/data_bridges_client/models/paged_survey_list_dto.py b/data_bridges_client/models/paged_survey_list_dto.py index 5408f24..96d955b 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/paged_survey_responses_dto.py b/data_bridges_client/models/paged_survey_responses_dto.py index ba8eef9..5b4b102 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 1df06b0..68d50df 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/problem_details.py b/data_bridges_client/models/problem_details.py index af5dad1..858d7e1 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 2ec2f57..7c9f305 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 a091541..cbf26bd 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/rpme_assessment_paged_result.py b/data_bridges_client/models/rpme_assessment_paged_result.py index 1fc7101..4b3d75e 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/rpme_output_values.py b/data_bridges_client/models/rpme_output_values.py index ed367f5..42193a0 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 7948584..6dcccec 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 3430706..21740cf 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/survey_list_dto.py b/data_bridges_client/models/survey_list_dto.py index 5980119..1ee44ba 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 35dc985..392ea34 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 5509987..2a7c5e0 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: 5.0.0 + The version of the OpenAPI document: 5.1.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.py b/data_bridges_client/models/view_extended_aggregated_price.py index 865be0b..35b45b3 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 2725e20..49ab222 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: 5.0.0 + The version of the OpenAPI document: 5.1.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.py b/data_bridges_client/models/view_extended_alps_value.py index 6d33b90..99b23fd 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 b3b1b84..4ec84ec 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/weekly_aggregated_price.py b/data_bridges_client/models/weekly_aggregated_price.py index f0b832b..bf8ecd9 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 97ff545..8573cb7 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/xls_form_dto.py b/data_bridges_client/models/xls_form_dto.py index 45dde27..f9f63c3 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 79d4f04..ed370c7 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 1848b00..e2ebb8d 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 8d164f0..814224e 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/rest.py b/data_bridges_client/rest.py index 4545923..64973de 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 d73b893..bd766d3 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/5.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.1.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -89,7 +89,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -175,7 +175,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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/CommodityUnitsApi.md b/docs/CommodityUnitsApi.md index a8af464..e86be48 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/5.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.1.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -91,7 +91,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -177,7 +177,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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/CurrencyApi.md b/docs/CurrencyApi.md index 29b344f..fc06ddb 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/5.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.1.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -89,7 +89,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -173,7 +173,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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/EconomicDataApi.md b/docs/EconomicDataApi.md index 72a365b..d263486 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/5.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.1.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -87,7 +87,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -175,7 +175,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **400** | Bad Request | - | **404** | Not Found | - | diff --git a/docs/FoodSecurityApi.md b/docs/FoodSecurityApi.md index 424741b..ade71eb 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/5.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.1.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -83,7 +83,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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/GorpApi.md b/docs/GorpApi.md index ae8cf66..b60846b 100644 --- a/docs/GorpApi.md +++ b/docs/GorpApi.md @@ -1,6 +1,6 @@ # data_bridges_client.GorpApi -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/5.1.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -28,10 +28,10 @@ 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 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -82,7 +82,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -104,10 +104,10 @@ 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 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -158,7 +158,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -180,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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -236,7 +236,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -258,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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -314,7 +314,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -336,10 +336,10 @@ 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 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -390,7 +390,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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/IncubationApi.md b/docs/IncubationApi.md index 11a7b09..94776ac 100644 --- a/docs/IncubationApi.md +++ b/docs/IncubationApi.md @@ -1,6 +1,6 @@ # data_bridges_client.IncubationApi -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/5.1.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -11,6 +11,7 @@ Method | HTTP request | Description [**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. +[**m_fi_surveys_processed_data_with_keyset_pagination_get**](IncubationApi.md#m_fi_surveys_processed_data_with_keyset_pagination_get) | **GET** /MFI/Surveys/ProcessedDataWithKeysetPagination | Please use this endpoint only for large data retrieval - Response will include only JSON format - 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 [**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. @@ -30,10 +31,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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -84,7 +85,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | [[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) @@ -104,10 +105,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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -158,7 +159,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | [[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) @@ -179,10 +180,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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -241,7 +242,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **400** | Bad Request | - | **403** | Forbidden | - | **404** | Not Found | - | @@ -265,10 +266,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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -329,7 +330,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **400** | Bad Request | - | **403** | Forbidden | - | **404** | Not Found | - | @@ -353,10 +354,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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -413,7 +414,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **400** | Bad Request | - | **404** | Not Found | - | @@ -436,10 +437,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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -496,7 +497,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **400** | Bad Request | - | **404** | Not Found | - | @@ -519,10 +520,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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -583,7 +584,99 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | +**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) + +# **m_fi_surveys_processed_data_with_keyset_pagination_get** +> PagedProcessedDataDTO m_fi_surveys_processed_data_with_keyset_pagination_get(survey_id=survey_id, scroll_id=scroll_id, page_size=page_size, start_date=start_date, end_date=end_date, adm0_codes=adm0_codes, market_id=market_id, survey_type=survey_type, env=env) + +Please use this endpoint only for large data retrieval - Response will include only JSON format - 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-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_mfi-surveys-processeddatakeysetpagination_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.paged_processed_data_dto import PagedProcessedDataDTO +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.1.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.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"] + +# 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) + survey_id = 56 # int | The ID of the survey (optional) + scroll_id = 0 # int | The pointer to the next paged results (optional) (default to 0) + page_size = 1000 # int | (optional) (default to 1000) + 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) + adm0_codes = 'adm0_codes_example' # str | Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion (optional) + market_id = 56 # int | The ID of the market (optional) + survey_type = 'survey_type_example' # str | The survey type (optional) + env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) + + try: + # Please use this endpoint only for large data retrieval - Response will include only JSON format - 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 + api_response = api_instance.m_fi_surveys_processed_data_with_keyset_pagination_get(survey_id=survey_id, scroll_id=scroll_id, page_size=page_size, start_date=start_date, end_date=end_date, adm0_codes=adm0_codes, market_id=market_id, survey_type=survey_type, env=env) + print("The response of IncubationApi->m_fi_surveys_processed_data_with_keyset_pagination_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IncubationApi->m_fi_surveys_processed_data_with_keyset_pagination_get: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **survey_id** | **int**| The ID of the survey | [optional] + **scroll_id** | **int**| The pointer to the next paged results | [optional] [default to 0] + **page_size** | **int**| | [optional] [default to 1000] + **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] + **adm0_codes** | **str**| Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion | [optional] + **market_id** | **int**| The ID of the market | [optional] + **survey_type** | **str**| The survey type | [optional] + **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] + +### Return type + +[**PagedProcessedDataDTO**](PagedProcessedDataDTO.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** | OK | - | **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) @@ -605,10 +698,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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -661,7 +754,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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/MarketPricesApi.md b/docs/MarketPricesApi.md index d8b14d0..275ca56 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/5.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.1.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -104,7 +104,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -202,7 +202,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -300,7 +300,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -398,7 +398,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -496,7 +496,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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/MarketsApi.md b/docs/MarketsApi.md index 540a80d..a521fcb 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/5.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.1.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -83,7 +83,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -165,7 +165,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | [[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,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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -243,7 +243,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | [[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) @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -324,7 +324,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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/PagedProcessedDataDTO.md b/docs/PagedProcessedDataDTO.md index 1a86eac..a43ee85 100644 --- a/docs/PagedProcessedDataDTO.md +++ b/docs/PagedProcessedDataDTO.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_items** | **int** | The total number of items | [optional] **page** | **int** | The current page | [optional] +**scroll_id** | **int** | | [optional] **items** | [**List[MFIProcessedDataDTO]**](MFIProcessedDataDTO.md) | The list of processed data | [optional] ## Example diff --git a/docs/RpmeApi.md b/docs/RpmeApi.md index 5951deb..985ada1 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/5.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.1.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -89,7 +89,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **400** | Bad Request | - | **404** | Not Found | - | @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -174,7 +174,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **400** | Bad Request | - | **404** | Not Found | - | @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -263,7 +263,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -347,7 +347,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -425,7 +425,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -509,7 +509,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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/SurveysApi.md b/docs/SurveysApi.md index 1a7784a..4b3f696 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/5.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.1.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -87,7 +87,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **400** | Bad Request | - | **404** | Not Found | - | @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -172,7 +172,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **400** | Bad Request | - | **404** | Not Found | - | @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -257,7 +257,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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) @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -351,7 +351,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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/XlsFormsApi.md b/docs/XlsFormsApi.md index 04ddefd..61cd566 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/5.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.1.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -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/5.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.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/5.1.0" ) # The client must configure the authentication and authorization parameters @@ -86,7 +86,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | OK | - | **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/generate/swagger_v5.1.0.json b/generate/swagger_v5.1.0.json new file mode 100644 index 0000000..d4a398d --- /dev/null +++ b/generate/swagger_v5.1.0.json @@ -0,0 +1,7229 @@ +{ + "openapi" : "3.0.0", + "info" : { + "title" : "VAM-Data-Bridges", + "description" : "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", + "contact" : { + "name" : "VAM-INFO", + "email" : "wfp.economicanalysis@wfp.org" + }, + "version" : "5.1.0" + }, + "servers" : [ { + "url" : "https://api.wfp.org/vam-data-bridges/5.1.0" + } ], + "security" : [ { + "default" : [ ] + } ], + "tags" : [ { + "name" : "Aims", + "description" : "The Asset Impact Monitoring from Space (AIMS) is a high-tech, data-driven, service that uses satellite \r\nimagery and landscape monitoring techniques to demonstrate and evaluate the impact of asset creation and livelihood programmes." + }, { + "name" : "Commodities", + "description" : "Returns the list of commodities and their categories." + }, { + "name" : "CommodityUnits", + "description" : "Returns the list of unit of measures and their conversion factors to standard quantities." + }, { + "name" : "Currency", + "description" : "Returns official and, where available, unofficial exchange rates." + }, { + "name" : "EconomicData", + "description" : "Returns the time series of values for different indicators. \r\nOriginal source is Trading Economics, licensed for redistribution only to the Vulnerability Analysis and Mapping - Economic and Market Analysis Unit." + }, { + "name" : "FoodSecurity", + "description" : "IPC data" + }, { + "name" : "Gorp", + "description" : "Number of acutely food insecure people in countries with WFP operational presence, in millions. \r\nSource is WFP’s Global Operational Response plan, numbers are updated with each publication (3 times a year). \r\nNumbers are updates to WFP’s original estimate of COVID-19’s impact on acute food security conducted in June 2020 \r\n(see [https://docs.wfp.org/api/documents/WFP-0000128212/download/](https://docs.wfp.org/api/documents/WFP-0000128212/download/)). In the updates, the original estimations from June 2020 are \r\nreplaced with the most recent assessment data and projections for the given year from Integrated Phase Classification (IPC), Cadre Harmonisé (CH), or \r\ncomparable analyses (peak values). As updates provide improved estimates for the given year, they are not intended for trend analysis." + }, { + "name" : "Household", + "description" : "Household Surveys" + }, { + "name" : "MarketPrices", + "description" : "Returns time series of commodity market prices at different frequencies." + }, { + "name" : "Markets", + "description" : "Returns the list of market locations with Administrative level codes matching with the VAM internal API." + }, { + "name" : "Rpme", + "description" : "Retail Performance Monitoring and Evaluation" + }, { + "name" : "Surveys", + "description" : "Market Functionality Index Surveys" + }, { + "name" : "XlsForms", + "description" : "Market Functionality Index XLS Forms" + } ], + "paths" : { + "/Aims/DownloadAllAnalysisRounds" : { + "get" : { + "tags" : [ "Incubation" ], + "summary" : "Each asset has a baseline and several rounds. Each round reflects the number of times the asset \r\nhas been analysed over time. The number of total rounds changes according to the workstream: \r\nAsset Detection (AD) assets can have a total of 5 rounds, while there is no limit to the monitoring of \r\nLandscape Impact Assessment (LIA) assets. Assets considered for Site Prioritization (SP) have one round only. \r\nPlease note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only).", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]()\n\n[![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadallanalysisrounds_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "adm0Code", + "in" : "query", + "description" : "The country adm0Code", + "required" : true, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK" + } + }, + "security" : [ { + "default" : [ "vamdatabridges_aims-downloadallanalysisrounds_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Aims/DownloadPolygonFiles" : { + "get" : { + "tags" : [ "Incubation" ], + "summary" : "Polygon files are available for Landscape Impact Assessment (LIA) assets only. \r\nThe file name corresponds to the “Geotrace” name. Please note that adm0code can be obtained \r\nfrom https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only).", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]()\n\n[![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadpolygonfiles_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "adm0Code", + "in" : "query", + "description" : "The country adm0Code", + "required" : true, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK" + } + }, + "security" : [ { + "default" : [ "vamdatabridges_aims-downloadpolygonfiles_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Commodities/List" : { + "get" : { + "tags" : [ "Commodities" ], + "summary" : "Provide the detailed list of the commodities available in DataBridges platform", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodities-list_get\"\n\nCOICOP 2018 codes are returned to hierarchically matching categories based on [UN-Statistical Division codes](https://unstats.un.org/unsd/classifications/Econ/). No mandatory parameter.\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "countryCode", + "in" : "query", + "description" : "The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "commodityName", + "in" : "query", + "description" : "The name, even partial and case insensitive, of a commodity", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "commodityID", + "in" : "query", + "description" : "The exact ID of a commodity", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityListDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityListDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityListDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_commodities-list_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Commodities/Categories/List" : { + "get" : { + "tags" : [ "Commodities" ], + "summary" : "Provides the list of categories.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodities-categories-list_get\"\n\nCategories are matched with high level WFP commodity classification at level 1. No mandatory parameter.\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "countryCode", + "in" : "query", + "description" : "The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "categoryName", + "in" : "query", + "description" : "The name, even partial and case insensitive, of a commodity category.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "categoryID", + "in" : "query", + "description" : "The exact ID of a Commodity, as found in /Commodities/List.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityListDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityListDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityListDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_commodities-categories-list_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/CommodityUnits/List" : { + "get" : { + "tags" : [ "CommodityUnits" ], + "summary" : "Provides the detailed list of the unit of measure available in DataBridges platform", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodityunits-list_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "countryCode", + "in" : "query", + "description" : "The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "commodityUnitName", + "in" : "query", + "description" : "The name, even partial and case insensitive, of a commodity unit", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "commodityUnitID", + "in" : "query", + "description" : "The exact ID of a commodity unit", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityListDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityListDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityListDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_commodityunits-list_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/CommodityUnits/Conversion/List" : { + "get" : { + "tags" : [ "CommodityUnits" ], + "summary" : "Provides conversion factors to Kilogram or Litres for each convertible unit of measure.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_commodityunits-conversion-list_get\"\n\nSome 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.\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "countryCode", + "in" : "query", + "description" : "The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "commodityID", + "in" : "query", + "description" : "The exact ID of a Commodity, as found in /Commodities/List", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "fromUnitID", + "in" : "query", + "description" : "The exact ID of the original unit of measure of the price of a commodity, as found in /CommodityUnits/List", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "toUnitID", + "in" : "query", + "description" : "The exact ID of the converted unit of measure of the price of a commodity, as found in /CommodityUnits/List", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "page", + "in" : "query", + "description" : "Page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityListDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityListDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityListDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_commodityunits-conversion-list_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Currency/List" : { + "get" : { + "tags" : [ "Currency" ], + "summary" : "Returns the list of currencies available in the internal VAM database, with Currency 3-letter code, matching with ISO 4217.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_currency-list_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "countryCode", + "in" : "query", + "description" : "The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "currencyName", + "in" : "query", + "description" : "Currency 3-letter code, matching with ISO 4217.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "currencyID", + "in" : "query", + "description" : "Unique code to identify the currency in internal VAM currencies.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "page", + "in" : "query", + "description" : "Page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCurrencyListDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCurrencyListDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCurrencyListDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_currency-list_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Currency/UsdIndirectQuotation" : { + "get" : { + "tags" : [ "Currency" ], + "summary" : "Returns the value of the Exchange rates from Trading Economics, for official rates, and DataViz for unofficial rates.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_currency-usdindirectquotation_get\"\n\nReturns 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.\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "countryIso3", + "in" : "query", + "description" : "The code to identify the country. Must be a ISO-3166 Alpha 3 code.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "currencyName", + "in" : "query", + "description" : "the ISO3 code for the currency, based on ISO4217", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "page", + "in" : "query", + "description" : "Page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/UsdIndirectQuotationPagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UsdIndirectQuotationPagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/UsdIndirectQuotationPagedResult" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_currency-usdindirectquotation_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/EconomicData/{indicatorName}" : { + "get" : { + "tags" : [ "EconomicData" ], + "summary" : "Returns the time series of values for different indicators.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_economicdata_get\"\n\nIndicator name as retrieved from /EconomicData/IndicatorList is mandatory.\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "indicatorName", + "in" : "path", + "description" : "Name of the indicator as found in /EconomicData/IndicatorList.", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "page", + "in" : "query", + "description" : "Page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "iso3", + "in" : "query", + "description" : "The code to identify the country. Must be a ISO-3166 Alpha 3 code.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "startDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "endDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedEconomicDataDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedEconomicDataDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedEconomicDataDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_economicdata_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/EconomicData/IndicatorList" : { + "get" : { + "tags" : [ "EconomicData" ], + "summary" : "Returns the lists of indicators.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_economicdata-indicatorlist_get\"\n\nReturns the lists of indicators for which Vulnerability Analysis and Mapping - Economic and Market Analysis Unit has redistribution licensing from Trading Economics. No mandatory parameter.\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "page", + "in" : "query", + "description" : "Page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "indicatorName", + "in" : "query", + "description" : "Unique indicator name.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "iso3", + "in" : "query", + "description" : "The code to identify the country. Must be a ISO-3166 Alpha 3 code.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/EconomicIndicatorPropertyPagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EconomicIndicatorPropertyPagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/EconomicIndicatorPropertyPagedResult" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_economicdata-indicatorlist_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/FoodSecurity/List" : { + "get" : { + "tags" : [ "FoodSecurity" ], + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_foodsecurity-list_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "iso3", + "in" : "query", + "description" : "The country ISO3 code", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "year", + "in" : "query", + "description" : "", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "page", + "in" : "query", + "description" : "", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/IpcValuePagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/IpcValuePagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/IpcValuePagedResult" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_foodsecurity-list_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Gorp/List" : { + "get" : { + "tags" : [ "Gorp" ], + "summary" : "Return the full dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-list_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "page", + "in" : "query", + "description" : "", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/GorpValueWithChangesPagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GorpValueWithChangesPagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/GorpValueWithChangesPagedResult" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_gorp-list_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Gorp/Latest" : { + "get" : { + "tags" : [ "Gorp" ], + "summary" : "Return the latest dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-latest_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "page", + "in" : "query", + "description" : "", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/GorpValueWithChangesPagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GorpValueWithChangesPagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/GorpValueWithChangesPagedResult" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_gorp-latest_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Gorp/CountryLatest" : { + "get" : { + "tags" : [ "Gorp" ], + "summary" : "Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-countrylatest_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GorpCountryApiDto" + } + } + }, + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GorpCountryApiDto" + } + } + }, + "text/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GorpCountryApiDto" + } + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_gorp-countrylatest_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Gorp/RegionalLatest" : { + "get" : { + "tags" : [ "Gorp" ], + "summary" : "Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-regionallatest_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GorpRegionalApiDto" + } + } + }, + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GorpRegionalApiDto" + } + } + }, + "text/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GorpRegionalApiDto" + } + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_gorp-regionallatest_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Gorp/GlobalLatest" : { + "get" : { + "tags" : [ "Gorp" ], + "summary" : "Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-globallatest_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/GorpGlobalApiDto" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GorpGlobalApiDto" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/GorpGlobalApiDto" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_gorp-globallatest_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Household/Surveys" : { + "get" : { + "tags" : [ "Incubation" ], + "summary" : "Retrieve 1) Survey IDs, 2) their corresponding XLS Form IDs, and 3) Base XLS Form of all household surveys conducted in a country. \r\nA date of reference, SurveyDate, for the data collection is set by the officer responsible for the upload for each survey.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-surveys_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "adm0Code", + "in" : "query", + "description" : "code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "startDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "endDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "surveyId", + "in" : "query", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/HouseholdSurveyListDTOPagedResult" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_household-surveys_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Household/FullData" : { + "get" : { + "tags" : [ "Incubation" ], + "summary" : "Get a full dataset that includes all the fields included in the survey in addition to the core household fields by Survey ID.\r\nTo access this data, please contact Wael ATTIA for authorization. \r\nThis endpoint will send you only data you have access to, based on permissions assigned to your application profile. \r\nThe \"apiKey\" can be found in the profile section of the DataBridges application.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]()\n\n[![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-fulldata_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "apiKey", + "in" : "query", + "required" : true, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "surveyID", + "in" : "query", + "description" : "unique identifier for the collected data, as retrieved from /Surveys API.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "pageSize", + "in" : "query", + "description" : "page size for paged results, default value is 20.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20 + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + }, + "403" : { + "description" : "Forbidden", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_household-fulldata_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Household/DraftInternalBaseData" : { + "get" : { + "tags" : [ "Incubation" ], + "summary" : "Get data that includes the core household fields only by Survey ID.\r\nTo access this data, please contact Wael ATTIA for authorization. \r\nThis endpoint will send you only data you have access to, based on permissions assigned to your application profile. \r\nThe \"apiKey\" can be found in the profile section of the DataBridges application.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]()\n\n[![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-draftinternalbasedata_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "apiKey", + "in" : "query", + "required" : true, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "surveyID", + "in" : "query", + "description" : "unique identifier for the collected data, as retrieved from /Surveys API.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "pageSize", + "in" : "query", + "description" : "page size for paged results, default value is 20.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20 + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + }, + "403" : { + "description" : "Forbidden", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_household-draftinternalbasedata_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Household/OfficialUseBaseData" : { + "get" : { + "tags" : [ "Incubation" ], + "summary" : "Get data that includes the core household fields only by Survey ID", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]()\n\n[![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-officialusebasedata_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "surveyID", + "in" : "query", + "description" : "unique identifier for the collected data, as retrieved from /Surveys API.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "pageSize", + "in" : "query", + "description" : "page size for paged results, default value is 20.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20 + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_household-officialusebasedata_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Household/PublicBaseData" : { + "get" : { + "tags" : [ "Incubation" ], + "summary" : "Get data that includes the core household fields only by Survey ID", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]()\n\n[![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_household-publicbasedata_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "surveyID", + "in" : "query", + "description" : "unique identifier for the collected data, as retrieved from /Surveys API.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "pageSize", + "in" : "query", + "description" : "page size for paged results, default value is 20.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20 + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_household-publicbasedata_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/MarketPrices/PriceMonthly" : { + "get" : { + "tags" : [ "MarketPrices" ], + "summary" : "Returns a monthly time series of commodity market prices.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-pricemonthly_get\"\n\nThis 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.\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "countryCode", + "in" : "query", + "description" : "The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "marketID", + "in" : "query", + "description" : "Unique ID of a Market, as found in /Markets/GeoJSONList", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "commodityID", + "in" : "query", + "description" : "The exact ID of a Commodity, as found in /Commodities/List", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "priceTypeName", + "in" : "query", + "description" : "Price type: [retail|wholesale|farmgate]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "currencyID", + "in" : "query", + "description" : "The exact ID of a currency, as found in /Currency/List", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "priceFlag", + "in" : "query", + "description" : "Type of price data: [actual|aggregate|estimated|forecasted]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "startDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "endDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "latestValueOnly", + "in" : "query", + "description" : "[TRUE|FALSE]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "page", + "in" : "query", + "description" : "Page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/ViewExtendedAggregatedPricePagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ViewExtendedAggregatedPricePagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/ViewExtendedAggregatedPricePagedResult" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_marketprices-pricemonthly_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/MarketPrices/PriceWeekly" : { + "get" : { + "tags" : [ "MarketPrices" ], + "summary" : "Returns a weekly time series of commodity market prices.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-priceweekly_get\"\n\nWeeks 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.\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "countryCode", + "in" : "query", + "description" : "The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "marketID", + "in" : "query", + "description" : "Unique ID of a Market, as found in /Markets/GeoJSONList", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "commodityID", + "in" : "query", + "description" : "The exact ID of a Commodity, as found in /Commodities/List", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "priceTypeName", + "in" : "query", + "description" : "Price type: [retail|wholesale|farmgate]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "currencyID", + "in" : "query", + "description" : "The exact ID of a currency, as found in /Currency/List", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "priceFlag", + "in" : "query", + "description" : "Type of price data: [actual|aggregate|estimated|forecasted]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "startDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "endDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "latestValueOnly", + "in" : "query", + "description" : "[TRUE|FALSE]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "page", + "in" : "query", + "description" : "Page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityWeeklyAggregatedPriceListDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityWeeklyAggregatedPriceListDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityWeeklyAggregatedPriceListDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_marketprices-priceweekly_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/MarketPrices/PriceDaily" : { + "get" : { + "tags" : [ "MarketPrices" ], + "summary" : "Returns a daily time series of commodity market prices.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-pricedaily_get\"\n\nThis is the highest frequency available. Data is flagged according to its pre-processing characteristics.\r\nActual 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.\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "countryCode", + "in" : "query", + "description" : "The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "marketID", + "in" : "query", + "description" : "Unique ID of a Market, as found in /Markets/GeoJSONList", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "commodityID", + "in" : "query", + "description" : "The exact ID of a Commodity, as found in /Commodities/List", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "priceTypeName", + "in" : "query", + "description" : "Price type: [retail|wholesale|farmgate]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "currencyID", + "in" : "query", + "description" : "The exact ID of a currency, as found in /Currency/List", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "priceFlag", + "in" : "query", + "description" : "Type of price data: [actual|aggregate|estimated|forecasted]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "startDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "endDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "latestValueOnly", + "in" : "query", + "description" : "[TRUE|FALSE]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "page", + "in" : "query", + "description" : "Page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/ViewExtendedAggregatedPricePagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ViewExtendedAggregatedPricePagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/ViewExtendedAggregatedPricePagedResult" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_marketprices-pricedaily_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/MarketPrices/PriceRaw" : { + "get" : { + "tags" : [ "MarketPrices" ], + "summary" : "Returns original commodity market prices", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-priceraw_get\"\n\nRestricted 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.\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "countryCode", + "in" : "query", + "description" : "The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "marketID", + "in" : "query", + "description" : "Unique ID of a Market, as found in /Markets/GeoJSONList", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "commodityID", + "in" : "query", + "description" : "The exact ID of a Commodity, as found in /Commodities/List", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "priceTypeName", + "in" : "query", + "description" : "Price type: [retail|wholesale|farmgate]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "currencyID", + "in" : "query", + "description" : "The exact ID of a currency, as found in /Currency/List", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "priceFlag", + "in" : "query", + "description" : "Type of price data: [actual|aggregate|estimated|forecasted]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "startDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "endDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "latestValueOnly", + "in" : "query", + "description" : "[TRUE|FALSE]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "page", + "in" : "query", + "description" : "Page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityPriceListDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityPriceListDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedCommodityPriceListDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_marketprices-priceraw_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/MarketPrices/Alps" : { + "get" : { + "tags" : [ "MarketPrices" ], + "summary" : "Returns time series values of ALPS and PEWI.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-alps_get\"\n\nReturns 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.\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "countryCode", + "in" : "query", + "description" : "The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "marketID", + "in" : "query", + "description" : "Unique ID of a Market, as found in /Markets/GeoJSONList", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "commodityID", + "in" : "query", + "description" : "The exact ID of a Commodity, as found in /Commodities/List", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "priceTypeName", + "in" : "query", + "description" : "Price type: [retail|wholesale|farmgate]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "currencyID", + "in" : "query", + "description" : "The exact ID of a currency, as found in /Currency/List", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "priceFlag", + "in" : "query", + "description" : "Type of price data: [actual|aggregate|estimated|forecasted]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "startDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "endDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "latestValueOnly", + "in" : "query", + "description" : "[TRUE|FALSE]", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "page", + "in" : "query", + "description" : "Page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/ViewExtendedAlpsValuePagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ViewExtendedAlpsValuePagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/ViewExtendedAlpsValuePagedResult" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_marketprices-alps_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Markets/GeoJSONList" : { + "get" : { + "tags" : [ "Markets" ], + "summary" : "Provide a list of geo referenced markets in a specific country", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_markets-geojsonlist_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "adm0code", + "in" : "query", + "description" : "The admin code of the country", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/geo+json" : { + "schema" : { + "$ref" : "#/components/schemas/MarketGeoJsonRoot" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "application/geo+json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_markets-geojsonlist_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Markets/NearbyMarkets" : { + "get" : { + "tags" : [ "Markets" ], + "summary" : "Find markets near a given location by longitude and latitude within a 15Km distance", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_markets-nearbymarkets_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "adm0code", + "in" : "query", + "description" : "code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "lat", + "in" : "query", + "description" : "latitude of the point that will be used to search for existing nearby markets. Geo-reference standard used for this coordinate is decimal", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "number", + "format" : "double" + } + }, { + "name" : "lng", + "in" : "query", + "description" : "longitude of the point that will be used to search for existing nearby markets. Geo-reference standard used for this coordinate is decimal", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "number", + "format" : "double" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NearbyMarketsDTO" + } + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_markets-nearbymarkets_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Markets/MarketsAsCSV" : { + "get" : { + "tags" : [ "Markets" ], + "summary" : "Get a complete list of markets in a country", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_markets-marketsascsv_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "adm0code", + "in" : "query", + "description" : "The admin code of the country", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "localNames", + "in" : "query", + "description" : "If true the name of markets and regions will be localized if available", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "type" : "string", + "format" : "binary" + } + }, + "application/json" : { + "schema" : { + "type" : "string", + "format" : "binary" + } + }, + "text/json" : { + "schema" : { + "type" : "string", + "format" : "binary" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_markets-marketsascsv_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Markets/List" : { + "get" : { + "tags" : [ "Markets" ], + "summary" : "Get a complete list of markets in a country", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_markets-list_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "countryCode", + "in" : "query", + "description" : "The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedMarketListDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedMarketListDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedMarketListDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_markets-list_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Rpme/Variables" : { + "get" : { + "tags" : [ "Rpme" ], + "summary" : "List of variables", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_rpme-variables_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "page", + "in" : "query", + "description" : "", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/RpmeVariablePagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RpmeVariablePagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/RpmeVariablePagedResult" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_rpme-variables_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Rpme/OutputValues" : { + "get" : { + "tags" : [ "Rpme" ], + "summary" : "Processed values for each variable used in the assessments", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_rpme-outputvalues_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "adm0Code", + "in" : "query", + "description" : "Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "surveyId", + "in" : "query", + "description" : "The ID of the survey", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "shopId", + "in" : "query", + "description" : "The ID of the shop", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "marketId", + "in" : "query", + "description" : "The ID of the market", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "adm0CodeDots", + "in" : "query", + "description" : "", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/RpmeAssessmentPagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RpmeAssessmentPagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/RpmeAssessmentPagedResult" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_rpme-outputvalues_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Rpme/Surveys" : { + "get" : { + "tags" : [ "Rpme" ], + "summary" : "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.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_rpme-surveys_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "adm0Code", + "in" : "query", + "description" : "code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "startDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "endDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyListDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyListDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyListDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_rpme-surveys_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Rpme/XLSForms" : { + "get" : { + "tags" : [ "Rpme" ], + "summary" : "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.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_rpme-xlsforms_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "adm0Code", + "in" : "query", + "description" : "code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "startDate", + "in" : "query", + "description" : "starting date for the range in which data using this XLSForm was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "endDate", + "in" : "query", + "description" : "ending date for the range in which data using this XLSForm was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedXlsFormListDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_rpme-xlsforms_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Rpme/FullData" : { + "get" : { + "tags" : [ "Rpme" ], + "summary" : "Get a full dataset that includes all the fields included in the survey in addition to the core RPME fields by Survey ID.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_rpme-fulldata_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "surveyID", + "in" : "query", + "description" : "unique identifier for the collected data, as retrieved from /Surveys API.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "pageSize", + "in" : "query", + "description" : "page size for paged results, default value is 20.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20 + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_rpme-fulldata_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Rpme/BaseData" : { + "get" : { + "tags" : [ "Rpme" ], + "summary" : "Get data that includes the core RPME fields only by Survey ID", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_rpme-basedata_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "surveyID", + "in" : "query", + "description" : "unique identifier for the collected data, as retrieved from /Surveys API.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "pageSize", + "in" : "query", + "description" : "page size for paged results, default value is 20.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20 + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_rpme-basedata_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/MFI/Surveys" : { + "get" : { + "tags" : [ "Surveys" ], + "summary" : "Retrieve 1) Survey IDs, 2) their corresponding XLS Form IDs, and 3) Base XLS Form of all MFI surveys conducted in a country. \r\nA date of reference, SurveyDate, for the data collection is set by the officer responsible for the upload for each survey.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_mfi-surveys_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "adm0Code", + "in" : "query", + "description" : "code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "startDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "endDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyListDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_mfi-surveys_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/MFI/Surveys/ProcessedData" : { + "get" : { + "tags" : [ "Surveys" ], + "summary" : "Get a MFI processed data in long format; levels indicate the data aggregation level 1) Normalized Score, 2) Trader Aggregate Score, \r\n3) Market Aggregate Score, 4) Trader Median, 5) Trader Mean, 6) Market Mean; each line corresponds to one of the nine dimensions of scores \r\nplus the final MFI aggregate score; 1) Assortment, 2) Availability, 3) Price, 4) Resilience, 5) Competition, 6) Infrastructure, 7) Service, \r\n8) Quality, 9) Access and Protection, and 10) MFI final score; the variable label describes each variable and its value range", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_mfi-surveys-processeddata_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "surveyID", + "in" : "query", + "description" : "The ID of the survey", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "pageSize", + "in" : "query", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20 + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "startDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "endDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "adm0Codes", + "in" : "query", + "description" : "Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "marketID", + "in" : "query", + "description" : "The ID of the market", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "surveyType", + "in" : "query", + "description" : "The survey type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedProcessedDataDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedProcessedDataDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedProcessedDataDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_mfi-surveys-processeddata_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/MFI/Surveys/ProcessedDataWithKeysetPagination" : { + "get" : { + "tags" : [ "Incubation" ], + "summary" : "Please use this endpoint only for large data retrieval - Response will include only JSON format - \r\nGet a MFI processed data in long format; levels indicate the data aggregation level 1) Normalized Score, 2) Trader Aggregate Score, \r\n3) Market Aggregate Score, 4) Trader Median, 5) Trader Mean, 6) Market Mean; each line corresponds to one of the nine dimensions of scores \r\nplus the final MFI aggregate score; 1) Assortment, 2) Availability, 3) Price, 4) Resilience, 5) Competition, 6) Infrastructure, 7) Service, \r\n8) Quality, 9) Access and Protection, and 10) MFI final score; the variable label describes each variable and its value range", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_mfi-surveys-processeddatakeysetpagination_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "surveyID", + "in" : "query", + "description" : "The ID of the survey", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "scrollId", + "in" : "query", + "description" : "The pointer to the next paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "pageSize", + "in" : "query", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1000 + } + }, { + "name" : "startDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "endDate", + "in" : "query", + "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)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "adm0Codes", + "in" : "query", + "description" : "Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "marketID", + "in" : "query", + "description" : "The ID of the market", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "surveyType", + "in" : "query", + "description" : "The survey type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedProcessedDataDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedProcessedDataDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedProcessedDataDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_mfi-surveys-processeddatakeysetpagination_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/MFI/Surveys/FullData" : { + "get" : { + "tags" : [ "Surveys" ], + "summary" : "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.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_mfi-surveys-fulldata_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "surveyID", + "in" : "query", + "description" : "unique identifier for the collected data, as retrieved from /Surveys API.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "format", + "in" : "query", + "description" : "Output format: [JSON|CSV] Json is the default value", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "default" : "json" + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "pageSize", + "in" : "query", + "description" : "page size for paged results, default value is 20.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20 + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_mfi-surveys-fulldata_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/MFI/Surveys/BaseData" : { + "get" : { + "tags" : [ "Surveys" ], + "summary" : "Get data that includes the core Market Functionality Index (MFI) fields only by Survey ID", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_mfi-surveys-basedata_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "surveyID", + "in" : "query", + "description" : "unique identifier for the collected data, as retrieved from /Surveys API.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "pageSize", + "in" : "query", + "description" : "page size for paged results, default value is 20.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20 + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + }, + "404" : { + "description" : "Not Found", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_mfi-surveys-basedata_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/MFI/XlsForms" : { + "get" : { + "tags" : [ "XlsForms" ], + "summary" : "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.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_mfi-xlsforms_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "adm0Code", + "in" : "query", + "description" : "code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "page", + "in" : "query", + "description" : "page number for paged results", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "startDate", + "in" : "query", + "description" : "starting date for the range in which data using this XLSForm was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "endDate", + "in" : "query", + "description" : "ending date for the range in which data using this XLSForm was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24)", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedXlsFormListDTO" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_mfi-xlsforms_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/XlsForms/definition" : { + "get" : { + "tags" : [ "Incubation" ], + "summary" : "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.", + "description" : "\n\n[![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]()\n\n[![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]()\n\n[![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]()\n\n### This endpoint is restricted, it requires the scope: \"vamdatabridges_xlsforms-definition_get\"\n\n\n\n\n\n**Data Controller** - Wael ATTIA\n\n**API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern", + "parameters" : [ { + "name" : "xlsFormId", + "in" : "query", + "description" : "unique identifier for the XLS Form, as retrieved from /XLSForms", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "env", + "in" : "query", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string", + "enum" : [ "prod", "dev" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/XlsFormDefinitionNewSchemaDTO" + } + } + } + } + }, + "400" : { + "description" : "Bad Request", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestDTO" + } + } + } + } + }, + "security" : [ { + "default" : [ "vamdatabridges_xlsforms-definition_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + } + }, + "components" : { + "schemas" : { + "BadRequestDTO" : { + "type" : "object", + "properties" : { + "error" : { + "type" : "string", + "description" : "The error message returned by the application", + "nullable" : true + } + }, + "additionalProperties" : { }, + "description" : "" + }, + "CommodityDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "description" : "The internal ID of the commodity", + "format" : "int32" + }, + "parentId" : { + "type" : "integer", + "description" : "The internal parent ID of the commodity", + "format" : "int32", + "nullable" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the commodity", + "nullable" : true + }, + "coicop2018" : { + "type" : "string", + "description" : "The COICOP 2018 definition", + "nullable" : true + }, + "supply" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "categoryId" : { + "type" : "integer", + "format" : "int32" + }, + "createDate" : { + "type" : "string", + "format" : "date-time" + }, + "updateDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "qualities" : { + "type" : "array", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/CommodityQualityDTO" + } + }, + "processing" : { + "type" : "array", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/CommodityProcessingDTO" + } + } + }, + "additionalProperties" : { } + }, + "CommodityPriceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "description" : "The internal ID of the commodity", + "format" : "int32" + }, + "commodityId" : { + "type" : "integer", + "format" : "int32" + }, + "marketId" : { + "type" : "integer", + "format" : "int32" + }, + "priceTypeId" : { + "type" : "integer", + "format" : "int32" + }, + "commodityUnitId" : { + "type" : "integer", + "format" : "int32" + }, + "currencyId" : { + "type" : "integer", + "format" : "int32" + }, + "commodityName" : { + "type" : "string", + "nullable" : true + }, + "marketName" : { + "type" : "string", + "nullable" : true + }, + "priceTypeName" : { + "type" : "string", + "nullable" : true + }, + "unitName" : { + "type" : "string", + "nullable" : true + }, + "currencyName" : { + "type" : "string", + "nullable" : true + }, + "originalFrequency" : { + "type" : "string", + "nullable" : true + }, + "adm0Code" : { + "type" : "integer", + "format" : "int32" + }, + "countryISO3" : { + "type" : "string", + "nullable" : true + }, + "countryName" : { + "type" : "string", + "nullable" : true + }, + "commodityPrice" : { + "type" : "number", + "format" : "double" + }, + "commodityPriceSourceName" : { + "type" : "string", + "nullable" : true + }, + "commodityPriceMetadata" : { + "nullable" : true + }, + "commodityPriceDate" : { + "type" : "string", + "format" : "date-time" + }, + "commodityPriceObservations" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "commodityPriceDateDay" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "commodityPriceDateWeek" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "commodityPriceDateMonth" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "commodityPriceDateYear" : { + "type" : "integer", + "format" : "int32" + }, + "commodityPriceInsertDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "commodityPriceFlag" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "CommodityProcessingDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "description" : "The internal ID of the commodity", + "format" : "int32" + }, + "name" : { + "type" : "string", + "description" : "The name of the process", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "CommodityQualityDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "description" : "The internal ID of the commodity", + "format" : "int32" + }, + "name" : { + "type" : "string", + "description" : "The name of the commodity", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "CurrencyDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "description" : "The internal ID of the unit", + "format" : "int32" + }, + "name" : { + "type" : "string", + "description" : "The name of the unit", + "nullable" : true + }, + "extendedName" : { + "type" : "string", + "nullable" : true + }, + "createDate" : { + "type" : "string", + "format" : "date-time" + }, + "updateDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "EconomicDataDTO" : { + "type" : "object", + "properties" : { + "date" : { + "type" : "string", + "format" : "date-time" + }, + "value" : { + "type" : "number", + "format" : "double" + } + }, + "additionalProperties" : { } + }, + "EconomicIndicatorProperty" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "frequency" : { + "type" : "string", + "nullable" : true + }, + "unit" : { + "type" : "string", + "nullable" : true + }, + "dataSource" : { + "type" : "string", + "nullable" : true + }, + "countryIso3" : { + "type" : "string", + "nullable" : true + }, + "latestValue" : { + "type" : "number", + "format" : "double" + }, + "latestValueDate" : { + "type" : "string", + "format" : "date-time" + } + }, + "additionalProperties" : { } + }, + "EconomicIndicatorPropertyPagedResult" : { + "type" : "object", + "properties" : { + "items" : { + "type" : "array", + "nullable" : true, + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/EconomicIndicatorProperty" + } + }, + "page" : { + "type" : "integer", + "format" : "int32" + }, + "totalItems" : { + "type" : "integer", + "format" : "int32" + } + }, + "additionalProperties" : { } + }, + "Feature" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "nullable" : true + }, + "id" : { + "type" : "integer", + "format" : "int32" + }, + "bbox" : { + "type" : "array", + "nullable" : true, + "items" : { + "type" : "number", + "format" : "double" + } + }, + "geometry" : { + "$ref" : "#/components/schemas/Geometry" + }, + "properties" : { + "$ref" : "#/components/schemas/Properties" + } + }, + "additionalProperties" : { } + }, + "Geometry" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "nullable" : true + }, + "coordinates" : { + "type" : "array", + "nullable" : true, + "items" : { + "type" : "number", + "format" : "double" + } + } + }, + "additionalProperties" : { } + }, + "GorpCountryApiDto" : { + "type" : "object", + "properties" : { + "gorpDate" : { + "type" : "string", + "nullable" : true + }, + "countryOfficeIso3" : { + "type" : "string", + "nullable" : true + }, + "gorpTotalValue" : { + "type" : "number", + "format" : "double" + }, + "gorpComment" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "GorpGlobalApiDto" : { + "type" : "object", + "properties" : { + "gorpDate" : { + "type" : "string", + "nullable" : true + }, + "gorpRegionName" : { + "type" : "string", + "nullable" : true + }, + "gorpTotalValue" : { + "type" : "number", + "format" : "double" + }, + "numberOfCountries" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "gorpComment" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "GorpRegionalApiDto" : { + "type" : "object", + "properties" : { + "gorpDate" : { + "type" : "string", + "nullable" : true + }, + "gorpRegionName" : { + "type" : "string", + "nullable" : true + }, + "gorpTotalValue" : { + "type" : "number", + "format" : "double" + }, + "numberOfCountries" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "gorpComment" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "GorpValueWithChanges" : { + "type" : "object", + "properties" : { + "year" : { + "type" : "integer", + "format" : "int32" + }, + "month" : { + "type" : "string", + "nullable" : true + }, + "regionName" : { + "type" : "string", + "nullable" : true + }, + "actualValue" : { + "type" : "number", + "format" : "double" + }, + "baselineValue" : { + "type" : "number", + "format" : "double" + }, + "percentageChange" : { + "type" : "number", + "format" : "double" + }, + "absoluteChange" : { + "type" : "number", + "format" : "double" + }, + "comments" : { + "type" : "string", + "nullable" : true + }, + "numberOfCountries" : { + "type" : "integer", + "format" : "int32" + } + }, + "additionalProperties" : { } + }, + "GorpValueWithChangesPagedResult" : { + "type" : "object", + "properties" : { + "items" : { + "type" : "array", + "nullable" : true, + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/GorpValueWithChanges" + } + }, + "page" : { + "type" : "integer", + "format" : "int32" + }, + "totalItems" : { + "type" : "integer", + "format" : "int32" + } + }, + "additionalProperties" : { } + }, + "HouseholdSurveyListDTO" : { + "type" : "object", + "properties" : { + "surveyID" : { + "type" : "integer", + "description" : "The Id of the Survey", + "format" : "int32" + }, + "surveyStatusID" : { + "type" : "integer", + "description" : "The Id of the Survey status", + "format" : "int32" + }, + "surveyStartDate" : { + "type" : "string", + "description" : "The date when the survey has started", + "format" : "date-time", + "nullable" : true + }, + "surveyEndDate" : { + "type" : "string", + "description" : "The date when the survey has ended", + "format" : "date-time", + "nullable" : true + }, + "surveyCreateDate" : { + "type" : "string", + "description" : "The date when the survey has been uploaded in the Data Bridges platform", + "format" : "date-time" + }, + "surveyValidationReport" : { + "type" : "string", + "description" : "The detailed report on the validation performed on the survey schema", + "nullable" : true + }, + "surveyOriginalFilename" : { + "maxLength" : 256, + "minLength" : 0, + "type" : "string", + "description" : "The filename of the survey CSV file", + "nullable" : true + }, + "xlsFormName" : { + "type" : "string", + "description" : "The name of the XLSForm used to collect data", + "nullable" : true + }, + "baseXlsFormName" : { + "type" : "string", + "description" : "The name of the base XLSForm used to build the XLSForm", + "nullable" : true + }, + "countryName" : { + "type" : "string", + "description" : "The name of the country where the survey has taken place", + "nullable" : true + }, + "adm0Code" : { + "type" : "integer", + "description" : "The internal code of the country where the survey has taken place", + "format" : "int32" + }, + "iso3Alpha3" : { + "type" : "string", + "description" : "The ISO3 alpha code of the country where the survey has taken place", + "nullable" : true + }, + "userName" : { + "type" : "string", + "description" : "The name of the user that has uploaded the survey data", + "nullable" : true + }, + "approvedBy" : { + "type" : "string", + "nullable" : true + }, + "originalCsvFile" : { + "type" : "string", + "description" : "The link to download the original CSV file", + "nullable" : true + }, + "baseData" : { + "type" : "string", + "description" : "The link to the JSON data reshaped on the base XLSForm", + "nullable" : true + }, + "surveyAttributes" : { + "type" : "array", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/KeyNameDto" + } + }, + "organizations" : { + "type" : "array", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/KeyNameDto" + } + }, + "surveyModalityName" : { + "type" : "string", + "nullable" : true + }, + "surveyCategoryName" : { + "type" : "string", + "nullable" : true + }, + "surveySubCategoryName" : { + "type" : "string", + "nullable" : true + }, + "surveyPhaseName" : { + "type" : "string", + "nullable" : true + }, + "surveyVisibility" : { + "type" : "string", + "nullable" : true + }, + "isContinuousMonitoring" : { + "type" : "boolean" + }, + "surveyName" : { + "type" : "string", + "nullable" : true + }, + "xlsFormId" : { + "type" : "integer", + "format" : "int32" + }, + "baseXlsFormId" : { + "type" : "integer", + "format" : "int32" + } + }, + "additionalProperties" : { } + }, + "HouseholdSurveyListDTOPagedResult" : { + "type" : "object", + "properties" : { + "items" : { + "type" : "array", + "nullable" : true, + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/HouseholdSurveyListDTO" + } + }, + "page" : { + "type" : "integer", + "format" : "int32" + }, + "totalItems" : { + "type" : "integer", + "format" : "int32" + } + }, + "additionalProperties" : { } + }, + "IpcValue" : { + "type" : "object", + "properties" : { + "ipcId" : { + "type" : "integer", + "format" : "int32" + }, + "ipcYear" : { + "type" : "integer", + "format" : "int32" + }, + "iso3Alpha3" : { + "maxLength" : 3, + "minLength" : 0, + "type" : "string", + "nullable" : true + }, + "ipcIsLatestValue" : { + "type" : "boolean" + }, + "ipcCountryName" : { + "maxLength" : 128, + "minLength" : 0, + "type" : "string", + "nullable" : true + }, + "ipcAreaName" : { + "maxLength" : 128, + "minLength" : 0, + "type" : "string", + "nullable" : true + }, + "ipcPhase3Population" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "ipcPhase4Population" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "ipcPhase5Population" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "ipcPhase3Percentage" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "ipcPhase4Percentage" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "ipcPhase5Percentage" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "ipcAnalysedPopulation" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "ipcAnalysedPercentage" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "ipcAnalysisComment" : { + "type" : "string", + "nullable" : true + }, + "ipcDataType" : { + "maxLength" : 256, + "minLength" : 0, + "type" : "string", + "nullable" : true + }, + "ipcDataSource" : { + "maxLength" : 128, + "minLength" : 0, + "type" : "string", + "nullable" : true + }, + "ipcReferencePeriod" : { + "maxLength" : 256, + "minLength" : 0, + "type" : "string", + "nullable" : true + }, + "ipcCreateDate" : { + "type" : "string", + "format" : "date-time" + }, + "ipcUpdateDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "IpcValuePagedResult" : { + "type" : "object", + "properties" : { + "items" : { + "type" : "array", + "nullable" : true, + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/IpcValue" + } + }, + "page" : { + "type" : "integer", + "format" : "int32" + }, + "totalItems" : { + "type" : "integer", + "format" : "int32" + } + }, + "additionalProperties" : { } + }, + "KeyNameDto" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "MFIProcessedDataDTO" : { + "type" : "object", + "properties" : { + "surveyID" : { + "type" : "integer", + "description" : "The Id of the Survey", + "format" : "int32" + }, + "startDate" : { + "type" : "string", + "description" : "The Id of the Survey status", + "format" : "date-time", + "nullable" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "marketID" : { + "type" : "integer", + "format" : "int32" + }, + "marketName" : { + "type" : "string", + "nullable" : true + }, + "marketLatitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "marketLongitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "regionalBureauID" : { + "type" : "integer", + "format" : "int32" + }, + "regionalBureauName" : { + "type" : "string", + "nullable" : true + }, + "adm0Code" : { + "type" : "integer", + "format" : "int32" + }, + "adm0Name" : { + "type" : "string", + "nullable" : true + }, + "adm1Code" : { + "type" : "integer", + "format" : "int32" + }, + "adm1Name" : { + "type" : "string", + "nullable" : true + }, + "adm2Code" : { + "type" : "integer", + "format" : "int32" + }, + "adm2Name" : { + "type" : "string", + "nullable" : true + }, + "levelID" : { + "type" : "integer", + "format" : "int32" + }, + "levelName" : { + "type" : "string", + "nullable" : true + }, + "dimensionID" : { + "type" : "integer", + "format" : "int32" + }, + "dimensionName" : { + "type" : "string", + "nullable" : true + }, + "variableID" : { + "type" : "integer", + "format" : "int32" + }, + "variableName" : { + "type" : "string", + "nullable" : true + }, + "variableLabel" : { + "type" : "string", + "nullable" : true + }, + "outputValue" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "tradersSampleSize" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "baseXlsFormID" : { + "type" : "integer", + "format" : "int32" + }, + "baseXlsFormName" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "MarketDTO" : { + "type" : "object", + "properties" : { + "marketId" : { + "type" : "integer", + "description" : "The internal ID of the market", + "format" : "int32" + }, + "marketName" : { + "type" : "string", + "description" : "The name of the market", + "nullable" : true + }, + "marketLocalName" : { + "type" : "string", + "description" : "The local name of the market", + "nullable" : true + }, + "marketLatitude" : { + "type" : "number", + "description" : "The decimal latitude", + "format" : "double", + "nullable" : true + }, + "marketLongitude" : { + "type" : "number", + "description" : "The decimal longitude", + "format" : "double", + "nullable" : true + }, + "admin1Name" : { + "type" : "string", + "description" : "The name of the first level administrative division where the market is placed", + "nullable" : true + }, + "admin1Code" : { + "type" : "integer", + "description" : "The code of the first level administrative division where the market is placed", + "format" : "int32", + "nullable" : true + }, + "admin2Name" : { + "type" : "string", + "description" : "The name of the second level administrative division where the market is placed", + "nullable" : true + }, + "admin2Code" : { + "type" : "integer", + "description" : "The code of the second level administrative division where the market is placed", + "format" : "int32", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "MarketGeoJsonRoot" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "nullable" : true + }, + "features" : { + "type" : "array", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/Feature" + } + }, + "bbox" : { + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "NearbyMarketsDTO" : { + "type" : "object", + "properties" : { + "marketId" : { + "type" : "integer", + "description" : "The internal ID of the market", + "format" : "int32" + }, + "marketName" : { + "type" : "string", + "description" : "The name of the market", + "nullable" : true + }, + "distance" : { + "type" : "number", + "description" : "The distance in meters of the market from the provided point", + "format" : "double" + } + }, + "additionalProperties" : { } + }, + "PagedCommodityListDTO" : { + "type" : "object", + "properties" : { + "totalItems" : { + "type" : "integer", + "description" : "The total number of items", + "format" : "int32" + }, + "page" : { + "type" : "integer", + "description" : "The current page", + "format" : "int32" + }, + "items" : { + "type" : "array", + "description" : "The list of paged items", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/CommodityDTO" + } + } + }, + "additionalProperties" : { } + }, + "PagedCommodityPriceListDTO" : { + "type" : "object", + "properties" : { + "totalItems" : { + "type" : "integer", + "description" : "The total number of items", + "format" : "int32" + }, + "page" : { + "type" : "integer", + "description" : "The current page", + "format" : "int32" + }, + "items" : { + "type" : "array", + "description" : "The list of paged items", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/CommodityPriceDTO" + } + } + }, + "additionalProperties" : { } + }, + "PagedCommodityWeeklyAggregatedPriceListDTO" : { + "type" : "object", + "properties" : { + "totalItems" : { + "type" : "integer", + "description" : "The total number of items", + "format" : "int32" + }, + "page" : { + "type" : "integer", + "description" : "The current page", + "format" : "int32" + }, + "items" : { + "type" : "array", + "description" : "The list of paged items", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/WeeklyAggregatedPrice" + } + } + }, + "additionalProperties" : { } + }, + "PagedCurrencyListDTO" : { + "type" : "object", + "properties" : { + "totalItems" : { + "type" : "integer", + "description" : "The total number of items", + "format" : "int32" + }, + "page" : { + "type" : "integer", + "description" : "The current page", + "format" : "int32" + }, + "items" : { + "type" : "array", + "description" : "The list of paged items", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/CurrencyDTO" + } + } + }, + "additionalProperties" : { } + }, + "PagedEconomicDataDTO" : { + "type" : "object", + "properties" : { + "totalItems" : { + "type" : "integer", + "description" : "The total number of items", + "format" : "int32" + }, + "page" : { + "type" : "integer", + "description" : "The current page", + "format" : "int32" + }, + "unit" : { + "type" : "string", + "nullable" : true + }, + "frequency" : { + "type" : "string", + "nullable" : true + }, + "dataSource" : { + "type" : "string", + "nullable" : true + }, + "items" : { + "type" : "array", + "description" : "The list of paged items", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/EconomicDataDTO" + } + } + }, + "additionalProperties" : { } + }, + "PagedMarketListDTO" : { + "type" : "object", + "properties" : { + "totalItems" : { + "type" : "integer", + "description" : "The total number of items", + "format" : "int32" + }, + "page" : { + "type" : "integer", + "description" : "The current page", + "format" : "int32" + }, + "items" : { + "type" : "array", + "description" : "The list of markets", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/MarketDTO" + } + } + }, + "additionalProperties" : { } + }, + "PagedProcessedDataDTO" : { + "type" : "object", + "properties" : { + "totalItems" : { + "type" : "integer", + "description" : "The total number of items", + "format" : "int32" + }, + "page" : { + "type" : "integer", + "description" : "The current page", + "format" : "int32" + }, + "scrollId" : { + "type" : "integer", + "format" : "int32" + }, + "items" : { + "type" : "array", + "description" : "The list of processed data", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/MFIProcessedDataDTO" + } + } + }, + "additionalProperties" : { } + }, + "PagedSurveyListDTO" : { + "type" : "object", + "properties" : { + "totalItems" : { + "type" : "integer", + "description" : "The total number of items", + "format" : "int32" + }, + "page" : { + "type" : "integer", + "description" : "The current page", + "format" : "int32" + }, + "items" : { + "type" : "array", + "description" : "The list of surveys", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/SurveyListDTO" + } + } + }, + "additionalProperties" : { } + }, + "PagedSurveyResponsesDTO" : { + "type" : "object", + "properties" : { + "totalItems" : { + "type" : "integer", + "description" : "The total number of responses", + "format" : "int32" + }, + "page" : { + "type" : "integer", + "description" : "The current page", + "format" : "int32" + }, + "items" : { + "type" : "array", + "description" : "The list of survey responses", + "nullable" : true, + "items" : { } + } + }, + "additionalProperties" : { } + }, + "PagedXlsFormListDTO" : { + "type" : "object", + "properties" : { + "totalItems" : { + "type" : "integer", + "description" : "The total number of items", + "format" : "int32" + }, + "page" : { + "type" : "integer", + "description" : "The current page", + "format" : "int32" + }, + "items" : { + "type" : "array", + "description" : "The list of XlsForms", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/XlsFormDTO" + } + } + }, + "additionalProperties" : { } + }, + "ProblemDetails" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "nullable" : true + }, + "title" : { + "type" : "string", + "nullable" : true + }, + "status" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "detail" : { + "type" : "string", + "nullable" : true + }, + "instance" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "Properties" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "RpmeAssessment" : { + "type" : "object", + "properties" : { + "surveyId" : { + "type" : "integer", + "format" : "int32" + }, + "assessmentDate" : { + "type" : "string", + "format" : "date-time" + }, + "shopId" : { + "type" : "integer", + "format" : "int32" + }, + "adm0Code" : { + "type" : "integer", + "format" : "int32" + }, + "adm1Code" : { + "type" : "integer", + "format" : "int32" + }, + "adm2Code" : { + "type" : "integer", + "format" : "int32" + }, + "adm0CodeDOTS" : { + "type" : "string", + "nullable" : true + }, + "adm1CodeDOTS" : { + "type" : "string", + "nullable" : true + }, + "adm2CodeDOTS" : { + "type" : "string", + "nullable" : true + }, + "marketId" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "shLatitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "shLongitude" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "nbBeneficiariesInterviewed" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "priceScoreTbu" : { + "type" : "boolean" + }, + "priceScoreTbd" : { + "type" : "boolean" + }, + "beneficiariesScoreTbu" : { + "type" : "boolean" + }, + "trdName" : { + "type" : "string", + "nullable" : true + }, + "sevCntrDev" : { + "type" : "string", + "nullable" : true + }, + "benSevCntrDev" : { + "type" : "string", + "nullable" : true + }, + "outputValues" : { + "type" : "array", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/RpmeOutputValues" + } + } + }, + "additionalProperties" : { } + }, + "RpmeAssessmentPagedResult" : { + "type" : "object", + "properties" : { + "items" : { + "type" : "array", + "nullable" : true, + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/RpmeAssessment" + } + }, + "page" : { + "type" : "integer", + "format" : "int32" + }, + "totalItems" : { + "type" : "integer", + "format" : "int32" + } + }, + "additionalProperties" : { } + }, + "RpmeOutputValues" : { + "type" : "object", + "properties" : { + "variableId" : { + "type" : "integer", + "format" : "int32" + }, + "outputValue" : { + "type" : "number", + "format" : "double", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "RpmeVariable" : { + "type" : "object", + "properties" : { + "variableId" : { + "type" : "integer", + "format" : "int32" + }, + "variableName" : { + "type" : "string", + "nullable" : true + }, + "variableDescription" : { + "type" : "string", + "nullable" : true + }, + "dimensionId" : { + "type" : "integer", + "format" : "int32" + }, + "dimensionName" : { + "type" : "string", + "nullable" : true + }, + "levelId" : { + "type" : "integer", + "format" : "int32" + }, + "levelName" : { + "type" : "string", + "nullable" : true + }, + "surveyModeId" : { + "type" : "integer", + "format" : "int32" + }, + "surveyModeName" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "RpmeVariablePagedResult" : { + "type" : "object", + "properties" : { + "items" : { + "type" : "array", + "nullable" : true, + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/RpmeVariable" + } + }, + "page" : { + "type" : "integer", + "format" : "int32" + }, + "totalItems" : { + "type" : "integer", + "format" : "int32" + } + }, + "additionalProperties" : { } + }, + "SurveyListDTO" : { + "type" : "object", + "properties" : { + "surveyID" : { + "type" : "integer", + "description" : "The Id of the Survey", + "format" : "int32" + }, + "surveyStatusID" : { + "type" : "integer", + "description" : "The Id of the Survey status", + "format" : "int32" + }, + "surveyStartDate" : { + "type" : "string", + "description" : "The date when the survey has started", + "format" : "date-time", + "nullable" : true + }, + "surveyEndDate" : { + "type" : "string", + "description" : "The date when the survey has ended", + "format" : "date-time", + "nullable" : true + }, + "surveyCreateDate" : { + "type" : "string", + "description" : "The date when the survey has been uploaded in the Data Bridges platform", + "format" : "date-time" + }, + "surveyValidationReport" : { + "type" : "string", + "description" : "The detailed report on the validation performed on the survey schema", + "nullable" : true + }, + "surveyOriginalFilename" : { + "maxLength" : 256, + "minLength" : 0, + "type" : "string", + "description" : "The filename of the survey CSV file", + "nullable" : true + }, + "xlsFormName" : { + "type" : "string", + "description" : "The name of the XLSForm used to collect data", + "nullable" : true + }, + "baseXlsFormName" : { + "type" : "string", + "description" : "The name of the base XLSForm used to build the XLSForm", + "nullable" : true + }, + "countryName" : { + "type" : "string", + "description" : "The name of the country where the survey has taken place", + "nullable" : true + }, + "adm0Code" : { + "type" : "integer", + "description" : "The internal code of the country where the survey has taken place", + "format" : "int32" + }, + "iso3Alpha3" : { + "type" : "string", + "description" : "The ISO3 alpha code of the country where the survey has taken place", + "nullable" : true + }, + "userName" : { + "type" : "string", + "description" : "The name of the user that has uploaded the survey data", + "nullable" : true + }, + "originalCsvFile" : { + "type" : "string", + "description" : "The link to download the original CSV file", + "nullable" : true + }, + "baseData" : { + "type" : "string", + "description" : "The link to the JSON data reshaped on the base XLSForm", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "UsdIndirectQuotation" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string", + "description" : "the ISO3 code for the currency, based on ISO4217", + "nullable" : true + }, + "adm0Code" : { + "type" : "integer", + "format" : "int32" + }, + "countryISO3" : { + "type" : "string", + "description" : "", + "nullable" : true + }, + "isOfficial" : { + "type" : "boolean", + "description" : "The field IsOfficial is a boolean which can be set to true for the Trading Economics data and to false for the data coming from a commodity saved in the DataBridges database" + }, + "frequency" : { + "type" : "string", + "description" : "(it’s from the reporting commodity named Exchange Rate", + "nullable" : true + }, + "value" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "date" : { + "type" : "string", + "format" : "date-time" + } + }, + "additionalProperties" : { } + }, + "UsdIndirectQuotationPagedResult" : { + "type" : "object", + "properties" : { + "items" : { + "type" : "array", + "nullable" : true, + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/UsdIndirectQuotation" + } + }, + "page" : { + "type" : "integer", + "format" : "int32" + }, + "totalItems" : { + "type" : "integer", + "format" : "int32" + } + }, + "additionalProperties" : { } + }, + "ViewExtendedAggregatedPrice" : { + "type" : "object", + "properties" : { + "commodityID" : { + "type" : "integer", + "format" : "int32" + }, + "marketID" : { + "type" : "integer", + "format" : "int32" + }, + "priceTypeID" : { + "type" : "integer", + "format" : "int32" + }, + "commodityUnitID" : { + "type" : "integer", + "format" : "int32" + }, + "currencyID" : { + "type" : "integer", + "format" : "int32" + }, + "adm0Code" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "commodityDateWeek" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "commodityDateMonth" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "commodityDateYear" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "commodityPriceDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "commodityName" : { + "type" : "string", + "nullable" : true + }, + "marketName" : { + "type" : "string", + "nullable" : true + }, + "priceTypeName" : { + "type" : "string", + "nullable" : true + }, + "commodityUnitName" : { + "type" : "string", + "nullable" : true + }, + "currencyName" : { + "type" : "string", + "nullable" : true + }, + "countryISO3" : { + "type" : "string", + "nullable" : true + }, + "countryName" : { + "type" : "string", + "nullable" : true + }, + "commodityPriceSourceName" : { + "type" : "string", + "nullable" : true + }, + "originalFrequency" : { + "type" : "string", + "nullable" : true + }, + "commodityPrice" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "commodityPriceObservations" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "commodityPriceFlag" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "ViewExtendedAggregatedPricePagedResult" : { + "type" : "object", + "properties" : { + "items" : { + "type" : "array", + "nullable" : true, + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/ViewExtendedAggregatedPrice" + } + }, + "page" : { + "type" : "integer", + "format" : "int32" + }, + "totalItems" : { + "type" : "integer", + "format" : "int32" + } + }, + "additionalProperties" : { } + }, + "ViewExtendedAlpsValue" : { + "type" : "object", + "properties" : { + "commodityID" : { + "type" : "integer", + "format" : "int32" + }, + "marketID" : { + "type" : "integer", + "format" : "int32" + }, + "priceTypeID" : { + "type" : "integer", + "format" : "int32" + }, + "commodityUnitID" : { + "type" : "integer", + "format" : "int32" + }, + "currencyID" : { + "type" : "integer", + "format" : "int32" + }, + "adm0Code" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "countryName" : { + "type" : "string", + "nullable" : true + }, + "commodityPriceDateYear" : { + "type" : "integer", + "format" : "int32" + }, + "commodityPriceDateMonth" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "commodityPriceDateWeek" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "commodityPriceDate" : { + "type" : "string", + "format" : "date-time", + "nullable" : true + }, + "commodityName" : { + "type" : "string", + "nullable" : true + }, + "marketName" : { + "type" : "string", + "nullable" : true + }, + "priceTypeName" : { + "type" : "string", + "nullable" : true + }, + "commodityUnitName" : { + "type" : "string", + "nullable" : true + }, + "currencyName" : { + "type" : "string", + "nullable" : true + }, + "analysisValueEstimatedPrice" : { + "type" : "number", + "format" : "double" + }, + "analysisValuePewiValue" : { + "type" : "number", + "format" : "double" + }, + "analysisValuePriceFlag" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "ViewExtendedAlpsValuePagedResult" : { + "type" : "object", + "properties" : { + "items" : { + "type" : "array", + "nullable" : true, + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/ViewExtendedAlpsValue" + } + }, + "page" : { + "type" : "integer", + "format" : "int32" + }, + "totalItems" : { + "type" : "integer", + "format" : "int32" + } + }, + "additionalProperties" : { } + }, + "WeeklyAggregatedPrice" : { + "type" : "object", + "properties" : { + "commodityId" : { + "type" : "integer", + "format" : "int32" + }, + "marketId" : { + "type" : "integer", + "format" : "int32" + }, + "priceTypeId" : { + "type" : "integer", + "format" : "int32" + }, + "commodityUnitId" : { + "type" : "integer", + "format" : "int32" + }, + "currencyId" : { + "type" : "integer", + "format" : "int32" + }, + "commodityName" : { + "type" : "string", + "nullable" : true + }, + "marketName" : { + "type" : "string", + "nullable" : true + }, + "priceTypeName" : { + "type" : "string", + "nullable" : true + }, + "commodityUnitName" : { + "type" : "string", + "nullable" : true + }, + "currencyName" : { + "type" : "string", + "nullable" : true + }, + "adm0Code" : { + "type" : "integer", + "format" : "int32" + }, + "countryISO3" : { + "type" : "string", + "nullable" : true + }, + "countryName" : { + "type" : "string", + "nullable" : true + }, + "commodityPrice" : { + "type" : "number", + "format" : "double" + }, + "originalFrequency" : { + "type" : "string", + "nullable" : true + }, + "commodityPriceSourceName" : { + "type" : "string", + "nullable" : true + }, + "commodityPriceObservations" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "commodityDateMonth" : { + "type" : "integer", + "format" : "int32" + }, + "commodityDateYear" : { + "type" : "integer", + "format" : "int32" + }, + "commodityPriceDate" : { + "type" : "string", + "format" : "date-time" + }, + "commodityPriceFlag" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "XlsFormDTO" : { + "type" : "object", + "properties" : { + "xlsFormID" : { + "type" : "integer", + "format" : "int32" + }, + "xlsFormName" : { + "type" : "string", + "nullable" : true + }, + "xlsFormCreateDate" : { + "type" : "string", + "format" : "date-time" + }, + "userName" : { + "type" : "string", + "nullable" : true + }, + "xlsFormSourceFile" : { + "type" : "string", + "nullable" : true + }, + "xlsFormIsBaseSchema" : { + "type" : "boolean" + }, + "adm0Code" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "XlsFormDefinitionNewSchemaDTO" : { + "type" : "object", + "properties" : { + "formName" : { + "type" : "string", + "nullable" : true + }, + "formDescription" : { + "type" : "string", + "nullable" : true + }, + "formType" : { + "type" : "string", + "nullable" : true + }, + "adm0Code" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "baseSchemaId" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "category" : { + "type" : "string", + "nullable" : true + }, + "type" : { + "type" : "string", + "nullable" : true + }, + "fields" : { + "type" : "array", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/XlsFormFieldsDTO" + } + } + }, + "additionalProperties" : { } + }, + "XlsFormFieldsDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "nullable" : true + }, + "label" : { + "type" : "string", + "nullable" : true + }, + "type" : { + "type" : "string", + "nullable" : true + }, + "choiceList" : { + "$ref" : "#/components/schemas/XlsFormListChoicesDTO" + } + }, + "additionalProperties" : { } + }, + "XlsFormListChoiceDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "nullable" : true + }, + "label" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "XlsFormListChoicesDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "nullable" : true + }, + "choices" : { + "type" : "array", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/XlsFormListChoiceDTO" + } + } + }, + "additionalProperties" : { } + } + }, + "parameters" : { }, + "securitySchemes" : { + "default" : { + "type" : "oauth2", + "flows" : { + "implicit" : { + "authorizationUrl" : "https://api.wfp.org/authorize", + "scopes" : { + "vamdatabridges_rpme-fulldata_get" : "vamdatabridges_rpme-fulldata_get", + "vamdatabridges_foodsecurity-list_get" : "vamdatabridges_foodsecurity-list_get", + "vamdatabridges_commodities-list_get" : "vamdatabridges_commodities-list_get", + "vamdatabridges_commodityunits-list_get" : "vamdatabridges_commodityunits-list_get", + "vamdatabridges_markets-nearbymarkets_get" : "vamdatabridges_markets-nearbymarkets_get", + "vamdatabridges_rpme-outputvalues_get" : "vamdatabridges_rpme-outputvalues_get", + "vamdatabridges_marketprices-alps_get" : "vamdatabridges_marketprices-alps_get", + "vamdatabridges_mfi-surveys_get" : "vamdatabridges_mfi-surveys_get", + "vamdatabridges_commodities-categories-list_get" : "vamdatabridges_commodities-categories-list_get", + "vamdatabridges_commodityunits-conversion-list_get" : "vamdatabridges_commodityunits-conversion-list_get", + "vamdatabridges_economicdata_get" : "vamdatabridges_economicdata_get", + "vamdatabridges_mfi-surveys-processeddata_get" : "vamdatabridges_mfi-surveys-processeddata_get", + "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_mfi-surveys-processeddatakeysetpagination_get" : "vamdatabridges_mfi-surveys-processeddatakeysetpagination_get", + "vamdatabridges_rpme-surveys_get" : "vamdatabridges_rpme-surveys_get", + "vamdatabridges_rpme-xlsforms_get" : "vamdatabridges_rpme-xlsforms_get", + "vamdatabridges_mfi-surveys-basedata_get" : "vamdatabridges_mfi-surveys-basedata_get", + "vamdatabridges_mfi-surveys-fulldata_get" : "vamdatabridges_mfi-surveys-fulldata_get", + "vamdatabridges_household-fulldata_get" : "vamdatabridges_household-fulldata_get", + "vamdatabridges_household-officialusebasedata_get" : "vamdatabridges_household-officialusebasedata_get", + "vamdatabridges_marketprices-pricemonthly_get" : "vamdatabridges_marketprices-pricemonthly_get", + "vamdatabridges_aims-downloadallanalysisrounds_get" : "vamdatabridges_aims-downloadallanalysisrounds_get", + "vamdatabridges_markets-list_get" : "vamdatabridges_markets-list_get", + "vamdatabridges_currency-list_get" : "vamdatabridges_currency-list_get", + "vamdatabridges_gorp-list_get" : "vamdatabridges_gorp-list_get", + "vamdatabridges_marketprices-priceraw_get" : "vamdatabridges_marketprices-priceraw_get", + "vamdatabridges_rpme-variables_get" : "vamdatabridges_rpme-variables_get", + "vamdatabridges_aims-downloadpolygonfiles_get" : "vamdatabridges_aims-downloadpolygonfiles_get", + "vamdatabridges_gorp-latest_get" : "vamdatabridges_gorp-latest_get", + "vamdatabridges_gorp-countrylatest_get" : "vamdatabridges_gorp-countrylatest_get", + "vamdatabridges_currency-usdindirectquotation_get" : "vamdatabridges_currency-usdindirectquotation_get", + "vamdatabridges_xlsforms-definition_get" : "vamdatabridges_xlsforms-definition_get", + "vamdatabridges_household-draftinternalbasedata_get" : "vamdatabridges_household-draftinternalbasedata_get", + "vamdatabridges_household-surveys_get" : "vamdatabridges_household-surveys_get", + "vamdatabridges_marketprices-pricedaily_get" : "vamdatabridges_marketprices-pricedaily_get", + "vamdatabridges_rpme-basedata_get" : "vamdatabridges_rpme-basedata_get" + }, + "x-scopes-bindings" : { + "vamdatabridges_rpme-fulldata_get" : "vamdatabridges_rpme-fulldata_get", + "vamdatabridges_foodsecurity-list_get" : "vamdatabridges_foodsecurity-list_get", + "vamdatabridges_commodities-list_get" : "vamdatabridges_commodities-list_get", + "vamdatabridges_commodityunits-list_get" : "vamdatabridges_commodityunits-list_get", + "vamdatabridges_markets-nearbymarkets_get" : "vamdatabridges_markets-nearbymarkets_get", + "vamdatabridges_rpme-outputvalues_get" : "vamdatabridges_rpme-outputvalues_get", + "vamdatabridges_marketprices-alps_get" : "vamdatabridges_marketprices-alps_get", + "vamdatabridges_mfi-surveys_get" : "vamdatabridges_mfi-surveys_get", + "vamdatabridges_commodities-categories-list_get" : "vamdatabridges_commodities-categories-list_get", + "vamdatabridges_commodityunits-conversion-list_get" : "vamdatabridges_commodityunits-conversion-list_get", + "vamdatabridges_economicdata_get" : "vamdatabridges_economicdata_get", + "vamdatabridges_mfi-surveys-processeddata_get" : "vamdatabridges_mfi-surveys-processeddata_get", + "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_mfi-surveys-processeddatakeysetpagination_get" : "vamdatabridges_mfi-surveys-processeddatakeysetpagination_get", + "vamdatabridges_rpme-surveys_get" : "vamdatabridges_rpme-surveys_get", + "vamdatabridges_rpme-xlsforms_get" : "vamdatabridges_rpme-xlsforms_get", + "vamdatabridges_mfi-surveys-basedata_get" : "vamdatabridges_mfi-surveys-basedata_get", + "vamdatabridges_mfi-surveys-fulldata_get" : "vamdatabridges_mfi-surveys-fulldata_get", + "vamdatabridges_household-fulldata_get" : "vamdatabridges_household-fulldata_get", + "vamdatabridges_household-officialusebasedata_get" : "vamdatabridges_household-officialusebasedata_get", + "vamdatabridges_marketprices-pricemonthly_get" : "vamdatabridges_marketprices-pricemonthly_get", + "vamdatabridges_aims-downloadallanalysisrounds_get" : "vamdatabridges_aims-downloadallanalysisrounds_get", + "vamdatabridges_markets-list_get" : "vamdatabridges_markets-list_get", + "vamdatabridges_currency-list_get" : "vamdatabridges_currency-list_get", + "vamdatabridges_gorp-list_get" : "vamdatabridges_gorp-list_get", + "vamdatabridges_marketprices-priceraw_get" : "vamdatabridges_marketprices-priceraw_get", + "vamdatabridges_rpme-variables_get" : "vamdatabridges_rpme-variables_get", + "vamdatabridges_aims-downloadpolygonfiles_get" : "vamdatabridges_aims-downloadpolygonfiles_get", + "vamdatabridges_gorp-latest_get" : "vamdatabridges_gorp-latest_get", + "vamdatabridges_gorp-countrylatest_get" : "vamdatabridges_gorp-countrylatest_get", + "vamdatabridges_currency-usdindirectquotation_get" : "vamdatabridges_currency-usdindirectquotation_get", + "vamdatabridges_xlsforms-definition_get" : "vamdatabridges_xlsforms-definition_get", + "vamdatabridges_household-draftinternalbasedata_get" : "vamdatabridges_household-draftinternalbasedata_get", + "vamdatabridges_household-surveys_get" : "vamdatabridges_household-surveys_get", + "vamdatabridges_marketprices-pricedaily_get" : "vamdatabridges_marketprices-pricedaily_get", + "vamdatabridges_rpme-basedata_get" : "vamdatabridges_rpme-basedata_get" + } + } + } + } + } + }, + "x-changelog" : [ { + "changes" : "First release", + "version" : "1.0.0" + }, { + "changes" : "\n*What's New*:\n\n- GET _/Commodities/Categories/List_\n- GET _/Commodities/List_\n- GET _/CommodityUnits/Conversion/List_\n- GET _/CommodityUnits/List_\n- GET _/Currency/List_\n- GET _/Currency/UsdIndirectQuotation_\n- GET _/EconomicData/IndicatorList_\n- GET _/EconomicData/{indicatorName}_\n- GET _/MarketPrices/Alps_\n- GET _/MarketPrices/PriceDaily_\n- GET _/MarketPrices/PriceMonthly_\n- GET _/MarketPrices/PriceRaw_\n- GET _/MarketPrices/PriceWeekly_\n- GET _/Markets/List_\n", + "version" : "1.1.0" + }, { + "changes" : "\n*What's New*:\n\n- GET /Gorp/Latest\n- GET /Gorp/List\n", + "version" : "1.2.0" + }, { + "changes" : "\n*What's New*:\n\n- GET /FoodSecurity/List\n- GET /Rpme/OutputValues\n- GET /Rpme/Surveys\n- GET /Rpme/Variables\n- GET /Rpme/XLSForms", + "version" : "1.3.0" + }, { + "changes" : "\n*What's Changed*:\n\n- Rpme/OutputValues response schema\n- /Rpme/* and /FoodSecurity/List maturity level to production-ready", + "version" : "1.3.1" + }, { + "changes" : "\n*What's Changed*:\n- Changed response schema in GET /MFI/Surveys/BaseData \n- Changed response schema in GET /MFI/Surveys/FullData \n- Changed response schema in GET /MFI/XlsForms/definition \n- Changed response schema in GET /Markets/NearbyMarkets \n- Changed response schema in GET /Currency/List \n- Changed response schema in GET /Currency/UsdIndirectQuotation \n- Changed response schema in GET /FoodSecurity/List \n- Changed response schema in GET /Gorp/Latest \n- Changed response schema in GET /Gorp/List \n- Changed response schema in GET /MFI/Surveys \n- Changed response schema in GET /MFI/Surveys/ProcessedData \n- Changed response schema in GET /MFI/XlsForms \n- Changed response schema in GET /MarketPrices/Alps \n- Changed response schema in GET /MarketPrices/PriceDaily \n- Changed response schema in GET /MarketPrices/PriceMonthly \n- Changed response schema in GET /MarketPrices/PriceRaw \n- Changed response schema in GET /MarketPrices/PriceWeekly \n- Changed response schema in GET /Rpme/Surveys \n- Changed response schema in GET /Rpme/Variables \n- Changed response schema in GET /Rpme/XLSForms \n- Changed response schema in GET /Commodities/Categories/List \n- Changed response schema in GET /Commodities/List \n- Changed response schema in GET /CommodityUnits/Conversion/List \n- Changed response schema in GET /CommodityUnits/List \n- Changed response schema in GET /Rpme/OutputValues \n- Changed response schema in GET /Markets/GeoJSONList \n", + "version" : "1.3.3" + }, { + "changes" : "\n*What's New*:\n- GET /Household/Surveys\n- GET /Household/FullData\n- GET /Household/DraftInternalBaseData\n- GET /Household/OfficialUseBaseData\n- GET /Household/PublicBaseData\n- GET /Rpme/FullData\n- GET /Rpme/BaseData\n*What's Changed*:\n- Changed summary in GET /MFI/Surveys \n- Changed summary in GET /MFI/Surveys/ProcessedData \n- Changed description in GET /MarketPrices/PriceDaily \n", + "version" : "1.4.0" + }, { + "changes" : "\n*This version is not backward-compatible with previous versions.*\n*What's Changed*:\n- Changed response schema in GET /MFI/XlsForms (Non-backward compatible)\n- Changed response schema in GET /Markets/GeoJSONList (Non-backward compatible)\n- Changed response schema in GET /Markets/List (Non-backward compatible)\n- GET /Markets/MarketsAsCSV \n- Changed response schema in GET /Rpme/XLSForms (Non-backward compatible)\n- Changed response schema in GET /EconomicData/{indicatorName} (Non-backward compatible)\n- Changed response schema in GET /Household/DraftInternalBaseData \n- Changed response schema in GET /Household/FullData \n- Changed response schema in GET /Household/OfficialUseBaseData \n- Changed response schema in GET /Household/PublicBaseData \n- Changed response schema in GET /Household/Surveys (Non-backward compatible)\n- Changed response schema in GET /MFI/Surveys (Non-backward compatible)\n- Changed response schema in GET /MFI/Surveys/BaseData \n- Changed response schema in GET /MFI/Surveys/FullData \n- Changed response schema in GET /MFI/XlsForms/definition (Non-backward compatible)\n- Changed response schema in GET /Markets/NearbyMarkets (Non-backward compatible)\n- Changed response schema in GET /Rpme/BaseData \n- Changed response schema in GET /Rpme/FullData \n- Changed response schema in GET /Rpme/Surveys (Non-backward compatible)\n- GET /Currency/List \n- Changed response schema in GET /Currency/UsdIndirectQuotation \n- Changed response schema in GET /EconomicData/IndicatorList (Non-backward compatible)\n- Changed response schema in GET /FoodSecurity/List \n- Changed response schema in GET /Gorp/Latest \n- Changed response schema in GET /Gorp/List \n- GET /MFI/Surveys/ProcessedData \n- Changed response schema in GET /MarketPrices/Alps \n- Changed response schema in GET /MarketPrices/PriceDaily \n- Changed response schema in GET /MarketPrices/PriceMonthly \n- GET /MarketPrices/PriceRaw \n- GET /MarketPrices/PriceWeekly \n- Changed response schema in GET /Rpme/Variables \n- GET /Commodities/Categories/List \n- GET /Commodities/List \n- GET /CommodityUnits/Conversion/List \n- GET /CommodityUnits/List \n- Changed response schema in GET /Rpme/OutputValues \n", + "version" : "2.0.0" + }, { + "changes" : "\n*This version is not backward-compatible with previous versions.*\n*What's Changed*:\n- Add access scope to GET /Markets/MarketsAsCSV (Non-backward compatible)\n- Add access scope to GET /MFI/Surveys/BaseData (Non-backward compatible)\n- Add access scope to GET /MFI/XlsForms/definition (Non-backward compatible)\n- Add access scope to GET /Markets/NearbyMarkets (Non-backward compatible)\n- Add access scope to GET /Rpme/BaseData (Non-backward compatible)\n- Add access scope to GET /Currency/List (Non-backward compatible)\n- Add access scope to GET /Currency/UsdIndirectQuotation (Non-backward compatible)\n- Add access scope to GET /EconomicData/IndicatorList (Non-backward compatible)\n- Add access scope to GET /EconomicData/{indicatorName} (Non-backward compatible)\n- Add access scope to GET /FoodSecurity/List (Non-backward compatible)\n- Add access scope to GET /Gorp/Latest (Non-backward compatible)\n- Add access scope to GET /Gorp/List (Non-backward compatible)\n- Add access scope to GET /MFI/Surveys (Non-backward compatible)\n- Add access scope to GET /MFI/Surveys/ProcessedData (Non-backward compatible)\n- Add access scope to GET /MFI/XlsForms (Non-backward compatible)\n- Add access scope to GET /MarketPrices/Alps (Non-backward compatible)\n- Add access scope to GET /MarketPrices/PriceDaily (Non-backward compatible)\n- Add access scope to GET /MarketPrices/PriceMonthly (Non-backward compatible)\n- Add access scope to GET /MarketPrices/PriceWeekly (Non-backward compatible)\n- Add access scope to GET /Markets/List (Non-backward compatible)\n- Add access scope to GET /Rpme/Surveys (Non-backward compatible)\n- Add access scope to GET /Rpme/Variables (Non-backward compatible)\n- Add access scope to GET /Rpme/XLSForms (Non-backward compatible)\n- Add access scope to GET /Commodities/Categories/List (Non-backward compatible)\n- Add access scope to GET /Commodities/List (Non-backward compatible)\n- Add access scope to GET /CommodityUnits/Conversion/List (Non-backward compatible)\n- Add access scope to GET /CommodityUnits/List (Non-backward compatible)\n- Add access scope to GET /Household/Surveys (Non-backward compatible)\n- Add access scope to GET /Markets/GeoJSONList (Non-backward compatible)\n- Add access scope to GET /Rpme/OutputValues (Non-backward compatible)\n", + "version" : "3.0.0" + }, { + "changes" : "\n*This version is not backward-compatible with previous versions.*\n*What's New*:\n- GET /XlsForms/definition\n*What's Deleted*:\n- GET /MFI/XlsForms/definition\n*What's Changed*:\n- Added _pageSize_ query parameter to GET /Household/DraftInternalBaseData \n- Added _pageSize_ query parameter to GET /Household/FullData \n- Added _pageSize_ query parameter to GET /Household/OfficialUseBaseData \n- Added _pageSize_ query parameter to GET /Household/PublicBaseData \n- Added _pageSize_ query parameter to GET /MFI/Surveys/BaseData \n- Added _pageSize_ query parameter to GET /MFI/Surveys/FullData \n- Added _pageSize_ query parameter to GET /Rpme/BaseData \n- Added _pageSize_ query parameter to GET /Rpme/FullData \n- Added _pageSize_ query parameter to GET /MFI/Surveys/ProcessedData \n- Minor changes to summaries\n", + "version" : "4.0.0" + }, { + "changes" : "\n*What's New*:\n- GET /Aims/DownloadAllAnalysisRounds\n- GET /Aims/DownloadPolygonFiles\n- GET /Gorp/CountryLatest\n- GET /Gorp/RegionalLatest\n- GET /Gorp/GlobalLatest\n*What's Changed*:\n- Minor changes to descriptions\n", + "version" : "4.1.0" + }, { + "changes" : "\n*What's Changed*:\n- Changed response schema and added _apiKey_ query parameter to GET /Household/DraftInternalBaseData (Non-backward compatible)\n- Changed response schema and added _apiKey_ query parameter to GET /Household/FullData (Non-backward compatible)\n- Changed response schema and added _surveyId_ query parameter to GET /Household/Surveys \n- Minor changes to summaries\n", + "version" : "5.0.0" + }, { + "changes" : "\n\n\n*What's New*:\n- GET /MFI/Surveys/ProcessedDataWithKeysetPagination", + "version" : "5.1.0" + } ] +} \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index a4c41e7..29fd210 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "data_bridges_client" -version = "5.0.0" +version = "1.0.0" description = "VAM-Data-Bridges" authors = ["VAM-INFO "] license = "NoLicense" diff --git a/setup.py b/setup.py index df39ad3..8897c28 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.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -22,11 +22,10 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "data-bridges-client" -VERSION = "5.0.0" +VERSION = "1.0.0" PYTHON_REQUIRES = ">=3.7" REQUIRES = [ "urllib3 >= 1.25.3, < 2.1.0", - "httpx", "python-dateutil", "pydantic >= 2", "typing-extensions >= 4.7.1", @@ -48,4 +47,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 +) diff --git a/test/test_bad_request_dto.py b/test/test_bad_request_dto.py index 245fda5..15732b5 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_commodities_api.py b/test/test_commodities_api.py index 3849ebb..3fc986b 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 bdf93e5..c4b8c32 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_commodity_price_dto.py b/test/test_commodity_price_dto.py index fe6e30c..4f0bffc 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_commodity_processing_dto.py b/test/test_commodity_processing_dto.py index 7cbdced..c9ae7ef 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_commodity_quality_dto.py b/test/test_commodity_quality_dto.py index 4933793..542f8aa 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_commodity_units_api.py b/test/test_commodity_units_api.py index 7432f03..cbfa45d 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 0ed0b19..26e6734 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 6059572..3541557 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_economic_data_api.py b/test/test_economic_data_api.py index 7ba73ef..59327ee 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 fbdbfc4..10119d5 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_economic_indicator_property.py b/test/test_economic_indicator_property.py index 31bdb7c..29c70a5 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_economic_indicator_property_paged_result.py b/test/test_economic_indicator_property_paged_result.py index 2031a19..f5d1d03 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_feature.py b/test/test_feature.py index 24d5b15..f72be4b 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_food_security_api.py b/test/test_food_security_api.py index dc82b48..db89166 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 efbaaf4..73d9e71 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_gorp_api.py b/test/test_gorp_api.py index 58af78f..4e5d56f 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_gorp_country_api_dto.py b/test/test_gorp_country_api_dto.py index e62c2ed..35d5acb 100644 --- a/test/test_gorp_country_api_dto.py +++ b/test/test_gorp_country_api_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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_gorp_global_api_dto.py b/test/test_gorp_global_api_dto.py index 53cf365..bac018f 100644 --- a/test/test_gorp_global_api_dto.py +++ b/test/test_gorp_global_api_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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_gorp_regional_api_dto.py b/test/test_gorp_regional_api_dto.py index 6d09b23..a465e99 100644 --- a/test/test_gorp_regional_api_dto.py +++ b/test/test_gorp_regional_api_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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_gorp_value_with_changes.py b/test/test_gorp_value_with_changes.py index 8bb6cb8..b61e400 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_gorp_value_with_changes_paged_result.py b/test/test_gorp_value_with_changes_paged_result.py index 2f06fe0..16c6f35 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_household_survey_list_dto.py b/test/test_household_survey_list_dto.py index df52389..29efc81 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_household_survey_list_dto_paged_result.py b/test/test_household_survey_list_dto_paged_result.py index 19c8ba6..1a40202 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_incubation_api.py b/test/test_incubation_api.py index 77b869f..4a8ba7b 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -76,6 +76,13 @@ def test_household_surveys_get(self) -> None: """ pass + def test_m_fi_surveys_processed_data_with_keyset_pagination_get(self) -> None: + """Test case for m_fi_surveys_processed_data_with_keyset_pagination_get + + Please use this endpoint only for large data retrieval - Response will include only JSON format - 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 + """ + pass + def test_xls_forms_definition_get(self) -> None: """Test case for xls_forms_definition_get diff --git a/test/test_ipc_value.py b/test/test_ipc_value.py index e3331b4..9df2614 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_ipc_value_paged_result.py b/test/test_ipc_value_paged_result.py index c0b936b..32d30ad 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_key_name_dto.py b/test/test_key_name_dto.py index 6680a56..13ed854 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_market_dto.py b/test/test_market_dto.py index 4731783..ad7c2ee 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_market_geo_json_root.py b/test/test_market_geo_json_root.py index babe31d..17bbedc 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_market_prices_api.py b/test/test_market_prices_api.py index d4154e5..8792b6a 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 b19c004..7a988f1 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 b648be2..c96c7c3 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_nearby_markets_dto.py b/test/test_nearby_markets_dto.py index 8e8a75c..45f8ddd 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_paged_commodity_list_dto.py b/test/test_paged_commodity_list_dto.py index db23ee9..9f4275c 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_paged_commodity_price_list_dto.py b/test/test_paged_commodity_price_list_dto.py index 0894952..29be3fe 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) 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 5667a54..9106149 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_paged_currency_list_dto.py b/test/test_paged_currency_list_dto.py index ce6e29b..c7521de 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_paged_economic_data_dto.py b/test/test_paged_economic_data_dto.py index 64e4262..cc7298e 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_paged_market_list_dto.py b/test/test_paged_market_list_dto.py index d8da139..5cd5602 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_paged_processed_data_dto.py b/test/test_paged_processed_data_dto.py index 003da51..d60706a 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -38,6 +38,7 @@ def make_instance(self, include_optional) -> PagedProcessedDataDTO: return PagedProcessedDataDTO( total_items = 56, page = 56, + scroll_id = 56, items = [ { 'key' : null diff --git a/test/test_paged_survey_list_dto.py b/test/test_paged_survey_list_dto.py index 26070b5..9756983 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_paged_survey_responses_dto.py b/test/test_paged_survey_responses_dto.py index 158d80b..6e3d5f8 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_paged_xls_form_list_dto.py b/test/test_paged_xls_form_list_dto.py index 2cf960b..3a6ccfc 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_problem_details.py b/test/test_problem_details.py index 767f4de..f31332a 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_properties.py b/test/test_properties.py index 004dd03..23be47a 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_rpme_api.py b/test/test_rpme_api.py index c3f410a..655e4ca 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 eb55875..6717e2d 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_rpme_assessment_paged_result.py b/test/test_rpme_assessment_paged_result.py index fe218e9..88ecd31 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_rpme_output_values.py b/test/test_rpme_output_values.py index 3de4879..bcb0565 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_rpme_variable.py b/test/test_rpme_variable.py index 974f518..40dbc56 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_rpme_variable_paged_result.py b/test/test_rpme_variable_paged_result.py index e653908..63d8e6a 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_survey_list_dto.py b/test/test_survey_list_dto.py index 9d9f07f..848ba75 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_surveys_api.py b/test/test_surveys_api.py index cadaafb..6ff721d 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: 5.0.0 + The version of the OpenAPI document: 5.1.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 7636bab..ca0d6e3 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_usd_indirect_quotation_paged_result.py b/test/test_usd_indirect_quotation_paged_result.py index 2c53e13..1de68e6 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_view_extended_aggregated_price.py b/test/test_view_extended_aggregated_price.py index f613236..50634e0 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_view_extended_aggregated_price_paged_result.py b/test/test_view_extended_aggregated_price_paged_result.py index e5edb02..225b051 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_view_extended_alps_value.py b/test/test_view_extended_alps_value.py index 3d64d71..bb40c7b 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_view_extended_alps_value_paged_result.py b/test/test_view_extended_alps_value_paged_result.py index d0e7191..9ce6b4b 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_weekly_aggregated_price.py b/test/test_weekly_aggregated_price.py index 4f9067e..77d6546 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_xls_form_definition_new_schema_dto.py b/test/test_xls_form_definition_new_schema_dto.py index 63a2bb6..f4cb9f8 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_xls_form_dto.py b/test/test_xls_form_dto.py index 742d6da..71adf05 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_xls_form_fields_dto.py b/test/test_xls_form_fields_dto.py index f318cfd..3505301 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_xls_form_list_choice_dto.py b/test/test_xls_form_list_choice_dto.py index 20815ab..25b8004 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_xls_form_list_choices_dto.py b/test/test_xls_form_list_choices_dto.py index 787323c..ac3cbde 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_xls_forms_api.py b/test/test_xls_forms_api.py index 27011c2..9f42a13 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: 5.0.0 + The version of the OpenAPI document: 5.1.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) From ff171ce0a329febc659e2596dfc2268dea7af298 Mon Sep 17 00:00:00 2001 From: Alessandra Gherardelli Date: Thu, 12 Dec 2024 12:23:17 +0100 Subject: [PATCH 2/6] docs: update README and setup tools --- README.md | 46 +++++++++++++++------------------------------- pyproject.toml | 2 +- setup.py | 7 ++++--- 3 files changed, 20 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index d34cc04..e7fdc81 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.o This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: 5.1.0 -- Package version: 1.0.0 +- API version: 510.0 +- Package version: 5.1.0 - Generator version: 7.8.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen @@ -53,21 +53,21 @@ Please follow the [installation procedure](#installation--usage) and then run th import data_bridges_client from data_bridges_client.rest import ApiException +from data_bridges_client.token import WfpApiToken from pprint import pprint -# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.1.0 +# 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/5.1.0" + 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"] - +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: @@ -92,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/5.1.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.0.0* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- @@ -105,19 +105,13 @@ Class | Method | HTTP request | Description *EconomicDataApi* | [**economic_data_indicator_list_get**](docs/EconomicDataApi.md#economic_data_indicator_list_get) | **GET** /EconomicData/IndicatorList | Returns the lists of indicators. *EconomicDataApi* | [**economic_data_indicator_name_get**](docs/EconomicDataApi.md#economic_data_indicator_name_get) | **GET** /EconomicData/{indicatorName} | Returns the time series of values for different indicators. *FoodSecurityApi* | [**food_security_list_get**](docs/FoodSecurityApi.md#food_security_list_get) | **GET** /FoodSecurity/List | -*GorpApi* | [**gorp_country_latest_get**](docs/GorpApi.md#gorp_country_latest_get) | **GET** /Gorp/CountryLatest | Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan. -*GorpApi* | [**gorp_global_latest_get**](docs/GorpApi.md#gorp_global_latest_get) | **GET** /Gorp/GlobalLatest | Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. *GorpApi* | [**gorp_latest_get**](docs/GorpApi.md#gorp_latest_get) | **GET** /Gorp/Latest | Return the latest dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. *GorpApi* | [**gorp_list_get**](docs/GorpApi.md#gorp_list_get) | **GET** /Gorp/List | Return the full dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. -*GorpApi* | [**gorp_regional_latest_get**](docs/GorpApi.md#gorp_regional_latest_get) | **GET** /Gorp/RegionalLatest | Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. -*IncubationApi* | [**aims_download_all_analysis_rounds_get**](docs/IncubationApi.md#aims_download_all_analysis_rounds_get) | **GET** /Aims/DownloadAllAnalysisRounds | Each asset has a baseline and several rounds. Each round reflects the number of times the asset has been analysed over time. The number of total rounds changes according to the workstream: Asset Detection (AD) assets can have a total of 5 rounds, while there is no limit to the monitoring of Landscape Impact Assessment (LIA) assets. Assets considered for Site Prioritization (SP) have one round only. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). -*IncubationApi* | [**aims_download_polygon_files_get**](docs/IncubationApi.md#aims_download_polygon_files_get) | **GET** /Aims/DownloadPolygonFiles | Polygon files are available for Landscape Impact Assessment (LIA) assets only. The file name corresponds to the “Geotrace” name. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). -*IncubationApi* | [**household_draft_internal_base_data_get**](docs/IncubationApi.md#household_draft_internal_base_data_get) | **GET** /Household/DraftInternalBaseData | Get data that includes the core household fields only by Survey ID. 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. -*IncubationApi* | [**m_fi_surveys_processed_data_with_keyset_pagination_get**](docs/IncubationApi.md#m_fi_surveys_processed_data_with_keyset_pagination_get) | **GET** /MFI/Surveys/ProcessedDataWithKeysetPagination | Please use this endpoint only for large data retrieval - Response will include only JSON format - 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 *IncubationApi* | [**xls_forms_definition_get**](docs/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. *MarketPricesApi* | [**market_prices_alps_get**](docs/MarketPricesApi.md#market_prices_alps_get) | **GET** /MarketPrices/Alps | Returns time series values of ALPS and PEWI. *MarketPricesApi* | [**market_prices_price_daily_get**](docs/MarketPricesApi.md#market_prices_price_daily_get) | **GET** /MarketPrices/PriceDaily | Returns a daily time series of commodity market prices. @@ -154,9 +148,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) @@ -227,12 +218,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_mfi-surveys-processeddatakeysetpagination_get**: vamdatabridges_mfi-surveys-processeddatakeysetpagination_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 @@ -240,15 +228,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 @@ -261,4 +246,3 @@ Authentication schemes defined for the API: wfp.economicanalysis@wfp.org - diff --git a/pyproject.toml b/pyproject.toml index 29fd210..1bb1a69 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "data_bridges_client" -version = "1.0.0" +version = "5.1.0" description = "VAM-Data-Bridges" authors = ["VAM-INFO "] license = "NoLicense" diff --git a/setup.py b/setup.py index 8897c28..2d3d9e8 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.1.0 + The version of the OpenAPI document: 4.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -22,10 +22,11 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "data-bridges-client" -VERSION = "1.0.0" +VERSION = "5.1.0" 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 6451914ec0287ab6a68e7ddf69c80c384053132b Mon Sep 17 00:00:00 2001 From: Alessandra Gherardelli Date: Thu, 12 Dec 2024 12:56:06 +0100 Subject: [PATCH 3/6] docs: update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e7fdc81..2187846 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ 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/5.1.0" ) configuration.access_token = token.refresh(scopes=SCOPES) From 753e25ed58a07faf3a7687a2e06a3db189941186 Mon Sep 17 00:00:00 2001 From: Alessandra Gherardelli Date: Thu, 12 Dec 2024 12:56:54 +0100 Subject: [PATCH 4/6] docs: update README --- README.md | 2 +- generate/swagger_v5.1.0.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2187846..e7c562e 100644 --- a/README.md +++ b/README.md @@ -92,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/5.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/5.1.0* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- diff --git a/generate/swagger_v5.1.0.json b/generate/swagger_v5.1.0.json index d4a398d..0ff6768 100644 --- a/generate/swagger_v5.1.0.json +++ b/generate/swagger_v5.1.0.json @@ -7221,7 +7221,7 @@ "version" : "4.1.0" }, { "changes" : "\n*What's Changed*:\n- Changed response schema and added _apiKey_ query parameter to GET /Household/DraftInternalBaseData (Non-backward compatible)\n- Changed response schema and added _apiKey_ query parameter to GET /Household/FullData (Non-backward compatible)\n- Changed response schema and added _surveyId_ query parameter to GET /Household/Surveys \n- Minor changes to summaries\n", - "version" : "5.0.0" + "version" : "5.1.0" }, { "changes" : "\n\n\n*What's New*:\n- GET /MFI/Surveys/ProcessedDataWithKeysetPagination", "version" : "5.1.0" From bbe0214b5fcef8dac96b4e10917b802b70b4a25a Mon Sep 17 00:00:00 2001 From: Alessandra Gherardelli Date: Thu, 12 Dec 2024 12:58:32 +0100 Subject: [PATCH 5/6] docs: update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e7c562e..e17a7f4 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,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: 510.0 +- API version: 5.1.0 - Package version: 5.1.0 - Generator version: 7.8.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen From 799b6add5ca487711cb9d2d19659cea17c3a9c0e Mon Sep 17 00:00:00 2001 From: Alessandra Gherardelli Date: Thu, 12 Dec 2024 13:00:19 +0100 Subject: [PATCH 6/6] docs: update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e17a7f4..346e612 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 +pip install git+https://github.com/WFP-VAM/DataBridgesAPI.git@release/v5.1 ``` (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/WFP-VAM/DataBridgesAPI.git`)