diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml index 5d15d99..0055eb6 100644 --- a/.github/workflows/python.yml +++ b/.github/workflows/python.yml @@ -13,7 +13,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - python-version: ["3.9", "3.10", "3.11", "3.12"] + python-version: ["3.10", "3.11", "3.12", "3.13"] steps: - uses: actions/checkout@v3 diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 73b6b1f..10560cd 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -9,9 +9,10 @@ data_bridges_client/api/commodities_api.py data_bridges_client/api/commodity_units_api.py data_bridges_client/api/currency_api.py data_bridges_client/api/economic_data_api.py -data_bridges_client/api/food_security_api.py -data_bridges_client/api/gorp_api.py +data_bridges_client/api/global_outlook_api.py +data_bridges_client/api/hunger_hotspot_api.py data_bridges_client/api/incubation_api.py +data_bridges_client/api/ipcch_api.py data_bridges_client/api/market_prices_api.py data_bridges_client/api/markets_api.py data_bridges_client/api/rpme_api.py @@ -23,6 +24,11 @@ data_bridges_client/configuration.py data_bridges_client/exceptions.py data_bridges_client/models/__init__.py data_bridges_client/models/bad_request_dto.py +data_bridges_client/models/cari_adm0_values_dto.py +data_bridges_client/models/cari_adm0_values_dto_paged_result.py +data_bridges_client/models/cari_adm1_values_dto.py +data_bridges_client/models/cari_adm1_values_dto_paged_result.py +data_bridges_client/models/categories_and_indicators_dto.py data_bridges_client/models/commodity_dto.py data_bridges_client/models/commodity_price_dto.py data_bridges_client/models/commodity_processing_dto.py @@ -31,16 +37,27 @@ data_bridges_client/models/currency_dto.py data_bridges_client/models/economic_data_dto.py data_bridges_client/models/economic_indicator_property.py data_bridges_client/models/economic_indicator_property_paged_result.py +data_bridges_client/models/extended_alps_value_dto.py +data_bridges_client/models/extended_alps_value_dto_paged_result.py data_bridges_client/models/feature.py data_bridges_client/models/geometry.py -data_bridges_client/models/gorp_country_api_dto.py -data_bridges_client/models/gorp_global_api_dto.py -data_bridges_client/models/gorp_regional_api_dto.py +data_bridges_client/models/global_outlook_api_dto.py +data_bridges_client/models/global_outlook_country_api_dto.py +data_bridges_client/models/global_outlook_regional_api_dto.py data_bridges_client/models/household_survey_list_dto.py data_bridges_client/models/household_survey_list_dto_paged_result.py -data_bridges_client/models/ipc_value.py -data_bridges_client/models/ipc_value_paged_result.py +data_bridges_client/models/hunger_hot_spot_data_dto.py +data_bridges_client/models/hunger_hot_spot_data_dto_paged_result.py +data_bridges_client/models/ipc_historical_datum_dto.py +data_bridges_client/models/ipc_historical_datum_dto_paged_result.py +data_bridges_client/models/ipcch_and_equivalent_peaks_dto.py +data_bridges_client/models/ipcch_and_equivalent_peaks_dto_paged_result.py +data_bridges_client/models/ipcch_base_dto.py +data_bridges_client/models/ipcch_base_dto_paged_result.py +data_bridges_client/models/ipcch_peaks_dto.py +data_bridges_client/models/ipcch_peaks_dto_paged_result.py data_bridges_client/models/key_name_dto.py +data_bridges_client/models/list_item_dto.py data_bridges_client/models/market_dto.py data_bridges_client/models/market_geo_json_root.py data_bridges_client/models/mfi_processed_data_dto.py @@ -65,10 +82,8 @@ data_bridges_client/models/rpme_variable_paged_result.py data_bridges_client/models/survey_list_dto.py data_bridges_client/models/usd_indirect_quotation.py data_bridges_client/models/usd_indirect_quotation_paged_result.py -data_bridges_client/models/view_extended_aggregated_price.py -data_bridges_client/models/view_extended_aggregated_price_paged_result.py -data_bridges_client/models/view_extended_alps_value.py -data_bridges_client/models/view_extended_alps_value_paged_result.py +data_bridges_client/models/view_extended_monthly_aggregated_price.py +data_bridges_client/models/view_extended_monthly_aggregated_price_paged_result.py data_bridges_client/models/weekly_aggregated_price.py data_bridges_client/models/xls_form_definition_new_schema_dto.py data_bridges_client/models/xls_form_dto.py @@ -78,6 +93,11 @@ data_bridges_client/models/xls_form_list_choices_dto.py data_bridges_client/py.typed data_bridges_client/rest.py docs/BadRequestDTO.md +docs/CariAdm0ValuesDTO.md +docs/CariAdm0ValuesDTOPagedResult.md +docs/CariAdm1ValuesDTO.md +docs/CariAdm1ValuesDTOPagedResult.md +docs/CategoriesAndIndicatorsDTO.md docs/CommoditiesApi.md docs/CommodityDTO.md docs/CommodityPriceDTO.md @@ -90,19 +110,31 @@ docs/EconomicDataApi.md docs/EconomicDataDTO.md docs/EconomicIndicatorProperty.md docs/EconomicIndicatorPropertyPagedResult.md +docs/ExtendedAlpsValueDto.md +docs/ExtendedAlpsValueDtoPagedResult.md docs/Feature.md -docs/FoodSecurityApi.md docs/Geometry.md -docs/GorpApi.md -docs/GorpCountryApiDto.md -docs/GorpGlobalApiDto.md -docs/GorpRegionalApiDto.md +docs/GlobalOutlookApi.md +docs/GlobalOutlookApiDto.md +docs/GlobalOutlookCountryApiDto.md +docs/GlobalOutlookRegionalApiDto.md docs/HouseholdSurveyListDTO.md docs/HouseholdSurveyListDTOPagedResult.md +docs/HungerHotSpotDataDTO.md +docs/HungerHotSpotDataDTOPagedResult.md +docs/HungerHotspotApi.md docs/IncubationApi.md -docs/IpcValue.md -docs/IpcValuePagedResult.md +docs/IpcHistoricalDatumDto.md +docs/IpcHistoricalDatumDtoPagedResult.md +docs/IpcchAndEquivalentPeaksDTO.md +docs/IpcchAndEquivalentPeaksDTOPagedResult.md +docs/IpcchApi.md +docs/IpcchBaseDto.md +docs/IpcchBaseDtoPagedResult.md +docs/IpcchPeaksDto.md +docs/IpcchPeaksDtoPagedResult.md docs/KeyNameDto.md +docs/ListItemDto.md docs/MFIProcessedDataDTO.md docs/MarketDTO.md docs/MarketGeoJsonRoot.md @@ -131,10 +163,8 @@ docs/SurveyListDTO.md docs/SurveysApi.md docs/UsdIndirectQuotation.md docs/UsdIndirectQuotationPagedResult.md -docs/ViewExtendedAggregatedPrice.md -docs/ViewExtendedAggregatedPricePagedResult.md -docs/ViewExtendedAlpsValue.md -docs/ViewExtendedAlpsValuePagedResult.md +docs/ViewExtendedMonthlyAggregatedPrice.md +docs/ViewExtendedMonthlyAggregatedPricePagedResult.md docs/WeeklyAggregatedPrice.md docs/XlsFormDTO.md docs/XlsFormDefinitionNewSchemaDTO.md @@ -150,6 +180,11 @@ setup.py test-requirements.txt test/__init__.py test/test_bad_request_dto.py +test/test_cari_adm0_values_dto.py +test/test_cari_adm0_values_dto_paged_result.py +test/test_cari_adm1_values_dto.py +test/test_cari_adm1_values_dto_paged_result.py +test/test_categories_and_indicators_dto.py test/test_commodities_api.py test/test_commodity_dto.py test/test_commodity_price_dto.py @@ -162,19 +197,31 @@ test/test_economic_data_api.py test/test_economic_data_dto.py test/test_economic_indicator_property.py test/test_economic_indicator_property_paged_result.py +test/test_extended_alps_value_dto.py +test/test_extended_alps_value_dto_paged_result.py test/test_feature.py -test/test_food_security_api.py test/test_geometry.py -test/test_gorp_api.py -test/test_gorp_country_api_dto.py -test/test_gorp_global_api_dto.py -test/test_gorp_regional_api_dto.py +test/test_global_outlook_api.py +test/test_global_outlook_api_dto.py +test/test_global_outlook_country_api_dto.py +test/test_global_outlook_regional_api_dto.py test/test_household_survey_list_dto.py test/test_household_survey_list_dto_paged_result.py +test/test_hunger_hot_spot_data_dto.py +test/test_hunger_hot_spot_data_dto_paged_result.py +test/test_hunger_hotspot_api.py test/test_incubation_api.py -test/test_ipc_value.py -test/test_ipc_value_paged_result.py +test/test_ipc_historical_datum_dto.py +test/test_ipc_historical_datum_dto_paged_result.py +test/test_ipcch_and_equivalent_peaks_dto.py +test/test_ipcch_and_equivalent_peaks_dto_paged_result.py +test/test_ipcch_api.py +test/test_ipcch_base_dto.py +test/test_ipcch_base_dto_paged_result.py +test/test_ipcch_peaks_dto.py +test/test_ipcch_peaks_dto_paged_result.py test/test_key_name_dto.py +test/test_list_item_dto.py test/test_market_dto.py test/test_market_geo_json_root.py test/test_market_prices_api.py @@ -203,10 +250,8 @@ test/test_survey_list_dto.py test/test_surveys_api.py test/test_usd_indirect_quotation.py test/test_usd_indirect_quotation_paged_result.py -test/test_view_extended_aggregated_price.py -test/test_view_extended_aggregated_price_paged_result.py -test/test_view_extended_alps_value.py -test/test_view_extended_alps_value_paged_result.py +test/test_view_extended_monthly_aggregated_price.py +test/test_view_extended_monthly_aggregated_price_paged_result.py test/test_weekly_aggregated_price.py test/test_xls_form_definition_new_schema_dto.py test/test_xls_form_dto.py diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..29ebfa5 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. \ No newline at end of file diff --git a/README.md b/README.md index 5cf4325..59ff7f9 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: 6.0.0 -- Package version: 6.0.0 -- Generator version: 7.5.0 +- API version: 7.0.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/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.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/6.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/7.0.0* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- @@ -104,15 +104,25 @@ Class | Method | HTTP request | Description *CurrencyApi* | [**currency_usd_indirect_quotation_get**](docs/CurrencyApi.md#currency_usd_indirect_quotation_get) | **GET** /Currency/UsdIndirectQuotation | Returns the value of the Exchange rates from Trading Economics, for official rates, and DataViz for unofficial rates. *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_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. +*GlobalOutlookApi* | [**global_outlook_country_latest_get**](docs/GlobalOutlookApi.md#global_outlook_country_latest_get) | **GET** /GlobalOutlook/CountryLatest | Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP's Global Outlook. +*GlobalOutlookApi* | [**global_outlook_global_latest_get**](docs/GlobalOutlookApi.md#global_outlook_global_latest_get) | **GET** /GlobalOutlook/GlobalLatest | Return the latest global dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. +*GlobalOutlookApi* | [**global_outlook_regional_latest_get**](docs/GlobalOutlookApi.md#global_outlook_regional_latest_get) | **GET** /GlobalOutlook/RegionalLatest | Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. +*HungerHotspotApi* | [**hunger_hotspot_categories_and_indicators_get**](docs/HungerHotspotApi.md#hunger_hotspot_categories_and_indicators_get) | **GET** /HungerHotspot/CategoriesAndIndicators | Retrieves Hunger Hotspot categories and indicators. +*HungerHotspotApi* | [**hunger_hotspot_data_get**](docs/HungerHotspotApi.md#hunger_hotspot_data_get) | **GET** /HungerHotspot/Data | Retrieves a paginated list of Hunger Hotspot data. +*IncubationApi* | [**cari_adm0_values_get**](docs/IncubationApi.md#cari_adm0_values_get) | **GET** /Cari/Adm0Values | Retrieves a paginated list of Adm0 CARI results based on the specified indicator, administrative code, and survey. +*IncubationApi* | [**cari_adm1_values_get**](docs/IncubationApi.md#cari_adm1_values_get) | **GET** /Cari/Adm1Values | Retrieves a paginated list of Adm1 CARI results based on the specified indicator, administrative code, and survey. +*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. +*IpcchApi* | [**ipcch_ipcch_and_equivalent_historical_peaks_get**](docs/IpcchApi.md#ipcch_ipcch_and_equivalent_historical_peaks_get) | **GET** /Ipcch/IPCCHAndEquivalent-HistoricalPeaks | Retrieves a paginated list of historical IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. +*IpcchApi* | [**ipcch_ipcch_and_equivalent_latest_peaks_get**](docs/IpcchApi.md#ipcch_ipcch_and_equivalent_latest_peaks_get) | **GET** /Ipcch/IPCCHAndEquivalent-LatestPeaks | Retrieves a paginated list of the latest IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. +*IpcchApi* | [**ipcch_ipcch_and_equivalent_most_recent_get**](docs/IpcchApi.md#ipcch_ipcch_and_equivalent_most_recent_get) | **GET** /Ipcch/IPCCHAndEquivalent-MostRecent | Retrieves a paginated list of the most recent IPCCH and Equivalent data, optionally filtered by ISO3 country code. +*IpcchApi* | [**ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get**](docs/IpcchApi.md#ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get) | **GET** /Ipcch/IPCCHAndEquivalentPeaks-WFPDashboard | Retrieves a paginated list of IPCCH and Equivalent Peaks data for the WFP Dashboard. +*IpcchApi* | [**ipcch_ipcch_historical_data_get**](docs/IpcchApi.md#ipcch_ipcch_historical_data_get) | **GET** /Ipcch/IPCCH-HistoricalData | Retrieves a paginated list of IPCCH and Equivalent Historical Data. *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. *MarketPricesApi* | [**market_prices_price_monthly_get**](docs/MarketPricesApi.md#market_prices_price_monthly_get) | **GET** /MarketPrices/PriceMonthly | Returns a monthly time series of commodity market prices. @@ -138,6 +148,11 @@ Class | Method | HTTP request | Description ## Documentation For Models - [BadRequestDTO](docs/BadRequestDTO.md) + - [CariAdm0ValuesDTO](docs/CariAdm0ValuesDTO.md) + - [CariAdm0ValuesDTOPagedResult](docs/CariAdm0ValuesDTOPagedResult.md) + - [CariAdm1ValuesDTO](docs/CariAdm1ValuesDTO.md) + - [CariAdm1ValuesDTOPagedResult](docs/CariAdm1ValuesDTOPagedResult.md) + - [CategoriesAndIndicatorsDTO](docs/CategoriesAndIndicatorsDTO.md) - [CommodityDTO](docs/CommodityDTO.md) - [CommodityPriceDTO](docs/CommodityPriceDTO.md) - [CommodityProcessingDTO](docs/CommodityProcessingDTO.md) @@ -146,13 +161,27 @@ Class | Method | HTTP request | Description - [EconomicDataDTO](docs/EconomicDataDTO.md) - [EconomicIndicatorProperty](docs/EconomicIndicatorProperty.md) - [EconomicIndicatorPropertyPagedResult](docs/EconomicIndicatorPropertyPagedResult.md) + - [ExtendedAlpsValueDto](docs/ExtendedAlpsValueDto.md) + - [ExtendedAlpsValueDtoPagedResult](docs/ExtendedAlpsValueDtoPagedResult.md) - [Feature](docs/Feature.md) - [Geometry](docs/Geometry.md) + - [GlobalOutlookApiDto](docs/GlobalOutlookApiDto.md) + - [GlobalOutlookCountryApiDto](docs/GlobalOutlookCountryApiDto.md) + - [GlobalOutlookRegionalApiDto](docs/GlobalOutlookRegionalApiDto.md) - [HouseholdSurveyListDTO](docs/HouseholdSurveyListDTO.md) - [HouseholdSurveyListDTOPagedResult](docs/HouseholdSurveyListDTOPagedResult.md) - - [IpcValue](docs/IpcValue.md) - - [IpcValuePagedResult](docs/IpcValuePagedResult.md) + - [HungerHotSpotDataDTO](docs/HungerHotSpotDataDTO.md) + - [HungerHotSpotDataDTOPagedResult](docs/HungerHotSpotDataDTOPagedResult.md) + - [IpcHistoricalDatumDto](docs/IpcHistoricalDatumDto.md) + - [IpcHistoricalDatumDtoPagedResult](docs/IpcHistoricalDatumDtoPagedResult.md) + - [IpcchAndEquivalentPeaksDTO](docs/IpcchAndEquivalentPeaksDTO.md) + - [IpcchAndEquivalentPeaksDTOPagedResult](docs/IpcchAndEquivalentPeaksDTOPagedResult.md) + - [IpcchBaseDto](docs/IpcchBaseDto.md) + - [IpcchBaseDtoPagedResult](docs/IpcchBaseDtoPagedResult.md) + - [IpcchPeaksDto](docs/IpcchPeaksDto.md) + - [IpcchPeaksDtoPagedResult](docs/IpcchPeaksDtoPagedResult.md) - [KeyNameDto](docs/KeyNameDto.md) + - [ListItemDto](docs/ListItemDto.md) - [MFIProcessedDataDTO](docs/MFIProcessedDataDTO.md) - [MarketDTO](docs/MarketDTO.md) - [MarketGeoJsonRoot](docs/MarketGeoJsonRoot.md) @@ -177,10 +206,8 @@ Class | Method | HTTP request | Description - [SurveyListDTO](docs/SurveyListDTO.md) - [UsdIndirectQuotation](docs/UsdIndirectQuotation.md) - [UsdIndirectQuotationPagedResult](docs/UsdIndirectQuotationPagedResult.md) - - [ViewExtendedAggregatedPrice](docs/ViewExtendedAggregatedPrice.md) - - [ViewExtendedAggregatedPricePagedResult](docs/ViewExtendedAggregatedPricePagedResult.md) - - [ViewExtendedAlpsValue](docs/ViewExtendedAlpsValue.md) - - [ViewExtendedAlpsValuePagedResult](docs/ViewExtendedAlpsValuePagedResult.md) + - [ViewExtendedMonthlyAggregatedPrice](docs/ViewExtendedMonthlyAggregatedPrice.md) + - [ViewExtendedMonthlyAggregatedPricePagedResult](docs/ViewExtendedMonthlyAggregatedPricePagedResult.md) - [WeeklyAggregatedPrice](docs/WeeklyAggregatedPrice.md) - [XlsFormDTO](docs/XlsFormDTO.md) - [XlsFormDefinitionNewSchemaDTO](docs/XlsFormDefinitionNewSchemaDTO.md) @@ -202,10 +229,12 @@ Authentication schemes defined for the API: - **Authorization URL**: https://api.wfp.org/authorize - **Scopes**: - **vamdatabridges_rpme-fulldata_get**: vamdatabridges_rpme-fulldata_get - - **vamdatabridges_foodsecurity-list_get**: vamdatabridges_foodsecurity-list_get + - **vamdatabridges_ipcch-ipcchandequivalent-latestpeaks_get**: vamdatabridges_ipcch-ipcchandequivalent-latestpeaks_get + - **vamdatabridges_ipcch-ipcchandequivalentpeakswfpdashboard_get**: vamdatabridges_ipcch-ipcchandequivalentpeakswfpdashboard_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_globaloutlook-globallatest_get**: vamdatabridges_globaloutlook-globallatest_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 @@ -215,28 +244,36 @@ Authentication schemes defined for the API: - **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_cari-adm1values_get**: vamdatabridges_cari-adm1values_get - **vamdatabridges_household-publicbasedata_get**: vamdatabridges_household-publicbasedata_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_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_globaloutlook-regionallatest_get**: vamdatabridges_globaloutlook-regionallatest_get - **vamdatabridges_household-fulldata_get**: vamdatabridges_household-fulldata_get + - **vamdatabridges_hungerhotspot-categoriesandindicators_get**: vamdatabridges_hungerhotspot-categoriesandindicators_get - **vamdatabridges_household-officialusebasedata_get**: vamdatabridges_household-officialusebasedata_get + - **vamdatabridges_globaloutlook-countrylatest_get**: vamdatabridges_globaloutlook-countrylatest_get - **vamdatabridges_marketprices-pricemonthly_get**: vamdatabridges_marketprices-pricemonthly_get + - **vamdatabridges_ipcch-ipcch-historicaldata_get**: vamdatabridges_ipcch-ipcch-historicaldata_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_ipcch-ipcchandequivalent-historicalpeaks_get**: vamdatabridges_ipcch-ipcchandequivalent-historicalpeaks_get + - **vamdatabridges_ipcch-ipcchandequivalent-mostrecent_get**: vamdatabridges_ipcch-ipcchandequivalent-mostrecent_get - **vamdatabridges_marketprices-priceraw_get**: vamdatabridges_marketprices-priceraw_get - **vamdatabridges_rpme-variables_get**: vamdatabridges_rpme-variables_get - - **vamdatabridges_gorp-latest_get**: vamdatabridges_gorp-latest_get - **vamdatabridges_currency-usdindirectquotation_get**: vamdatabridges_currency-usdindirectquotation_get + - **vamdatabridges_hungerhotspot-data_get**: vamdatabridges_hungerhotspot-data_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_cari-adm0values_get**: vamdatabridges_cari-adm0values_get - **vamdatabridges_rpme-basedata_get**: vamdatabridges_rpme-basedata_get diff --git a/data_bridges_client/__init__.py b/data_bridges_client/__init__.py index c2e6125..6a54a59 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -22,9 +22,10 @@ from data_bridges_client.api.commodity_units_api import CommodityUnitsApi from data_bridges_client.api.currency_api import CurrencyApi from data_bridges_client.api.economic_data_api import EconomicDataApi -from data_bridges_client.api.food_security_api import FoodSecurityApi -from data_bridges_client.api.gorp_api import GorpApi +from data_bridges_client.api.global_outlook_api import GlobalOutlookApi +from data_bridges_client.api.hunger_hotspot_api import HungerHotspotApi from data_bridges_client.api.incubation_api import IncubationApi +from data_bridges_client.api.ipcch_api import IpcchApi from data_bridges_client.api.market_prices_api import MarketPricesApi from data_bridges_client.api.markets_api import MarketsApi from data_bridges_client.api.rpme_api import RpmeApi @@ -44,6 +45,11 @@ # import models into sdk package from data_bridges_client.models.bad_request_dto import BadRequestDTO +from data_bridges_client.models.cari_adm0_values_dto import CariAdm0ValuesDTO +from data_bridges_client.models.cari_adm0_values_dto_paged_result import CariAdm0ValuesDTOPagedResult +from data_bridges_client.models.cari_adm1_values_dto import CariAdm1ValuesDTO +from data_bridges_client.models.cari_adm1_values_dto_paged_result import CariAdm1ValuesDTOPagedResult +from data_bridges_client.models.categories_and_indicators_dto import CategoriesAndIndicatorsDTO from data_bridges_client.models.commodity_dto import CommodityDTO from data_bridges_client.models.commodity_price_dto import CommodityPriceDTO from data_bridges_client.models.commodity_processing_dto import CommodityProcessingDTO @@ -52,16 +58,27 @@ from data_bridges_client.models.economic_data_dto import EconomicDataDTO from data_bridges_client.models.economic_indicator_property import EconomicIndicatorProperty from data_bridges_client.models.economic_indicator_property_paged_result import EconomicIndicatorPropertyPagedResult +from data_bridges_client.models.extended_alps_value_dto import ExtendedAlpsValueDto +from data_bridges_client.models.extended_alps_value_dto_paged_result import ExtendedAlpsValueDtoPagedResult from data_bridges_client.models.feature import Feature from data_bridges_client.models.geometry import Geometry -from data_bridges_client.models.gorp_country_api_dto import GorpCountryApiDto -from data_bridges_client.models.gorp_global_api_dto import GorpGlobalApiDto -from data_bridges_client.models.gorp_regional_api_dto import GorpRegionalApiDto +from data_bridges_client.models.global_outlook_api_dto import GlobalOutlookApiDto +from data_bridges_client.models.global_outlook_country_api_dto import GlobalOutlookCountryApiDto +from data_bridges_client.models.global_outlook_regional_api_dto import GlobalOutlookRegionalApiDto from data_bridges_client.models.household_survey_list_dto import HouseholdSurveyListDTO from data_bridges_client.models.household_survey_list_dto_paged_result import HouseholdSurveyListDTOPagedResult -from data_bridges_client.models.ipc_value import IpcValue -from data_bridges_client.models.ipc_value_paged_result import IpcValuePagedResult +from data_bridges_client.models.hunger_hot_spot_data_dto import HungerHotSpotDataDTO +from data_bridges_client.models.hunger_hot_spot_data_dto_paged_result import HungerHotSpotDataDTOPagedResult +from data_bridges_client.models.ipc_historical_datum_dto import IpcHistoricalDatumDto +from data_bridges_client.models.ipc_historical_datum_dto_paged_result import IpcHistoricalDatumDtoPagedResult +from data_bridges_client.models.ipcch_and_equivalent_peaks_dto import IpcchAndEquivalentPeaksDTO +from data_bridges_client.models.ipcch_and_equivalent_peaks_dto_paged_result import IpcchAndEquivalentPeaksDTOPagedResult +from data_bridges_client.models.ipcch_base_dto import IpcchBaseDto +from data_bridges_client.models.ipcch_base_dto_paged_result import IpcchBaseDtoPagedResult +from data_bridges_client.models.ipcch_peaks_dto import IpcchPeaksDto +from data_bridges_client.models.ipcch_peaks_dto_paged_result import IpcchPeaksDtoPagedResult from data_bridges_client.models.key_name_dto import KeyNameDto +from data_bridges_client.models.list_item_dto import ListItemDto from data_bridges_client.models.mfi_processed_data_dto import MFIProcessedDataDTO from data_bridges_client.models.market_dto import MarketDTO from data_bridges_client.models.market_geo_json_root import MarketGeoJsonRoot @@ -86,10 +103,8 @@ from data_bridges_client.models.survey_list_dto import SurveyListDTO from data_bridges_client.models.usd_indirect_quotation import UsdIndirectQuotation from data_bridges_client.models.usd_indirect_quotation_paged_result import UsdIndirectQuotationPagedResult -from data_bridges_client.models.view_extended_aggregated_price import ViewExtendedAggregatedPrice -from data_bridges_client.models.view_extended_aggregated_price_paged_result import ViewExtendedAggregatedPricePagedResult -from data_bridges_client.models.view_extended_alps_value import ViewExtendedAlpsValue -from data_bridges_client.models.view_extended_alps_value_paged_result import ViewExtendedAlpsValuePagedResult +from data_bridges_client.models.view_extended_monthly_aggregated_price import ViewExtendedMonthlyAggregatedPrice +from data_bridges_client.models.view_extended_monthly_aggregated_price_paged_result import ViewExtendedMonthlyAggregatedPricePagedResult from data_bridges_client.models.weekly_aggregated_price import WeeklyAggregatedPrice from data_bridges_client.models.xls_form_dto import XlsFormDTO from data_bridges_client.models.xls_form_definition_new_schema_dto import XlsFormDefinitionNewSchemaDTO diff --git a/data_bridges_client/api/__init__.py b/data_bridges_client/api/__init__.py index 8f86505..21e5cdf 100644 --- a/data_bridges_client/api/__init__.py +++ b/data_bridges_client/api/__init__.py @@ -5,9 +5,10 @@ from data_bridges_client.api.commodity_units_api import CommodityUnitsApi from data_bridges_client.api.currency_api import CurrencyApi from data_bridges_client.api.economic_data_api import EconomicDataApi -from data_bridges_client.api.food_security_api import FoodSecurityApi -from data_bridges_client.api.gorp_api import GorpApi +from data_bridges_client.api.global_outlook_api import GlobalOutlookApi +from data_bridges_client.api.hunger_hotspot_api import HungerHotspotApi from data_bridges_client.api.incubation_api import IncubationApi +from data_bridges_client.api.ipcch_api import IpcchApi from data_bridges_client.api.market_prices_api import MarketPricesApi from data_bridges_client.api.markets_api import MarketsApi from data_bridges_client.api.rpme_api import RpmeApi diff --git a/data_bridges_client/api/commodities_api.py b/data_bridges_client/api/commodities_api.py index 75ae98a..b94eb8a 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 1b6f92a..664482b 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 e1979e1..82a0875 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 294b39b..8e5862f 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 deleted file mode 100644 index 6012dc0..0000000 --- a/data_bridges_client/api/food_security_api.py +++ /dev/null @@ -1,357 +0,0 @@ -# coding: utf-8 - -""" - VAM-Data-Bridges - - API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern - - The version of the OpenAPI document: 6.0.0 - Contact: wfp.economicanalysis@wfp.org - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - -import warnings -from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt -from typing import Any, Dict, List, Optional, Tuple, Union -from typing_extensions import Annotated - -from pydantic import Field, StrictInt, StrictStr, field_validator -from typing import Optional -from typing_extensions import Annotated -from data_bridges_client.models.ipc_value_paged_result import IpcValuePagedResult - -from data_bridges_client.api_client import ApiClient, RequestSerialized -from data_bridges_client.api_response import ApiResponse -from data_bridges_client.rest import RESTResponseType - - -class FoodSecurityApi: - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None) -> None: - if api_client is None: - api_client = ApiClient.get_default() - self.api_client = api_client - - - @validate_call - def food_security_list_get( - self, - iso3: Annotated[Optional[StrictStr], Field(description="The country ISO3 code")] = None, - year: Optional[StrictInt] = None, - page: Optional[StrictInt] = None, - env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, - _request_timeout: Union[ - None, - 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, - ) -> IpcValuePagedResult: - """food_security_list_get - - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_foodsecurity-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern - - :param iso3: The country ISO3 code - :type iso3: str - :param year: - :type year: int - :param page: - :type page: int - :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org - :type env: str - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._food_security_list_get_serialize( - iso3=iso3, - year=year, - page=page, - env=env, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "IpcValuePagedResult", - '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 food_security_list_get_with_http_info( - self, - iso3: Annotated[Optional[StrictStr], Field(description="The country ISO3 code")] = None, - year: Optional[StrictInt] = None, - page: Optional[StrictInt] = None, - env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, - _request_timeout: Union[ - None, - 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[IpcValuePagedResult]: - """food_security_list_get - - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_foodsecurity-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern - - :param iso3: The country ISO3 code - :type iso3: str - :param year: - :type year: int - :param page: - :type page: int - :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org - :type env: str - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._food_security_list_get_serialize( - iso3=iso3, - year=year, - page=page, - env=env, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "IpcValuePagedResult", - '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 food_security_list_get_without_preload_content( - self, - iso3: Annotated[Optional[StrictStr], Field(description="The country ISO3 code")] = None, - year: Optional[StrictInt] = None, - page: Optional[StrictInt] = None, - env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, - _request_timeout: Union[ - None, - 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: - """food_security_list_get - - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_foodsecurity-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern - - :param iso3: The country ISO3 code - :type iso3: str - :param year: - :type year: int - :param page: - :type page: int - :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org - :type env: str - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._food_security_list_get_serialize( - iso3=iso3, - year=year, - page=page, - env=env, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "IpcValuePagedResult", - '400': "BadRequestDTO", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _food_security_list_get_serialize( - self, - iso3, - year, - page, - 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 iso3 is not None: - - _query_params.append(('iso3', iso3)) - - if year is not None: - - _query_params.append(('year', year)) - - if page is not None: - - _query_params.append(('page', page)) - - 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='/FoodSecurity/List', - path_params=_path_params, - query_params=_query_params, - header_params=_header_params, - body=_body_params, - post_params=_form_params, - files=_files, - auth_settings=_auth_settings, - collection_formats=_collection_formats, - _host=_host, - _request_auth=_request_auth - ) - - diff --git a/data_bridges_client/api/gorp_api.py b/data_bridges_client/api/global_outlook_api.py similarity index 86% rename from data_bridges_client/api/gorp_api.py rename to data_bridges_client/api/global_outlook_api.py index 24e8971..948f144 100644 --- a/data_bridges_client/api/gorp_api.py +++ b/data_bridges_client/api/global_outlook_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -20,16 +20,16 @@ from pydantic import Field, StrictStr, field_validator from typing import List, Optional from typing_extensions import Annotated -from data_bridges_client.models.gorp_country_api_dto import GorpCountryApiDto -from data_bridges_client.models.gorp_global_api_dto import GorpGlobalApiDto -from data_bridges_client.models.gorp_regional_api_dto import GorpRegionalApiDto +from data_bridges_client.models.global_outlook_api_dto import GlobalOutlookApiDto +from data_bridges_client.models.global_outlook_country_api_dto import GlobalOutlookCountryApiDto +from data_bridges_client.models.global_outlook_regional_api_dto import GlobalOutlookRegionalApiDto from data_bridges_client.api_client import ApiClient, RequestSerialized from data_bridges_client.api_response import ApiResponse from data_bridges_client.rest import RESTResponseType -class GorpApi: +class GlobalOutlookApi: """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech @@ -43,7 +43,7 @@ def __init__(self, api_client=None) -> None: @validate_call - def gorp_country_latest_get( + def global_outlook_country_latest_get( self, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ @@ -58,10 +58,10 @@ def gorp_country_latest_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[GorpCountryApiDto]: - """Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan. + ) -> List[GlobalOutlookCountryApiDto]: + """Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP's Global Outlook. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-countrylatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_globaloutlook-countrylatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str @@ -87,7 +87,7 @@ def gorp_country_latest_get( :return: Returns the result object. """ # noqa: E501 - _param = self._gorp_country_latest_get_serialize( + _param = self._global_outlook_country_latest_get_serialize( env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -96,7 +96,7 @@ def gorp_country_latest_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[GorpCountryApiDto]", + '200': "List[GlobalOutlookCountryApiDto]", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -111,7 +111,7 @@ def gorp_country_latest_get( @validate_call - def gorp_country_latest_get_with_http_info( + def global_outlook_country_latest_get_with_http_info( self, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ @@ -126,10 +126,10 @@ def gorp_country_latest_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[GorpCountryApiDto]]: - """Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan. + ) -> ApiResponse[List[GlobalOutlookCountryApiDto]]: + """Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP's Global Outlook. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-countrylatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_globaloutlook-countrylatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str @@ -155,7 +155,7 @@ def gorp_country_latest_get_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._gorp_country_latest_get_serialize( + _param = self._global_outlook_country_latest_get_serialize( env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -164,7 +164,7 @@ def gorp_country_latest_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[GorpCountryApiDto]", + '200': "List[GlobalOutlookCountryApiDto]", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -179,7 +179,7 @@ def gorp_country_latest_get_with_http_info( @validate_call - def gorp_country_latest_get_without_preload_content( + def global_outlook_country_latest_get_without_preload_content( self, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ @@ -195,9 +195,9 @@ def gorp_country_latest_get_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan. + """Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP's Global Outlook. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-countrylatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_globaloutlook-countrylatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str @@ -223,7 +223,7 @@ def gorp_country_latest_get_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._gorp_country_latest_get_serialize( + _param = self._global_outlook_country_latest_get_serialize( env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -232,7 +232,7 @@ def gorp_country_latest_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[GorpCountryApiDto]", + '200': "List[GlobalOutlookCountryApiDto]", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -242,7 +242,7 @@ def gorp_country_latest_get_without_preload_content( return response_data.response - def _gorp_country_latest_get_serialize( + def _global_outlook_country_latest_get_serialize( self, env, _request_auth, @@ -292,7 +292,7 @@ def _gorp_country_latest_get_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/Gorp/CountryLatest', + resource_path='/GlobalOutlook/CountryLatest', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -309,7 +309,7 @@ def _gorp_country_latest_get_serialize( @validate_call - def gorp_global_latest_get( + def global_outlook_global_latest_get( self, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ @@ -324,10 +324,10 @@ def gorp_global_latest_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> GorpGlobalApiDto: - """Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + ) -> GlobalOutlookApiDto: + """Return the latest global dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-globallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_globaloutlook-globallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str @@ -353,7 +353,7 @@ def gorp_global_latest_get( :return: Returns the result object. """ # noqa: E501 - _param = self._gorp_global_latest_get_serialize( + _param = self._global_outlook_global_latest_get_serialize( env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -362,7 +362,7 @@ def gorp_global_latest_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "GorpGlobalApiDto", + '200': "GlobalOutlookApiDto", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -377,7 +377,7 @@ def gorp_global_latest_get( @validate_call - def gorp_global_latest_get_with_http_info( + def global_outlook_global_latest_get_with_http_info( self, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ @@ -392,10 +392,10 @@ def gorp_global_latest_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[GorpGlobalApiDto]: - """Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + ) -> ApiResponse[GlobalOutlookApiDto]: + """Return the latest global dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-globallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_globaloutlook-globallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str @@ -421,7 +421,7 @@ def gorp_global_latest_get_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._gorp_global_latest_get_serialize( + _param = self._global_outlook_global_latest_get_serialize( env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -430,7 +430,7 @@ def gorp_global_latest_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "GorpGlobalApiDto", + '200': "GlobalOutlookApiDto", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -445,7 +445,7 @@ def gorp_global_latest_get_with_http_info( @validate_call - def gorp_global_latest_get_without_preload_content( + def global_outlook_global_latest_get_without_preload_content( self, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ @@ -461,9 +461,9 @@ def gorp_global_latest_get_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + """Return the latest global dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-globallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_globaloutlook-globallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str @@ -489,7 +489,7 @@ def gorp_global_latest_get_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._gorp_global_latest_get_serialize( + _param = self._global_outlook_global_latest_get_serialize( env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -498,7 +498,7 @@ def gorp_global_latest_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "GorpGlobalApiDto", + '200': "GlobalOutlookApiDto", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -508,7 +508,7 @@ def gorp_global_latest_get_without_preload_content( return response_data.response - def _gorp_global_latest_get_serialize( + def _global_outlook_global_latest_get_serialize( self, env, _request_auth, @@ -558,7 +558,7 @@ def _gorp_global_latest_get_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/Gorp/GlobalLatest', + resource_path='/GlobalOutlook/GlobalLatest', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -575,7 +575,7 @@ def _gorp_global_latest_get_serialize( @validate_call - def gorp_regional_latest_get( + def global_outlook_regional_latest_get( self, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ @@ -590,10 +590,10 @@ def gorp_regional_latest_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[GorpRegionalApiDto]: - """Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + ) -> List[GlobalOutlookRegionalApiDto]: + """Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-regionallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_globaloutlook-regionallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str @@ -619,7 +619,7 @@ def gorp_regional_latest_get( :return: Returns the result object. """ # noqa: E501 - _param = self._gorp_regional_latest_get_serialize( + _param = self._global_outlook_regional_latest_get_serialize( env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -628,7 +628,7 @@ def gorp_regional_latest_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[GorpRegionalApiDto]", + '200': "List[GlobalOutlookRegionalApiDto]", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -643,7 +643,7 @@ def gorp_regional_latest_get( @validate_call - def gorp_regional_latest_get_with_http_info( + def global_outlook_regional_latest_get_with_http_info( self, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ @@ -658,10 +658,10 @@ def gorp_regional_latest_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[GorpRegionalApiDto]]: - """Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + ) -> ApiResponse[List[GlobalOutlookRegionalApiDto]]: + """Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-regionallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_globaloutlook-regionallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str @@ -687,7 +687,7 @@ def gorp_regional_latest_get_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._gorp_regional_latest_get_serialize( + _param = self._global_outlook_regional_latest_get_serialize( env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -696,7 +696,7 @@ def gorp_regional_latest_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[GorpRegionalApiDto]", + '200': "List[GlobalOutlookRegionalApiDto]", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -711,7 +711,7 @@ def gorp_regional_latest_get_with_http_info( @validate_call - def gorp_regional_latest_get_without_preload_content( + def global_outlook_regional_latest_get_without_preload_content( self, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ @@ -727,9 +727,9 @@ def gorp_regional_latest_get_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + """Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-regionallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_globaloutlook-regionallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str @@ -755,7 +755,7 @@ def gorp_regional_latest_get_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._gorp_regional_latest_get_serialize( + _param = self._global_outlook_regional_latest_get_serialize( env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -764,7 +764,7 @@ def gorp_regional_latest_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[GorpRegionalApiDto]", + '200': "List[GlobalOutlookRegionalApiDto]", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -774,7 +774,7 @@ def gorp_regional_latest_get_without_preload_content( return response_data.response - def _gorp_regional_latest_get_serialize( + def _global_outlook_regional_latest_get_serialize( self, env, _request_auth, @@ -824,7 +824,7 @@ def _gorp_regional_latest_get_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/Gorp/RegionalLatest', + resource_path='/GlobalOutlook/RegionalLatest', path_params=_path_params, query_params=_query_params, header_params=_header_params, diff --git a/data_bridges_client/api/hunger_hotspot_api.py b/data_bridges_client/api/hunger_hotspot_api.py new file mode 100644 index 0000000..246fe7b --- /dev/null +++ b/data_bridges_client/api/hunger_hotspot_api.py @@ -0,0 +1,590 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import Optional +from typing_extensions import Annotated +from data_bridges_client.models.categories_and_indicators_dto import CategoriesAndIndicatorsDTO +from data_bridges_client.models.hunger_hot_spot_data_dto_paged_result import HungerHotSpotDataDTOPagedResult + +from data_bridges_client.api_client import ApiClient, RequestSerialized +from data_bridges_client.api_response import ApiResponse +from data_bridges_client.rest import RESTResponseType + + +class HungerHotspotApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def hunger_hotspot_categories_and_indicators_get( + self, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CategoriesAndIndicatorsDTO: + """Retrieves Hunger Hotspot categories and indicators. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_hungerhotspot-categoriesandindicators_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._hunger_hotspot_categories_and_indicators_get_serialize( + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CategoriesAndIndicatorsDTO", + '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 hunger_hotspot_categories_and_indicators_get_with_http_info( + self, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CategoriesAndIndicatorsDTO]: + """Retrieves Hunger Hotspot categories and indicators. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_hungerhotspot-categoriesandindicators_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._hunger_hotspot_categories_and_indicators_get_serialize( + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CategoriesAndIndicatorsDTO", + '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 hunger_hotspot_categories_and_indicators_get_without_preload_content( + self, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieves Hunger Hotspot categories and indicators. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_hungerhotspot-categoriesandindicators_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._hunger_hotspot_categories_and_indicators_get_serialize( + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CategoriesAndIndicatorsDTO", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _hunger_hotspot_categories_and_indicators_get_serialize( + self, + env, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if env is not None: + + _query_params.append(('env', env)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'text/plain', + 'application/json', + 'text/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'default' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/HungerHotspot/CategoriesAndIndicators', + 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 hunger_hotspot_data_get( + self, + page: Annotated[Optional[StrictInt], Field(description="The page number for pagination. Defaults to 1.")] = 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, + ) -> HungerHotSpotDataDTOPagedResult: + """Retrieves a paginated list of Hunger Hotspot data. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_hungerhotspot-data_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param page: The page number for pagination. Defaults to 1. + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._hunger_hotspot_data_get_serialize( + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "HungerHotSpotDataDTOPagedResult", + '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 hunger_hotspot_data_get_with_http_info( + self, + page: Annotated[Optional[StrictInt], Field(description="The page number for pagination. Defaults to 1.")] = 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[HungerHotSpotDataDTOPagedResult]: + """Retrieves a paginated list of Hunger Hotspot data. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_hungerhotspot-data_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param page: The page number for pagination. Defaults to 1. + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._hunger_hotspot_data_get_serialize( + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "HungerHotSpotDataDTOPagedResult", + '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 hunger_hotspot_data_get_without_preload_content( + self, + page: Annotated[Optional[StrictInt], Field(description="The page number for pagination. Defaults to 1.")] = 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: + """Retrieves a paginated list of Hunger Hotspot data. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_hungerhotspot-data_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param page: The page number for pagination. Defaults to 1. + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._hunger_hotspot_data_get_serialize( + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "HungerHotSpotDataDTOPagedResult", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _hunger_hotspot_data_get_serialize( + self, + page, + 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 page is not None: + + _query_params.append(('page', page)) + + 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='/HungerHotspot/Data', + 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 + ) + + diff --git a/data_bridges_client/api/incubation_api.py b/data_bridges_client/api/incubation_api.py index db26220..5685b37 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -21,6 +21,8 @@ from pydantic import Field, StrictInt, StrictStr, field_validator from typing import List, Optional from typing_extensions import Annotated +from data_bridges_client.models.cari_adm0_values_dto_paged_result import CariAdm0ValuesDTOPagedResult +from data_bridges_client.models.cari_adm1_values_dto_paged_result import CariAdm1ValuesDTOPagedResult 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 @@ -45,9 +47,12 @@ def __init__(self, api_client=None) -> None: @validate_call - def aims_download_all_analysis_rounds_get( + def cari_adm0_values_get( self, - adm0_code: Annotated[StrictInt, Field(description="The country adm0Code")], + adm0_code: Annotated[Optional[StrictInt], Field(description="The administrative level 0 code to filter the results.")] = None, + survey_id: Annotated[Optional[StrictInt], Field(description="The unique identifier of the survey to filter the results.")] = None, + indicator_id: Annotated[Optional[StrictInt], Field(description="The unique identifier of the indicator to filter the results.")] = None, + page: Annotated[Optional[StrictInt], Field(description="The page number for pagination. Defaults to 1.")] = None, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ None, @@ -61,13 +66,19 @@ def aims_download_all_analysis_rounds_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> None: - """Each asset has a baseline and several rounds. Each round reflects the number of times the asset has been analysed over time. The number of total rounds changes according to the workstream: Asset Detection (AD) assets can have a total of 5 rounds, while there is no limit to the monitoring of Landscape Impact Assessment (LIA) assets. Assets considered for Site Prioritization (SP) have one round only. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). + ) -> CariAdm0ValuesDTOPagedResult: + """Retrieves a paginated list of Adm0 CARI results based on the specified indicator, administrative code, and survey. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadallanalysisrounds_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![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_cari-adm0values_get\" This method returns a paginated list of results based on the provided filters. Ensure that the parameters are valid and correspond to existing data in the repository. If an error occurs during processing, a bad request response is returned with the error details. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern - :param adm0_code: The country adm0Code (required) + :param adm0_code: The administrative level 0 code to filter the results. :type adm0_code: int + :param survey_id: The unique identifier of the survey to filter the results. + :type survey_id: int + :param indicator_id: The unique identifier of the indicator to filter the results. + :type indicator_id: int + :param page: The page number for pagination. Defaults to 1. + :type page: int :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str :param _request_timeout: timeout setting for this request. If one @@ -92,8 +103,11 @@ def aims_download_all_analysis_rounds_get( :return: Returns the result object. """ # noqa: E501 - _param = self._aims_download_all_analysis_rounds_get_serialize( + _param = self._cari_adm0_values_get_serialize( adm0_code=adm0_code, + survey_id=survey_id, + indicator_id=indicator_id, + page=page, env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -102,7 +116,8 @@ def aims_download_all_analysis_rounds_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "CariAdm0ValuesDTOPagedResult", + '400': "BadRequestDTO", } response_data = self.api_client.call_api( *_param, @@ -116,9 +131,12 @@ def aims_download_all_analysis_rounds_get( @validate_call - def aims_download_all_analysis_rounds_get_with_http_info( + def cari_adm0_values_get_with_http_info( self, - adm0_code: Annotated[StrictInt, Field(description="The country adm0Code")], + adm0_code: Annotated[Optional[StrictInt], Field(description="The administrative level 0 code to filter the results.")] = None, + survey_id: Annotated[Optional[StrictInt], Field(description="The unique identifier of the survey to filter the results.")] = None, + indicator_id: Annotated[Optional[StrictInt], Field(description="The unique identifier of the indicator to filter the results.")] = None, + page: Annotated[Optional[StrictInt], Field(description="The page number for pagination. Defaults to 1.")] = None, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ None, @@ -132,13 +150,19 @@ def aims_download_all_analysis_rounds_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[None]: - """Each asset has a baseline and several rounds. Each round reflects the number of times the asset has been analysed over time. The number of total rounds changes according to the workstream: Asset Detection (AD) assets can have a total of 5 rounds, while there is no limit to the monitoring of Landscape Impact Assessment (LIA) assets. Assets considered for Site Prioritization (SP) have one round only. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). + ) -> ApiResponse[CariAdm0ValuesDTOPagedResult]: + """Retrieves a paginated list of Adm0 CARI results based on the specified indicator, administrative code, and survey. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadallanalysisrounds_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![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_cari-adm0values_get\" This method returns a paginated list of results based on the provided filters. Ensure that the parameters are valid and correspond to existing data in the repository. If an error occurs during processing, a bad request response is returned with the error details. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern - :param adm0_code: The country adm0Code (required) + :param adm0_code: The administrative level 0 code to filter the results. :type adm0_code: int + :param survey_id: The unique identifier of the survey to filter the results. + :type survey_id: int + :param indicator_id: The unique identifier of the indicator to filter the results. + :type indicator_id: int + :param page: The page number for pagination. Defaults to 1. + :type page: int :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str :param _request_timeout: timeout setting for this request. If one @@ -163,8 +187,11 @@ def aims_download_all_analysis_rounds_get_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._aims_download_all_analysis_rounds_get_serialize( + _param = self._cari_adm0_values_get_serialize( adm0_code=adm0_code, + survey_id=survey_id, + indicator_id=indicator_id, + page=page, env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -173,7 +200,8 @@ def aims_download_all_analysis_rounds_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "CariAdm0ValuesDTOPagedResult", + '400': "BadRequestDTO", } response_data = self.api_client.call_api( *_param, @@ -187,9 +215,12 @@ def aims_download_all_analysis_rounds_get_with_http_info( @validate_call - def aims_download_all_analysis_rounds_get_without_preload_content( + def cari_adm0_values_get_without_preload_content( self, - adm0_code: Annotated[StrictInt, Field(description="The country adm0Code")], + adm0_code: Annotated[Optional[StrictInt], Field(description="The administrative level 0 code to filter the results.")] = None, + survey_id: Annotated[Optional[StrictInt], Field(description="The unique identifier of the survey to filter the results.")] = None, + indicator_id: Annotated[Optional[StrictInt], Field(description="The unique identifier of the indicator to filter the results.")] = None, + page: Annotated[Optional[StrictInt], Field(description="The page number for pagination. Defaults to 1.")] = None, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ None, @@ -204,12 +235,18 @@ def aims_download_all_analysis_rounds_get_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Each asset has a baseline and several rounds. Each round reflects the number of times the asset has been analysed over time. The number of total rounds changes according to the workstream: Asset Detection (AD) assets can have a total of 5 rounds, while there is no limit to the monitoring of Landscape Impact Assessment (LIA) assets. Assets considered for Site Prioritization (SP) have one round only. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). + """Retrieves a paginated list of Adm0 CARI results based on the specified indicator, administrative code, and survey. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadallanalysisrounds_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![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_cari-adm0values_get\" This method returns a paginated list of results based on the provided filters. Ensure that the parameters are valid and correspond to existing data in the repository. If an error occurs during processing, a bad request response is returned with the error details. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern - :param adm0_code: The country adm0Code (required) + :param adm0_code: The administrative level 0 code to filter the results. :type adm0_code: int + :param survey_id: The unique identifier of the survey to filter the results. + :type survey_id: int + :param indicator_id: The unique identifier of the indicator to filter the results. + :type indicator_id: int + :param page: The page number for pagination. Defaults to 1. + :type page: int :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str :param _request_timeout: timeout setting for this request. If one @@ -234,8 +271,11 @@ def aims_download_all_analysis_rounds_get_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._aims_download_all_analysis_rounds_get_serialize( + _param = self._cari_adm0_values_get_serialize( adm0_code=adm0_code, + survey_id=survey_id, + indicator_id=indicator_id, + page=page, env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -244,7 +284,8 @@ def aims_download_all_analysis_rounds_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "CariAdm0ValuesDTOPagedResult", + '400': "BadRequestDTO", } response_data = self.api_client.call_api( *_param, @@ -253,9 +294,12 @@ def aims_download_all_analysis_rounds_get_without_preload_content( return response_data.response - def _aims_download_all_analysis_rounds_get_serialize( + def _cari_adm0_values_get_serialize( self, adm0_code, + survey_id, + indicator_id, + page, env, _request_auth, _content_type, @@ -281,6 +325,18 @@ def _aims_download_all_analysis_rounds_get_serialize( _query_params.append(('adm0Code', adm0_code)) + if survey_id is not None: + + _query_params.append(('surveyId', survey_id)) + + if indicator_id is not None: + + _query_params.append(('indicatorId', indicator_id)) + + if page is not None: + + _query_params.append(('page', page)) + if env is not None: _query_params.append(('env', env)) @@ -290,6 +346,15 @@ def _aims_download_all_analysis_rounds_get_serialize( # 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 @@ -299,7 +364,7 @@ def _aims_download_all_analysis_rounds_get_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/Aims/DownloadAllAnalysisRounds', + resource_path='/Cari/Adm0Values', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -316,9 +381,12 @@ def _aims_download_all_analysis_rounds_get_serialize( @validate_call - def aims_download_polygon_files_get( + def cari_adm1_values_get( self, - adm0_code: Annotated[StrictInt, Field(description="The country adm0Code")], + adm0_code: Annotated[Optional[StrictInt], Field(description="The administrative level 0 code to filter the results.")] = None, + survey_id: Annotated[Optional[StrictInt], Field(description="The unique identifier of the survey to filter the results.")] = None, + indicator_id: Annotated[Optional[StrictInt], Field(description="The unique identifier of the indicator to filter the results.")] = None, + page: Annotated[Optional[StrictInt], Field(description="The page number for pagination. Defaults to 1.")] = None, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ None, @@ -332,13 +400,19 @@ def aims_download_polygon_files_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> None: - """Polygon files are available for Landscape Impact Assessment (LIA) assets only. The file name corresponds to the “Geotrace” name. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). + ) -> CariAdm1ValuesDTOPagedResult: + """Retrieves a paginated list of Adm1 CARI results based on the specified indicator, administrative code, and survey. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadpolygonfiles_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![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_cari-adm1values_get\" This method returns a paginated list of results based on the provided filters. Ensure that the parameters are valid and correspond to existing data in the repository. If an error occurs during processing, a bad request response is returned with the error details. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern - :param adm0_code: The country adm0Code (required) + :param adm0_code: The administrative level 0 code to filter the results. :type adm0_code: int + :param survey_id: The unique identifier of the survey to filter the results. + :type survey_id: int + :param indicator_id: The unique identifier of the indicator to filter the results. + :type indicator_id: int + :param page: The page number for pagination. Defaults to 1. + :type page: int :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str :param _request_timeout: timeout setting for this request. If one @@ -363,8 +437,11 @@ def aims_download_polygon_files_get( :return: Returns the result object. """ # noqa: E501 - _param = self._aims_download_polygon_files_get_serialize( + _param = self._cari_adm1_values_get_serialize( adm0_code=adm0_code, + survey_id=survey_id, + indicator_id=indicator_id, + page=page, env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -373,7 +450,8 @@ def aims_download_polygon_files_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "CariAdm1ValuesDTOPagedResult", + '400': "BadRequestDTO", } response_data = self.api_client.call_api( *_param, @@ -387,9 +465,12 @@ def aims_download_polygon_files_get( @validate_call - def aims_download_polygon_files_get_with_http_info( + def cari_adm1_values_get_with_http_info( self, - adm0_code: Annotated[StrictInt, Field(description="The country adm0Code")], + adm0_code: Annotated[Optional[StrictInt], Field(description="The administrative level 0 code to filter the results.")] = None, + survey_id: Annotated[Optional[StrictInt], Field(description="The unique identifier of the survey to filter the results.")] = None, + indicator_id: Annotated[Optional[StrictInt], Field(description="The unique identifier of the indicator to filter the results.")] = None, + page: Annotated[Optional[StrictInt], Field(description="The page number for pagination. Defaults to 1.")] = None, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ None, @@ -403,13 +484,19 @@ def aims_download_polygon_files_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[None]: - """Polygon files are available for Landscape Impact Assessment (LIA) assets only. The file name corresponds to the “Geotrace” name. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). + ) -> ApiResponse[CariAdm1ValuesDTOPagedResult]: + """Retrieves a paginated list of Adm1 CARI results based on the specified indicator, administrative code, and survey. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadpolygonfiles_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![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_cari-adm1values_get\" This method returns a paginated list of results based on the provided filters. Ensure that the parameters are valid and correspond to existing data in the repository. If an error occurs during processing, a bad request response is returned with the error details. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern - :param adm0_code: The country adm0Code (required) + :param adm0_code: The administrative level 0 code to filter the results. :type adm0_code: int + :param survey_id: The unique identifier of the survey to filter the results. + :type survey_id: int + :param indicator_id: The unique identifier of the indicator to filter the results. + :type indicator_id: int + :param page: The page number for pagination. Defaults to 1. + :type page: int :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str :param _request_timeout: timeout setting for this request. If one @@ -434,8 +521,11 @@ def aims_download_polygon_files_get_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._aims_download_polygon_files_get_serialize( + _param = self._cari_adm1_values_get_serialize( adm0_code=adm0_code, + survey_id=survey_id, + indicator_id=indicator_id, + page=page, env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -444,7 +534,8 @@ def aims_download_polygon_files_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "CariAdm1ValuesDTOPagedResult", + '400': "BadRequestDTO", } response_data = self.api_client.call_api( *_param, @@ -458,9 +549,12 @@ def aims_download_polygon_files_get_with_http_info( @validate_call - def aims_download_polygon_files_get_without_preload_content( + def cari_adm1_values_get_without_preload_content( self, - adm0_code: Annotated[StrictInt, Field(description="The country adm0Code")], + adm0_code: Annotated[Optional[StrictInt], Field(description="The administrative level 0 code to filter the results.")] = None, + survey_id: Annotated[Optional[StrictInt], Field(description="The unique identifier of the survey to filter the results.")] = None, + indicator_id: Annotated[Optional[StrictInt], Field(description="The unique identifier of the indicator to filter the results.")] = None, + page: Annotated[Optional[StrictInt], Field(description="The page number for pagination. Defaults to 1.")] = None, env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, _request_timeout: Union[ None, @@ -475,12 +569,18 @@ def aims_download_polygon_files_get_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Polygon files are available for Landscape Impact Assessment (LIA) assets only. The file name corresponds to the “Geotrace” name. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). + """Retrieves a paginated list of Adm1 CARI results based on the specified indicator, administrative code, and survey. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadpolygonfiles_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![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_cari-adm1values_get\" This method returns a paginated list of results based on the provided filters. Ensure that the parameters are valid and correspond to existing data in the repository. If an error occurs during processing, a bad request response is returned with the error details. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern - :param adm0_code: The country adm0Code (required) + :param adm0_code: The administrative level 0 code to filter the results. :type adm0_code: int + :param survey_id: The unique identifier of the survey to filter the results. + :type survey_id: int + :param indicator_id: The unique identifier of the indicator to filter the results. + :type indicator_id: int + :param page: The page number for pagination. Defaults to 1. + :type page: int :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org :type env: str :param _request_timeout: timeout setting for this request. If one @@ -505,8 +605,11 @@ def aims_download_polygon_files_get_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._aims_download_polygon_files_get_serialize( + _param = self._cari_adm1_values_get_serialize( adm0_code=adm0_code, + survey_id=survey_id, + indicator_id=indicator_id, + page=page, env=env, _request_auth=_request_auth, _content_type=_content_type, @@ -515,7 +618,8 @@ def aims_download_polygon_files_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "CariAdm1ValuesDTOPagedResult", + '400': "BadRequestDTO", } response_data = self.api_client.call_api( *_param, @@ -524,9 +628,12 @@ def aims_download_polygon_files_get_without_preload_content( return response_data.response - def _aims_download_polygon_files_get_serialize( + def _cari_adm1_values_get_serialize( self, adm0_code, + survey_id, + indicator_id, + page, env, _request_auth, _content_type, @@ -552,6 +659,18 @@ def _aims_download_polygon_files_get_serialize( _query_params.append(('adm0Code', adm0_code)) + if survey_id is not None: + + _query_params.append(('surveyId', survey_id)) + + if indicator_id is not None: + + _query_params.append(('indicatorId', indicator_id)) + + if page is not None: + + _query_params.append(('page', page)) + if env is not None: _query_params.append(('env', env)) @@ -561,6 +680,15 @@ def _aims_download_polygon_files_get_serialize( # 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 @@ -570,7 +698,7 @@ def _aims_download_polygon_files_get_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/Aims/DownloadPolygonFiles', + resource_path='/Cari/Adm1Values', path_params=_path_params, query_params=_query_params, header_params=_header_params, diff --git a/data_bridges_client/api/ipcch_api.py b/data_bridges_client/api/ipcch_api.py new file mode 100644 index 0000000..2341e05 --- /dev/null +++ b/data_bridges_client/api/ipcch_api.py @@ -0,0 +1,1613 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from datetime import datetime +from pydantic import Field, StrictInt, StrictStr, field_validator +from typing import Optional +from typing_extensions import Annotated +from data_bridges_client.models.ipc_historical_datum_dto_paged_result import IpcHistoricalDatumDtoPagedResult +from data_bridges_client.models.ipcch_and_equivalent_peaks_dto_paged_result import IpcchAndEquivalentPeaksDTOPagedResult +from data_bridges_client.models.ipcch_base_dto_paged_result import IpcchBaseDtoPagedResult +from data_bridges_client.models.ipcch_peaks_dto_paged_result import IpcchPeaksDtoPagedResult + +from data_bridges_client.api_client import ApiClient, RequestSerialized +from data_bridges_client.api_response import ApiResponse +from data_bridges_client.rest import RESTResponseType + + +class IpcchApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def ipcch_ipcch_and_equivalent_historical_peaks_get( + self, + reference_year: Annotated[Optional[StrictInt], Field(description="Year in a 4 digit format, for example: 2025")] = None, + iso3: Optional[StrictStr] = None, + page: Optional[StrictInt] = None, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + 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, + ) -> IpcchPeaksDtoPagedResult: + """Retrieves a paginated list of historical IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalent-historicalpeaks_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param reference_year: Year in a 4 digit format, for example: 2025 + :type reference_year: int + :param iso3: + :type iso3: str + :param page: + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_and_equivalent_historical_peaks_get_serialize( + reference_year=reference_year, + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcchPeaksDtoPagedResult", + '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 ipcch_ipcch_and_equivalent_historical_peaks_get_with_http_info( + self, + reference_year: Annotated[Optional[StrictInt], Field(description="Year in a 4 digit format, for example: 2025")] = None, + iso3: Optional[StrictStr] = None, + page: Optional[StrictInt] = None, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + 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[IpcchPeaksDtoPagedResult]: + """Retrieves a paginated list of historical IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalent-historicalpeaks_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param reference_year: Year in a 4 digit format, for example: 2025 + :type reference_year: int + :param iso3: + :type iso3: str + :param page: + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_and_equivalent_historical_peaks_get_serialize( + reference_year=reference_year, + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcchPeaksDtoPagedResult", + '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 ipcch_ipcch_and_equivalent_historical_peaks_get_without_preload_content( + self, + reference_year: Annotated[Optional[StrictInt], Field(description="Year in a 4 digit format, for example: 2025")] = None, + iso3: Optional[StrictStr] = None, + page: Optional[StrictInt] = None, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + 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: + """Retrieves a paginated list of historical IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalent-historicalpeaks_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param reference_year: Year in a 4 digit format, for example: 2025 + :type reference_year: int + :param iso3: + :type iso3: str + :param page: + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_and_equivalent_historical_peaks_get_serialize( + reference_year=reference_year, + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcchPeaksDtoPagedResult", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ipcch_ipcch_and_equivalent_historical_peaks_get_serialize( + self, + reference_year, + iso3, + page, + 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 reference_year is not None: + + _query_params.append(('referenceYear', reference_year)) + + if iso3 is not None: + + _query_params.append(('iso3', iso3)) + + if page is not None: + + _query_params.append(('page', page)) + + 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='/Ipcch/IPCCHAndEquivalent-HistoricalPeaks', + 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 ipcch_ipcch_and_equivalent_latest_peaks_get( + self, + iso3: Optional[StrictStr] = None, + page: Optional[StrictInt] = None, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + 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, + ) -> IpcchPeaksDtoPagedResult: + """Retrieves a paginated list of the latest IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalent-latestpeaks_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param iso3: + :type iso3: str + :param page: + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_and_equivalent_latest_peaks_get_serialize( + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcchPeaksDtoPagedResult", + '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 ipcch_ipcch_and_equivalent_latest_peaks_get_with_http_info( + self, + iso3: Optional[StrictStr] = None, + page: Optional[StrictInt] = None, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + 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[IpcchPeaksDtoPagedResult]: + """Retrieves a paginated list of the latest IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalent-latestpeaks_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param iso3: + :type iso3: str + :param page: + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_and_equivalent_latest_peaks_get_serialize( + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcchPeaksDtoPagedResult", + '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 ipcch_ipcch_and_equivalent_latest_peaks_get_without_preload_content( + self, + iso3: Optional[StrictStr] = None, + page: Optional[StrictInt] = None, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + 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: + """Retrieves a paginated list of the latest IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalent-latestpeaks_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param iso3: + :type iso3: str + :param page: + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_and_equivalent_latest_peaks_get_serialize( + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcchPeaksDtoPagedResult", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ipcch_ipcch_and_equivalent_latest_peaks_get_serialize( + self, + iso3, + page, + 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 iso3 is not None: + + _query_params.append(('iso3', iso3)) + + if page is not None: + + _query_params.append(('page', page)) + + 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='/Ipcch/IPCCHAndEquivalent-LatestPeaks', + 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 ipcch_ipcch_and_equivalent_most_recent_get( + self, + iso3: Optional[StrictStr] = None, + page: Optional[StrictInt] = None, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + 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, + ) -> IpcchBaseDtoPagedResult: + """Retrieves a paginated list of the most recent IPCCH and Equivalent data, optionally filtered by ISO3 country code. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalent-mostrecent_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param iso3: + :type iso3: str + :param page: + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_and_equivalent_most_recent_get_serialize( + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcchBaseDtoPagedResult", + '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 ipcch_ipcch_and_equivalent_most_recent_get_with_http_info( + self, + iso3: Optional[StrictStr] = None, + page: Optional[StrictInt] = None, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + 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[IpcchBaseDtoPagedResult]: + """Retrieves a paginated list of the most recent IPCCH and Equivalent data, optionally filtered by ISO3 country code. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalent-mostrecent_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param iso3: + :type iso3: str + :param page: + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_and_equivalent_most_recent_get_serialize( + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcchBaseDtoPagedResult", + '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 ipcch_ipcch_and_equivalent_most_recent_get_without_preload_content( + self, + iso3: Optional[StrictStr] = None, + page: Optional[StrictInt] = None, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + 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: + """Retrieves a paginated list of the most recent IPCCH and Equivalent data, optionally filtered by ISO3 country code. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalent-mostrecent_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param iso3: + :type iso3: str + :param page: + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_and_equivalent_most_recent_get_serialize( + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcchBaseDtoPagedResult", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ipcch_ipcch_and_equivalent_most_recent_get_serialize( + self, + iso3, + page, + 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 iso3 is not None: + + _query_params.append(('iso3', iso3)) + + if page is not None: + + _query_params.append(('page', page)) + + 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='/Ipcch/IPCCHAndEquivalent-MostRecent', + 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 ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get( + self, + iso3: Optional[StrictStr] = None, + page: Annotated[Optional[StrictInt], Field(description="The page number for pagination. Defaults to 1.")] = 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, + ) -> IpcchAndEquivalentPeaksDTOPagedResult: + """Retrieves a paginated list of IPCCH and Equivalent Peaks data for the WFP Dashboard. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalentpeakswfpdashboard_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param iso3: + :type iso3: str + :param page: The page number for pagination. Defaults to 1. + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get_serialize( + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcchAndEquivalentPeaksDTOPagedResult", + '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 ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get_with_http_info( + self, + iso3: Optional[StrictStr] = None, + page: Annotated[Optional[StrictInt], Field(description="The page number for pagination. Defaults to 1.")] = 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[IpcchAndEquivalentPeaksDTOPagedResult]: + """Retrieves a paginated list of IPCCH and Equivalent Peaks data for the WFP Dashboard. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalentpeakswfpdashboard_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param iso3: + :type iso3: str + :param page: The page number for pagination. Defaults to 1. + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get_serialize( + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcchAndEquivalentPeaksDTOPagedResult", + '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 ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get_without_preload_content( + self, + iso3: Optional[StrictStr] = None, + page: Annotated[Optional[StrictInt], Field(description="The page number for pagination. Defaults to 1.")] = 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: + """Retrieves a paginated list of IPCCH and Equivalent Peaks data for the WFP Dashboard. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalentpeakswfpdashboard_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param iso3: + :type iso3: str + :param page: The page number for pagination. Defaults to 1. + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get_serialize( + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcchAndEquivalentPeaksDTOPagedResult", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get_serialize( + self, + iso3, + page, + 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 iso3 is not None: + + _query_params.append(('iso3', iso3)) + + if page is not None: + + _query_params.append(('page', page)) + + 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='/Ipcch/IPCCHAndEquivalentPeaks-WFPDashboard', + 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 ipcch_ipcch_historical_data_get( + self, + from_date: Annotated[Optional[datetime], Field(description="Date in the format yyyy-mm-dd, refers to the analysis date")] = None, + to_date: Annotated[Optional[datetime], Field(description="Date in the format yyyy-mm-dd, refers to the analysis date")] = None, + iso3: Optional[StrictStr] = None, + page: Optional[StrictInt] = None, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + 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, + ) -> IpcHistoricalDatumDtoPagedResult: + """Retrieves a paginated list of IPCCH and Equivalent Historical Data. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcch-historicaldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param from_date: Date in the format yyyy-mm-dd, refers to the analysis date + :type from_date: datetime + :param to_date: Date in the format yyyy-mm-dd, refers to the analysis date + :type to_date: datetime + :param iso3: + :type iso3: str + :param page: + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_historical_data_get_serialize( + from_date=from_date, + to_date=to_date, + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcHistoricalDatumDtoPagedResult", + '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 ipcch_ipcch_historical_data_get_with_http_info( + self, + from_date: Annotated[Optional[datetime], Field(description="Date in the format yyyy-mm-dd, refers to the analysis date")] = None, + to_date: Annotated[Optional[datetime], Field(description="Date in the format yyyy-mm-dd, refers to the analysis date")] = None, + iso3: Optional[StrictStr] = None, + page: Optional[StrictInt] = None, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + 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[IpcHistoricalDatumDtoPagedResult]: + """Retrieves a paginated list of IPCCH and Equivalent Historical Data. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcch-historicaldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param from_date: Date in the format yyyy-mm-dd, refers to the analysis date + :type from_date: datetime + :param to_date: Date in the format yyyy-mm-dd, refers to the analysis date + :type to_date: datetime + :param iso3: + :type iso3: str + :param page: + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_historical_data_get_serialize( + from_date=from_date, + to_date=to_date, + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcHistoricalDatumDtoPagedResult", + '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 ipcch_ipcch_historical_data_get_without_preload_content( + self, + from_date: Annotated[Optional[datetime], Field(description="Date in the format yyyy-mm-dd, refers to the analysis date")] = None, + to_date: Annotated[Optional[datetime], Field(description="Date in the format yyyy-mm-dd, refers to the analysis date")] = None, + iso3: Optional[StrictStr] = None, + page: Optional[StrictInt] = None, + env: Annotated[Optional[StrictStr], Field(description="Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org")] = None, + _request_timeout: Union[ + None, + 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: + """Retrieves a paginated list of IPCCH and Equivalent Historical Data. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcch-historicaldata_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + :param from_date: Date in the format yyyy-mm-dd, refers to the analysis date + :type from_date: datetime + :param to_date: Date in the format yyyy-mm-dd, refers to the analysis date + :type to_date: datetime + :param iso3: + :type iso3: str + :param page: + :type page: int + :param env: Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org + :type env: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ipcch_ipcch_historical_data_get_serialize( + from_date=from_date, + to_date=to_date, + iso3=iso3, + page=page, + env=env, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IpcHistoricalDatumDtoPagedResult", + '400': "BadRequestDTO", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ipcch_ipcch_historical_data_get_serialize( + self, + from_date, + to_date, + iso3, + page, + 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 from_date is not None: + if isinstance(from_date, datetime): + _query_params.append( + ( + 'fromDate', + from_date.strftime( + self.api_client.configuration.datetime_format + ) + ) + ) + else: + _query_params.append(('fromDate', from_date)) + + if to_date is not None: + if isinstance(to_date, datetime): + _query_params.append( + ( + 'toDate', + to_date.strftime( + self.api_client.configuration.datetime_format + ) + ) + ) + else: + _query_params.append(('toDate', to_date)) + + if iso3 is not None: + + _query_params.append(('iso3', iso3)) + + if page is not None: + + _query_params.append(('page', page)) + + 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='/Ipcch/IPCCH-HistoricalData', + 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 + ) + + diff --git a/data_bridges_client/api/market_prices_api.py b/data_bridges_client/api/market_prices_api.py index 5f67fad..7360c91 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -21,10 +21,10 @@ from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator from typing import Optional from typing_extensions import Annotated +from data_bridges_client.models.extended_alps_value_dto_paged_result import ExtendedAlpsValueDtoPagedResult from data_bridges_client.models.paged_commodity_price_list_dto import PagedCommodityPriceListDTO from data_bridges_client.models.paged_commodity_weekly_aggregated_price_list_dto import PagedCommodityWeeklyAggregatedPriceListDTO -from data_bridges_client.models.view_extended_aggregated_price_paged_result import ViewExtendedAggregatedPricePagedResult -from data_bridges_client.models.view_extended_alps_value_paged_result import ViewExtendedAlpsValuePagedResult +from data_bridges_client.models.view_extended_monthly_aggregated_price_paged_result import ViewExtendedMonthlyAggregatedPricePagedResult from data_bridges_client.api_client import ApiClient, RequestSerialized from data_bridges_client.api_response import ApiResponse @@ -71,7 +71,7 @@ def market_prices_alps_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ViewExtendedAlpsValuePagedResult: + ) -> ExtendedAlpsValueDtoPagedResult: """Returns time series values of ALPS and PEWI. [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-alps_get\" Returns the full time series of the Alert for Price Spikes (ALPS) and the value of the Price Early Warning Index (PEWI). Methodology is available in [DataViz](https://dataviz.vam.wfp.org/) and [VAM-Resource Centre](https://resources.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern @@ -142,7 +142,7 @@ def market_prices_alps_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ViewExtendedAlpsValuePagedResult", + '200': "ExtendedAlpsValueDtoPagedResult", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -183,7 +183,7 @@ def market_prices_alps_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[ViewExtendedAlpsValuePagedResult]: + ) -> ApiResponse[ExtendedAlpsValueDtoPagedResult]: """Returns time series values of ALPS and PEWI. [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-alps_get\" Returns the full time series of the Alert for Price Spikes (ALPS) and the value of the Price Early Warning Index (PEWI). Methodology is available in [DataViz](https://dataviz.vam.wfp.org/) and [VAM-Resource Centre](https://resources.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern @@ -254,7 +254,7 @@ def market_prices_alps_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ViewExtendedAlpsValuePagedResult", + '200': "ExtendedAlpsValueDtoPagedResult", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -366,7 +366,7 @@ def market_prices_alps_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ViewExtendedAlpsValuePagedResult", + '200': "ExtendedAlpsValueDtoPagedResult", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -542,7 +542,7 @@ def market_prices_price_daily_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ViewExtendedAggregatedPricePagedResult: + ) -> ViewExtendedMonthlyAggregatedPricePagedResult: """Returns a daily time series of commodity market prices. [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-pricedaily_get\" This is the highest frequency available. Data is flagged according to its pre-processing characteristics. Actual data is collected originally with daily frequency; aggregated data returns an empty list; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in DataLibrary. For specific methodological notes on forecasts and imputations refer to the dedicated page in DataViz. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern @@ -613,7 +613,7 @@ def market_prices_price_daily_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ViewExtendedAggregatedPricePagedResult", + '200': "ViewExtendedMonthlyAggregatedPricePagedResult", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -654,7 +654,7 @@ def market_prices_price_daily_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[ViewExtendedAggregatedPricePagedResult]: + ) -> ApiResponse[ViewExtendedMonthlyAggregatedPricePagedResult]: """Returns a daily time series of commodity market prices. [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-pricedaily_get\" This is the highest frequency available. Data is flagged according to its pre-processing characteristics. Actual data is collected originally with daily frequency; aggregated data returns an empty list; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in DataLibrary. For specific methodological notes on forecasts and imputations refer to the dedicated page in DataViz. Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern @@ -725,7 +725,7 @@ def market_prices_price_daily_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ViewExtendedAggregatedPricePagedResult", + '200': "ViewExtendedMonthlyAggregatedPricePagedResult", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -837,7 +837,7 @@ def market_prices_price_daily_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ViewExtendedAggregatedPricePagedResult", + '200': "ViewExtendedMonthlyAggregatedPricePagedResult", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -1013,7 +1013,7 @@ def market_prices_price_monthly_get( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ViewExtendedAggregatedPricePagedResult: + ) -> ViewExtendedMonthlyAggregatedPricePagedResult: """Returns a monthly time series of commodity market prices. [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-pricemonthly_get\" This is the lowest frequency available and the most complete data source. Data is flagged according to its pre-processing characteristics. actual data is collected originally with monthly frequency; aggregated data is collected with higher frequency (daily or weekly) averaged through a weighted mean to monthly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern @@ -1084,7 +1084,7 @@ def market_prices_price_monthly_get( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ViewExtendedAggregatedPricePagedResult", + '200': "ViewExtendedMonthlyAggregatedPricePagedResult", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -1125,7 +1125,7 @@ def market_prices_price_monthly_get_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[ViewExtendedAggregatedPricePagedResult]: + ) -> ApiResponse[ViewExtendedMonthlyAggregatedPricePagedResult]: """Returns a monthly time series of commodity market prices. [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_marketprices-pricemonthly_get\" This is the lowest frequency available and the most complete data source. Data is flagged according to its pre-processing characteristics. actual data is collected originally with monthly frequency; aggregated data is collected with higher frequency (daily or weekly) averaged through a weighted mean to monthly; imputed data is an estimation of missing values in the time series, obtained through the R Amelia-II package; forecasted data is a six months prediction obtained through different methods, which are reported in the API. For country specific meta-data please refer to documentation available in [DataLibrary](https://datalib.vam.wfp.org/). For specific methodological notes on forecasts and imputations refer to the dedicated page in [DataViz](https://dataviz.vam.wfp.org/). Country code, either ISO-3166 Alpha 3 code or the VAM internal admin0code is mandatory. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern @@ -1196,7 +1196,7 @@ def market_prices_price_monthly_get_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ViewExtendedAggregatedPricePagedResult", + '200': "ViewExtendedMonthlyAggregatedPricePagedResult", '400': "BadRequestDTO", } response_data = self.api_client.call_api( @@ -1308,7 +1308,7 @@ def market_prices_price_monthly_get_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ViewExtendedAggregatedPricePagedResult", + '200': "ViewExtendedMonthlyAggregatedPricePagedResult", '400': "BadRequestDTO", } response_data = self.api_client.call_api( diff --git a/data_bridges_client/api/markets_api.py b/data_bridges_client/api/markets_api.py index 3152f0c..6708e74 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 7a84265..6834b5e 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 4390949..4f3e20d 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 0c48912..72dfdb9 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 daa06cc..b89137d 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 e663d51..3d043ab 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: 6.0.0 + The version of the OpenAPI document: 7.0.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/6.0.0" if host is None else host + self._base_path = "https://api.wfp.org/vam-data-bridges/7.0.0" if host is None else host """Default Base url """ self.server_index = 0 if server_index is None and host is None else server_index @@ -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: 6.0.0\n"\ + "Version of the API: 7.0.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/6.0.0", + 'url': "https://api.wfp.org/vam-data-bridges/7.0.0", 'description': "No description provided", } ] diff --git a/data_bridges_client/exceptions.py b/data_bridges_client/exceptions.py index 54e9400..1dd68e6 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/__init__.py b/data_bridges_client/models/__init__.py index 65b9c6e..6815f5a 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -16,6 +16,11 @@ # import models into model package from data_bridges_client.models.bad_request_dto import BadRequestDTO +from data_bridges_client.models.cari_adm0_values_dto import CariAdm0ValuesDTO +from data_bridges_client.models.cari_adm0_values_dto_paged_result import CariAdm0ValuesDTOPagedResult +from data_bridges_client.models.cari_adm1_values_dto import CariAdm1ValuesDTO +from data_bridges_client.models.cari_adm1_values_dto_paged_result import CariAdm1ValuesDTOPagedResult +from data_bridges_client.models.categories_and_indicators_dto import CategoriesAndIndicatorsDTO from data_bridges_client.models.commodity_dto import CommodityDTO from data_bridges_client.models.commodity_price_dto import CommodityPriceDTO from data_bridges_client.models.commodity_processing_dto import CommodityProcessingDTO @@ -24,16 +29,27 @@ from data_bridges_client.models.economic_data_dto import EconomicDataDTO from data_bridges_client.models.economic_indicator_property import EconomicIndicatorProperty from data_bridges_client.models.economic_indicator_property_paged_result import EconomicIndicatorPropertyPagedResult +from data_bridges_client.models.extended_alps_value_dto import ExtendedAlpsValueDto +from data_bridges_client.models.extended_alps_value_dto_paged_result import ExtendedAlpsValueDtoPagedResult from data_bridges_client.models.feature import Feature from data_bridges_client.models.geometry import Geometry -from data_bridges_client.models.gorp_country_api_dto import GorpCountryApiDto -from data_bridges_client.models.gorp_global_api_dto import GorpGlobalApiDto -from data_bridges_client.models.gorp_regional_api_dto import GorpRegionalApiDto +from data_bridges_client.models.global_outlook_api_dto import GlobalOutlookApiDto +from data_bridges_client.models.global_outlook_country_api_dto import GlobalOutlookCountryApiDto +from data_bridges_client.models.global_outlook_regional_api_dto import GlobalOutlookRegionalApiDto from data_bridges_client.models.household_survey_list_dto import HouseholdSurveyListDTO from data_bridges_client.models.household_survey_list_dto_paged_result import HouseholdSurveyListDTOPagedResult -from data_bridges_client.models.ipc_value import IpcValue -from data_bridges_client.models.ipc_value_paged_result import IpcValuePagedResult +from data_bridges_client.models.hunger_hot_spot_data_dto import HungerHotSpotDataDTO +from data_bridges_client.models.hunger_hot_spot_data_dto_paged_result import HungerHotSpotDataDTOPagedResult +from data_bridges_client.models.ipc_historical_datum_dto import IpcHistoricalDatumDto +from data_bridges_client.models.ipc_historical_datum_dto_paged_result import IpcHistoricalDatumDtoPagedResult +from data_bridges_client.models.ipcch_and_equivalent_peaks_dto import IpcchAndEquivalentPeaksDTO +from data_bridges_client.models.ipcch_and_equivalent_peaks_dto_paged_result import IpcchAndEquivalentPeaksDTOPagedResult +from data_bridges_client.models.ipcch_base_dto import IpcchBaseDto +from data_bridges_client.models.ipcch_base_dto_paged_result import IpcchBaseDtoPagedResult +from data_bridges_client.models.ipcch_peaks_dto import IpcchPeaksDto +from data_bridges_client.models.ipcch_peaks_dto_paged_result import IpcchPeaksDtoPagedResult from data_bridges_client.models.key_name_dto import KeyNameDto +from data_bridges_client.models.list_item_dto import ListItemDto from data_bridges_client.models.mfi_processed_data_dto import MFIProcessedDataDTO from data_bridges_client.models.market_dto import MarketDTO from data_bridges_client.models.market_geo_json_root import MarketGeoJsonRoot @@ -58,10 +74,8 @@ from data_bridges_client.models.survey_list_dto import SurveyListDTO from data_bridges_client.models.usd_indirect_quotation import UsdIndirectQuotation from data_bridges_client.models.usd_indirect_quotation_paged_result import UsdIndirectQuotationPagedResult -from data_bridges_client.models.view_extended_aggregated_price import ViewExtendedAggregatedPrice -from data_bridges_client.models.view_extended_aggregated_price_paged_result import ViewExtendedAggregatedPricePagedResult -from data_bridges_client.models.view_extended_alps_value import ViewExtendedAlpsValue -from data_bridges_client.models.view_extended_alps_value_paged_result import ViewExtendedAlpsValuePagedResult +from data_bridges_client.models.view_extended_monthly_aggregated_price import ViewExtendedMonthlyAggregatedPrice +from data_bridges_client.models.view_extended_monthly_aggregated_price_paged_result import ViewExtendedMonthlyAggregatedPricePagedResult from data_bridges_client.models.weekly_aggregated_price import WeeklyAggregatedPrice from data_bridges_client.models.xls_form_dto import XlsFormDTO from data_bridges_client.models.xls_form_definition_new_schema_dto import XlsFormDefinitionNewSchemaDTO diff --git a/data_bridges_client/models/bad_request_dto.py b/data_bridges_client/models/bad_request_dto.py index 68f0b65..edde947 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/cari_adm0_values_dto.py b/data_bridges_client/models/cari_adm0_values_dto.py new file mode 100644 index 0000000..cd9cff0 --- /dev/null +++ b/data_bridges_client/models/cari_adm0_values_dto.py @@ -0,0 +1,161 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class CariAdm0ValuesDTO(BaseModel): + """ + CariAdm0ValuesDTO + """ # noqa: E501 + survey_id: Optional[StrictInt] = Field(default=None, alias="surveyID") + survey_name: Optional[StrictStr] = Field(default=None, alias="surveyName") + cari_methodology_name: Optional[StrictStr] = Field(default=None, alias="cariMethodologyName") + fcs_methodology_name: Optional[StrictStr] = Field(default=None, alias="fcsMethodologyName") + additional_survey_metadata: Optional[StrictStr] = Field(default=None, alias="additionalSurveyMetadata") + adm0_code: Optional[StrictInt] = Field(default=None, alias="adm0Code") + adm0_name: Optional[StrictStr] = Field(default=None, alias="adm0Name") + cari_indicator_id: Optional[StrictInt] = Field(default=None, alias="cariIndicatorID") + cari_indicator_name: Optional[StrictStr] = Field(default=None, alias="cariIndicatorName") + cari_indicator_category_id: Optional[StrictInt] = Field(default=None, alias="cariIndicatorCategoryID") + indicator_category_label: Optional[StrictStr] = Field(default=None, alias="indicatorCategoryLabel") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["surveyID", "surveyName", "cariMethodologyName", "fcsMethodologyName", "additionalSurveyMetadata", "adm0Code", "adm0Name", "cariIndicatorID", "cariIndicatorName", "cariIndicatorCategoryID", "indicatorCategoryLabel"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CariAdm0ValuesDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if survey_name (nullable) is None + # and model_fields_set contains the field + if self.survey_name is None and "survey_name" in self.model_fields_set: + _dict['surveyName'] = None + + # set to None if cari_methodology_name (nullable) is None + # and model_fields_set contains the field + if self.cari_methodology_name is None and "cari_methodology_name" in self.model_fields_set: + _dict['cariMethodologyName'] = None + + # set to None if fcs_methodology_name (nullable) is None + # and model_fields_set contains the field + if self.fcs_methodology_name is None and "fcs_methodology_name" in self.model_fields_set: + _dict['fcsMethodologyName'] = None + + # set to None if additional_survey_metadata (nullable) is None + # and model_fields_set contains the field + if self.additional_survey_metadata is None and "additional_survey_metadata" in self.model_fields_set: + _dict['additionalSurveyMetadata'] = None + + # set to None if adm0_code (nullable) is None + # and model_fields_set contains the field + if self.adm0_code is None and "adm0_code" in self.model_fields_set: + _dict['adm0Code'] = None + + # set to None if adm0_name (nullable) is None + # and model_fields_set contains the field + if self.adm0_name is None and "adm0_name" in self.model_fields_set: + _dict['adm0Name'] = None + + # set to None if cari_indicator_name (nullable) is None + # and model_fields_set contains the field + if self.cari_indicator_name is None and "cari_indicator_name" in self.model_fields_set: + _dict['cariIndicatorName'] = None + + # set to None if indicator_category_label (nullable) is None + # and model_fields_set contains the field + if self.indicator_category_label is None and "indicator_category_label" in self.model_fields_set: + _dict['indicatorCategoryLabel'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CariAdm0ValuesDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "surveyID": obj.get("surveyID"), + "surveyName": obj.get("surveyName"), + "cariMethodologyName": obj.get("cariMethodologyName"), + "fcsMethodologyName": obj.get("fcsMethodologyName"), + "additionalSurveyMetadata": obj.get("additionalSurveyMetadata"), + "adm0Code": obj.get("adm0Code"), + "adm0Name": obj.get("adm0Name"), + "cariIndicatorID": obj.get("cariIndicatorID"), + "cariIndicatorName": obj.get("cariIndicatorName"), + "cariIndicatorCategoryID": obj.get("cariIndicatorCategoryID"), + "indicatorCategoryLabel": obj.get("indicatorCategoryLabel") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/view_extended_aggregated_price_paged_result.py b/data_bridges_client/models/cari_adm0_values_dto_paged_result.py similarity index 86% rename from data_bridges_client/models/view_extended_aggregated_price_paged_result.py rename to data_bridges_client/models/cari_adm0_values_dto_paged_result.py index 489f1c8..2311a3f 100644 --- a/data_bridges_client/models/view_extended_aggregated_price_paged_result.py +++ b/data_bridges_client/models/cari_adm0_values_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -20,15 +20,15 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt from typing import Any, ClassVar, Dict, List, Optional -from data_bridges_client.models.view_extended_aggregated_price import ViewExtendedAggregatedPrice +from data_bridges_client.models.cari_adm0_values_dto import CariAdm0ValuesDTO from typing import Optional, Set from typing_extensions import Self -class ViewExtendedAggregatedPricePagedResult(BaseModel): +class CariAdm0ValuesDTOPagedResult(BaseModel): """ - ViewExtendedAggregatedPricePagedResult + CariAdm0ValuesDTOPagedResult """ # noqa: E501 - items: Optional[List[ViewExtendedAggregatedPrice]] = None + items: Optional[List[CariAdm0ValuesDTO]] = None page: Optional[StrictInt] = None total_items: Optional[StrictInt] = Field(default=None, alias="totalItems") additional_properties: Dict[str, Any] = {} @@ -52,7 +52,7 @@ def to_json(self) -> str: @classmethod def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of ViewExtendedAggregatedPricePagedResult from a JSON string""" + """Create an instance of CariAdm0ValuesDTOPagedResult from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: @@ -98,7 +98,7 @@ def to_dict(self) -> Dict[str, Any]: @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of ViewExtendedAggregatedPricePagedResult from a dict""" + """Create an instance of CariAdm0ValuesDTOPagedResult from a dict""" if obj is None: return None @@ -106,7 +106,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "items": [ViewExtendedAggregatedPrice.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, + "items": [CariAdm0ValuesDTO.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, "page": obj.get("page"), "totalItems": obj.get("totalItems") }) diff --git a/data_bridges_client/models/cari_adm1_values_dto.py b/data_bridges_client/models/cari_adm1_values_dto.py new file mode 100644 index 0000000..9dd9e65 --- /dev/null +++ b/data_bridges_client/models/cari_adm1_values_dto.py @@ -0,0 +1,175 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class CariAdm1ValuesDTO(BaseModel): + """ + CariAdm1ValuesDTO + """ # noqa: E501 + survey_id: Optional[StrictInt] = Field(default=None, alias="surveyID") + survey_name: Optional[StrictStr] = Field(default=None, alias="surveyName") + cari_methodology_name: Optional[StrictStr] = Field(default=None, alias="cariMethodologyName") + fcs_methodology_name: Optional[StrictStr] = Field(default=None, alias="fcsMethodologyName") + additional_survey_metadata: Optional[StrictStr] = Field(default=None, alias="additionalSurveyMetadata") + adm0_code: Optional[StrictInt] = Field(default=None, alias="adm0Code") + adm0_name: Optional[StrictStr] = Field(default=None, alias="adm0Name") + cari_indicator_id: Optional[StrictInt] = Field(default=None, alias="cariIndicatorID") + cari_indicator_name: Optional[StrictStr] = Field(default=None, alias="cariIndicatorName") + cari_indicator_category_id: Optional[StrictInt] = Field(default=None, alias="cariIndicatorCategoryID") + indicator_category_label: Optional[StrictStr] = Field(default=None, alias="indicatorCategoryLabel") + adm1_code: Optional[StrictInt] = Field(default=None, alias="adm1Code") + adm1_name: Optional[StrictStr] = Field(default=None, alias="adm1Name") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["surveyID", "surveyName", "cariMethodologyName", "fcsMethodologyName", "additionalSurveyMetadata", "adm0Code", "adm0Name", "cariIndicatorID", "cariIndicatorName", "cariIndicatorCategoryID", "indicatorCategoryLabel", "adm1Code", "adm1Name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CariAdm1ValuesDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if survey_name (nullable) is None + # and model_fields_set contains the field + if self.survey_name is None and "survey_name" in self.model_fields_set: + _dict['surveyName'] = None + + # set to None if cari_methodology_name (nullable) is None + # and model_fields_set contains the field + if self.cari_methodology_name is None and "cari_methodology_name" in self.model_fields_set: + _dict['cariMethodologyName'] = None + + # set to None if fcs_methodology_name (nullable) is None + # and model_fields_set contains the field + if self.fcs_methodology_name is None and "fcs_methodology_name" in self.model_fields_set: + _dict['fcsMethodologyName'] = None + + # set to None if additional_survey_metadata (nullable) is None + # and model_fields_set contains the field + if self.additional_survey_metadata is None and "additional_survey_metadata" in self.model_fields_set: + _dict['additionalSurveyMetadata'] = None + + # set to None if adm0_code (nullable) is None + # and model_fields_set contains the field + if self.adm0_code is None and "adm0_code" in self.model_fields_set: + _dict['adm0Code'] = None + + # set to None if adm0_name (nullable) is None + # and model_fields_set contains the field + if self.adm0_name is None and "adm0_name" in self.model_fields_set: + _dict['adm0Name'] = None + + # set to None if cari_indicator_name (nullable) is None + # and model_fields_set contains the field + if self.cari_indicator_name is None and "cari_indicator_name" in self.model_fields_set: + _dict['cariIndicatorName'] = None + + # set to None if indicator_category_label (nullable) is None + # and model_fields_set contains the field + if self.indicator_category_label is None and "indicator_category_label" in self.model_fields_set: + _dict['indicatorCategoryLabel'] = None + + # set to None if adm1_code (nullable) is None + # and model_fields_set contains the field + if self.adm1_code is None and "adm1_code" in self.model_fields_set: + _dict['adm1Code'] = None + + # set to None if adm1_name (nullable) is None + # and model_fields_set contains the field + if self.adm1_name is None and "adm1_name" in self.model_fields_set: + _dict['adm1Name'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CariAdm1ValuesDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "surveyID": obj.get("surveyID"), + "surveyName": obj.get("surveyName"), + "cariMethodologyName": obj.get("cariMethodologyName"), + "fcsMethodologyName": obj.get("fcsMethodologyName"), + "additionalSurveyMetadata": obj.get("additionalSurveyMetadata"), + "adm0Code": obj.get("adm0Code"), + "adm0Name": obj.get("adm0Name"), + "cariIndicatorID": obj.get("cariIndicatorID"), + "cariIndicatorName": obj.get("cariIndicatorName"), + "cariIndicatorCategoryID": obj.get("cariIndicatorCategoryID"), + "indicatorCategoryLabel": obj.get("indicatorCategoryLabel"), + "adm1Code": obj.get("adm1Code"), + "adm1Name": obj.get("adm1Name") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/cari_adm1_values_dto_paged_result.py b/data_bridges_client/models/cari_adm1_values_dto_paged_result.py new file mode 100644 index 0000000..965d07e --- /dev/null +++ b/data_bridges_client/models/cari_adm1_values_dto_paged_result.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from data_bridges_client.models.cari_adm1_values_dto import CariAdm1ValuesDTO +from typing import Optional, Set +from typing_extensions import Self + +class CariAdm1ValuesDTOPagedResult(BaseModel): + """ + CariAdm1ValuesDTOPagedResult + """ # noqa: E501 + items: Optional[List[CariAdm1ValuesDTO]] = None + page: Optional[StrictInt] = None + total_items: Optional[StrictInt] = Field(default=None, alias="totalItems") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["items", "page", "totalItems"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CariAdm1ValuesDTOPagedResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "items", + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) + _dict['items'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if items (nullable) is None + # and model_fields_set contains the field + if self.items is None and "items" in self.model_fields_set: + _dict['items'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CariAdm1ValuesDTOPagedResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [CariAdm1ValuesDTO.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, + "page": obj.get("page"), + "totalItems": obj.get("totalItems") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/categories_and_indicators_dto.py b/data_bridges_client/models/categories_and_indicators_dto.py new file mode 100644 index 0000000..7e53417 --- /dev/null +++ b/data_bridges_client/models/categories_and_indicators_dto.py @@ -0,0 +1,128 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from data_bridges_client.models.list_item_dto import ListItemDto +from typing import Optional, Set +from typing_extensions import Self + +class CategoriesAndIndicatorsDTO(BaseModel): + """ + CategoriesAndIndicatorsDTO + """ # noqa: E501 + categories: Optional[List[ListItemDto]] = None + indicators: Optional[List[ListItemDto]] = None + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["categories", "indicators"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CategoriesAndIndicatorsDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in categories (list) + _items = [] + if self.categories: + for _item_categories in self.categories: + if _item_categories: + _items.append(_item_categories.to_dict()) + _dict['categories'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in indicators (list) + _items = [] + if self.indicators: + for _item_indicators in self.indicators: + if _item_indicators: + _items.append(_item_indicators.to_dict()) + _dict['indicators'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if categories (nullable) is None + # and model_fields_set contains the field + if self.categories is None and "categories" in self.model_fields_set: + _dict['categories'] = None + + # set to None if indicators (nullable) is None + # and model_fields_set contains the field + if self.indicators is None and "indicators" in self.model_fields_set: + _dict['indicators'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CategoriesAndIndicatorsDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "categories": [ListItemDto.from_dict(_item) for _item in obj["categories"]] if obj.get("categories") is not None else None, + "indicators": [ListItemDto.from_dict(_item) for _item in obj["indicators"]] if obj.get("indicators") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/commodity_dto.py b/data_bridges_client/models/commodity_dto.py index 6d6e178..90e0985 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 ff73bde..903c72f 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/commodity_processing_dto.py b/data_bridges_client/models/commodity_processing_dto.py index eb4049f..ce8d7b0 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/commodity_quality_dto.py b/data_bridges_client/models/commodity_quality_dto.py index 9b1c745..c62848b 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/currency_dto.py b/data_bridges_client/models/currency_dto.py index 6ff0d56..06f8c06 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/economic_data_dto.py b/data_bridges_client/models/economic_data_dto.py index be338a6..7ec1abf 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/economic_indicator_property.py b/data_bridges_client/models/economic_indicator_property.py index ed472e2..f8ae0ec 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/economic_indicator_property_paged_result.py b/data_bridges_client/models/economic_indicator_property_paged_result.py index 42d17c7..6890f9f 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/view_extended_alps_value.py b/data_bridges_client/models/extended_alps_value_dto.py similarity index 92% rename from data_bridges_client/models/view_extended_alps_value.py rename to data_bridges_client/models/extended_alps_value_dto.py index 0f6c1a9..e53e911 100644 --- a/data_bridges_client/models/view_extended_alps_value.py +++ b/data_bridges_client/models/extended_alps_value_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -24,15 +24,15 @@ from typing import Optional, Set from typing_extensions import Self -class ViewExtendedAlpsValue(BaseModel): +class ExtendedAlpsValueDto(BaseModel): """ - ViewExtendedAlpsValue + ExtendedAlpsValueDto """ # noqa: E501 - commodity_id: Optional[StrictInt] = Field(default=None, alias="commodityID") - market_id: Optional[StrictInt] = Field(default=None, alias="marketID") - price_type_id: Optional[StrictInt] = Field(default=None, alias="priceTypeID") - commodity_unit_id: Optional[StrictInt] = Field(default=None, alias="commodityUnitID") - currency_id: Optional[StrictInt] = Field(default=None, alias="currencyID") + commodity_id: Optional[StrictInt] = Field(default=None, alias="commodityId") + market_id: Optional[StrictInt] = Field(default=None, alias="marketId") + price_type_id: Optional[StrictInt] = Field(default=None, alias="priceTypeId") + commodity_unit_id: Optional[StrictInt] = Field(default=None, alias="commodityUnitId") + currency_id: Optional[StrictInt] = Field(default=None, alias="currencyId") adm0_code: Optional[StrictInt] = Field(default=None, alias="adm0Code") country_name: Optional[StrictStr] = Field(default=None, alias="countryName") commodity_price_date_year: Optional[StrictInt] = Field(default=None, alias="commodityPriceDateYear") @@ -48,7 +48,7 @@ class ViewExtendedAlpsValue(BaseModel): analysis_value_pewi_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="analysisValuePewiValue") analysis_value_price_flag: Optional[StrictStr] = Field(default=None, alias="analysisValuePriceFlag") additional_properties: Dict[str, Any] = {} - __properties: ClassVar[List[str]] = ["commodityID", "marketID", "priceTypeID", "commodityUnitID", "currencyID", "adm0Code", "countryName", "commodityPriceDateYear", "commodityPriceDateMonth", "commodityPriceDateWeek", "commodityPriceDate", "commodityName", "marketName", "priceTypeName", "commodityUnitName", "currencyName", "analysisValueEstimatedPrice", "analysisValuePewiValue", "analysisValuePriceFlag"] + __properties: ClassVar[List[str]] = ["commodityId", "marketId", "priceTypeId", "commodityUnitId", "currencyId", "adm0Code", "countryName", "commodityPriceDateYear", "commodityPriceDateMonth", "commodityPriceDateWeek", "commodityPriceDate", "commodityName", "marketName", "priceTypeName", "commodityUnitName", "currencyName", "analysisValueEstimatedPrice", "analysisValuePewiValue", "analysisValuePriceFlag"] model_config = ConfigDict( populate_by_name=True, @@ -68,7 +68,7 @@ def to_json(self) -> str: @classmethod def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of ViewExtendedAlpsValue from a JSON string""" + """Create an instance of ExtendedAlpsValueDto from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: @@ -155,7 +155,7 @@ def to_dict(self) -> Dict[str, Any]: @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of ViewExtendedAlpsValue from a dict""" + """Create an instance of ExtendedAlpsValueDto from a dict""" if obj is None: return None @@ -163,11 +163,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "commodityID": obj.get("commodityID"), - "marketID": obj.get("marketID"), - "priceTypeID": obj.get("priceTypeID"), - "commodityUnitID": obj.get("commodityUnitID"), - "currencyID": obj.get("currencyID"), + "commodityId": obj.get("commodityId"), + "marketId": obj.get("marketId"), + "priceTypeId": obj.get("priceTypeId"), + "commodityUnitId": obj.get("commodityUnitId"), + "currencyId": obj.get("currencyId"), "adm0Code": obj.get("adm0Code"), "countryName": obj.get("countryName"), "commodityPriceDateYear": obj.get("commodityPriceDateYear"), diff --git a/data_bridges_client/models/extended_alps_value_dto_paged_result.py b/data_bridges_client/models/extended_alps_value_dto_paged_result.py new file mode 100644 index 0000000..48f83bd --- /dev/null +++ b/data_bridges_client/models/extended_alps_value_dto_paged_result.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from data_bridges_client.models.extended_alps_value_dto import ExtendedAlpsValueDto +from typing import Optional, Set +from typing_extensions import Self + +class ExtendedAlpsValueDtoPagedResult(BaseModel): + """ + ExtendedAlpsValueDtoPagedResult + """ # noqa: E501 + items: Optional[List[ExtendedAlpsValueDto]] = None + page: Optional[StrictInt] = None + total_items: Optional[StrictInt] = Field(default=None, alias="totalItems") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["items", "page", "totalItems"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ExtendedAlpsValueDtoPagedResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "items", + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) + _dict['items'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if items (nullable) is None + # and model_fields_set contains the field + if self.items is None and "items" in self.model_fields_set: + _dict['items'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ExtendedAlpsValueDtoPagedResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [ExtendedAlpsValueDto.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, + "page": obj.get("page"), + "totalItems": obj.get("totalItems") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/feature.py b/data_bridges_client/models/feature.py index 4cffb07..c4da390 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/geometry.py b/data_bridges_client/models/geometry.py index 1c75fa4..a99946c 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: 6.0.0 + The version of the OpenAPI document: 7.0.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/global_outlook_api_dto.py similarity index 72% rename from data_bridges_client/models/gorp_global_api_dto.py rename to data_bridges_client/models/global_outlook_api_dto.py index 021f90a..da0ec87 100644 --- a/data_bridges_client/models/gorp_global_api_dto.py +++ b/data_bridges_client/models/global_outlook_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,17 +23,17 @@ from typing import Optional, Set from typing_extensions import Self -class GorpGlobalApiDto(BaseModel): +class GlobalOutlookApiDto(BaseModel): """ - GorpGlobalApiDto + GlobalOutlookApiDto """ # noqa: E501 - gorp_date: Optional[StrictStr] = Field(default=None, alias="gorpDate") - gorp_region_name: Optional[StrictStr] = Field(default=None, alias="gorpRegionName") - gorp_total_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="gorpTotalValue") + var_date: Optional[StrictStr] = Field(default=None, alias="date") + region_name: Optional[StrictStr] = Field(default=None, alias="regionName") + total_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="totalValue") number_of_countries: Optional[StrictInt] = Field(default=None, alias="numberOfCountries") - gorp_comment: Optional[StrictStr] = Field(default=None, alias="gorpComment") + comment: Optional[StrictStr] = None additional_properties: Dict[str, Any] = {} - __properties: ClassVar[List[str]] = ["gorpDate", "gorpRegionName", "gorpTotalValue", "numberOfCountries", "gorpComment"] + __properties: ClassVar[List[str]] = ["date", "regionName", "totalValue", "numberOfCountries", "comment"] model_config = ConfigDict( populate_by_name=True, @@ -53,7 +53,7 @@ def to_json(self) -> str: @classmethod def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of GorpGlobalApiDto from a JSON string""" + """Create an instance of GlobalOutlookApiDto from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: @@ -81,31 +81,31 @@ def to_dict(self) -> Dict[str, Any]: for _key, _value in self.additional_properties.items(): _dict[_key] = _value - # set to None if gorp_date (nullable) is None + # set to None if var_date (nullable) is None # and model_fields_set contains the field - if self.gorp_date is None and "gorp_date" in self.model_fields_set: - _dict['gorpDate'] = None + if self.var_date is None and "var_date" in self.model_fields_set: + _dict['date'] = None - # set to None if gorp_region_name (nullable) is None + # set to None if region_name (nullable) is None # and model_fields_set contains the field - if self.gorp_region_name is None and "gorp_region_name" in self.model_fields_set: - _dict['gorpRegionName'] = None + if self.region_name is None and "region_name" in self.model_fields_set: + _dict['regionName'] = None # set to None if number_of_countries (nullable) is None # and model_fields_set contains the field if self.number_of_countries is None and "number_of_countries" in self.model_fields_set: _dict['numberOfCountries'] = None - # set to None if gorp_comment (nullable) is None + # set to None if comment (nullable) is None # and model_fields_set contains the field - if self.gorp_comment is None and "gorp_comment" in self.model_fields_set: - _dict['gorpComment'] = None + if self.comment is None and "comment" in self.model_fields_set: + _dict['comment'] = None return _dict @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GorpGlobalApiDto from a dict""" + """Create an instance of GlobalOutlookApiDto from a dict""" if obj is None: return None @@ -113,11 +113,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "gorpDate": obj.get("gorpDate"), - "gorpRegionName": obj.get("gorpRegionName"), - "gorpTotalValue": obj.get("gorpTotalValue"), + "date": obj.get("date"), + "regionName": obj.get("regionName"), + "totalValue": obj.get("totalValue"), "numberOfCountries": obj.get("numberOfCountries"), - "gorpComment": obj.get("gorpComment") + "comment": obj.get("comment") }) # store additional fields in additional_properties for _key in obj.keys(): diff --git a/data_bridges_client/models/gorp_country_api_dto.py b/data_bridges_client/models/global_outlook_country_api_dto.py similarity index 76% rename from data_bridges_client/models/gorp_country_api_dto.py rename to data_bridges_client/models/global_outlook_country_api_dto.py index d1b335c..43944df 100644 --- a/data_bridges_client/models/gorp_country_api_dto.py +++ b/data_bridges_client/models/global_outlook_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,16 +23,16 @@ from typing import Optional, Set from typing_extensions import Self -class GorpCountryApiDto(BaseModel): +class GlobalOutlookCountryApiDto(BaseModel): """ - GorpCountryApiDto + GlobalOutlookCountryApiDto """ # noqa: E501 - gorp_date: Optional[StrictStr] = Field(default=None, alias="gorpDate") + var_date: Optional[StrictStr] = Field(default=None, alias="date") country_office_iso3: Optional[StrictStr] = Field(default=None, alias="countryOfficeIso3") - gorp_total_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="gorpTotalValue") - gorp_comment: Optional[StrictStr] = Field(default=None, alias="gorpComment") + total_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="totalValue") + comment: Optional[StrictStr] = None additional_properties: Dict[str, Any] = {} - __properties: ClassVar[List[str]] = ["gorpDate", "countryOfficeIso3", "gorpTotalValue", "gorpComment"] + __properties: ClassVar[List[str]] = ["date", "countryOfficeIso3", "totalValue", "comment"] model_config = ConfigDict( populate_by_name=True, @@ -52,7 +52,7 @@ def to_json(self) -> str: @classmethod def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of GorpCountryApiDto from a JSON string""" + """Create an instance of GlobalOutlookCountryApiDto from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: @@ -80,26 +80,26 @@ def to_dict(self) -> Dict[str, Any]: for _key, _value in self.additional_properties.items(): _dict[_key] = _value - # set to None if gorp_date (nullable) is None + # set to None if var_date (nullable) is None # and model_fields_set contains the field - if self.gorp_date is None and "gorp_date" in self.model_fields_set: - _dict['gorpDate'] = None + if self.var_date is None and "var_date" in self.model_fields_set: + _dict['date'] = None # set to None if country_office_iso3 (nullable) is None # and model_fields_set contains the field if self.country_office_iso3 is None and "country_office_iso3" in self.model_fields_set: _dict['countryOfficeIso3'] = None - # set to None if gorp_comment (nullable) is None + # set to None if comment (nullable) is None # and model_fields_set contains the field - if self.gorp_comment is None and "gorp_comment" in self.model_fields_set: - _dict['gorpComment'] = None + if self.comment is None and "comment" in self.model_fields_set: + _dict['comment'] = None return _dict @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GorpCountryApiDto from a dict""" + """Create an instance of GlobalOutlookCountryApiDto from a dict""" if obj is None: return None @@ -107,10 +107,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "gorpDate": obj.get("gorpDate"), + "date": obj.get("date"), "countryOfficeIso3": obj.get("countryOfficeIso3"), - "gorpTotalValue": obj.get("gorpTotalValue"), - "gorpComment": obj.get("gorpComment") + "totalValue": obj.get("totalValue"), + "comment": obj.get("comment") }) # store additional fields in additional_properties for _key in obj.keys(): diff --git a/data_bridges_client/models/gorp_regional_api_dto.py b/data_bridges_client/models/global_outlook_regional_api_dto.py similarity index 71% rename from data_bridges_client/models/gorp_regional_api_dto.py rename to data_bridges_client/models/global_outlook_regional_api_dto.py index fe79f44..60b0ee5 100644 --- a/data_bridges_client/models/gorp_regional_api_dto.py +++ b/data_bridges_client/models/global_outlook_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -23,17 +23,17 @@ from typing import Optional, Set from typing_extensions import Self -class GorpRegionalApiDto(BaseModel): +class GlobalOutlookRegionalApiDto(BaseModel): """ - GorpRegionalApiDto + GlobalOutlookRegionalApiDto """ # noqa: E501 - gorp_date: Optional[StrictStr] = Field(default=None, alias="gorpDate") - gorp_region_name: Optional[StrictStr] = Field(default=None, alias="gorpRegionName") - gorp_total_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="gorpTotalValue") + var_date: Optional[StrictStr] = Field(default=None, alias="date") + region_name: Optional[StrictStr] = Field(default=None, alias="regionName") + total_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="totalValue") number_of_countries: Optional[StrictInt] = Field(default=None, alias="numberOfCountries") - gorp_comment: Optional[StrictStr] = Field(default=None, alias="gorpComment") + comment: Optional[StrictStr] = None additional_properties: Dict[str, Any] = {} - __properties: ClassVar[List[str]] = ["gorpDate", "gorpRegionName", "gorpTotalValue", "numberOfCountries", "gorpComment"] + __properties: ClassVar[List[str]] = ["date", "regionName", "totalValue", "numberOfCountries", "comment"] model_config = ConfigDict( populate_by_name=True, @@ -53,7 +53,7 @@ def to_json(self) -> str: @classmethod def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of GorpRegionalApiDto from a JSON string""" + """Create an instance of GlobalOutlookRegionalApiDto from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: @@ -81,31 +81,31 @@ def to_dict(self) -> Dict[str, Any]: for _key, _value in self.additional_properties.items(): _dict[_key] = _value - # set to None if gorp_date (nullable) is None + # set to None if var_date (nullable) is None # and model_fields_set contains the field - if self.gorp_date is None and "gorp_date" in self.model_fields_set: - _dict['gorpDate'] = None + if self.var_date is None and "var_date" in self.model_fields_set: + _dict['date'] = None - # set to None if gorp_region_name (nullable) is None + # set to None if region_name (nullable) is None # and model_fields_set contains the field - if self.gorp_region_name is None and "gorp_region_name" in self.model_fields_set: - _dict['gorpRegionName'] = None + if self.region_name is None and "region_name" in self.model_fields_set: + _dict['regionName'] = None # set to None if number_of_countries (nullable) is None # and model_fields_set contains the field if self.number_of_countries is None and "number_of_countries" in self.model_fields_set: _dict['numberOfCountries'] = None - # set to None if gorp_comment (nullable) is None + # set to None if comment (nullable) is None # and model_fields_set contains the field - if self.gorp_comment is None and "gorp_comment" in self.model_fields_set: - _dict['gorpComment'] = None + if self.comment is None and "comment" in self.model_fields_set: + _dict['comment'] = None return _dict @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of GorpRegionalApiDto from a dict""" + """Create an instance of GlobalOutlookRegionalApiDto from a dict""" if obj is None: return None @@ -113,11 +113,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "gorpDate": obj.get("gorpDate"), - "gorpRegionName": obj.get("gorpRegionName"), - "gorpTotalValue": obj.get("gorpTotalValue"), + "date": obj.get("date"), + "regionName": obj.get("regionName"), + "totalValue": obj.get("totalValue"), "numberOfCountries": obj.get("numberOfCountries"), - "gorpComment": obj.get("gorpComment") + "comment": obj.get("comment") }) # store additional fields in additional_properties for _key in obj.keys(): diff --git a/data_bridges_client/models/household_survey_list_dto.py b/data_bridges_client/models/household_survey_list_dto.py index da2b9ad..139efe7 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 f607583..06d0cf4 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/hunger_hot_spot_data_dto.py b/data_bridges_client/models/hunger_hot_spot_data_dto.py new file mode 100644 index 0000000..023469f --- /dev/null +++ b/data_bridges_client/models/hunger_hot_spot_data_dto.py @@ -0,0 +1,129 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from data_bridges_client.models.list_item_dto import ListItemDto +from typing import Optional, Set +from typing_extensions import Self + +class HungerHotSpotDataDTO(BaseModel): + """ + HungerHotSpotDataDTO + """ # noqa: E501 + iso3_code: Optional[StrictStr] = Field(default=None, alias="iso3Code") + hunger_hotspots_date: Optional[datetime] = Field(default=None, alias="hungerHotspotsDate") + category: Optional[ListItemDto] = None + indicators: Optional[List[ListItemDto]] = None + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["iso3Code", "hungerHotspotsDate", "category", "indicators"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of HungerHotSpotDataDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of category + if self.category: + _dict['category'] = self.category.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in indicators (list) + _items = [] + if self.indicators: + for _item_indicators in self.indicators: + if _item_indicators: + _items.append(_item_indicators.to_dict()) + _dict['indicators'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if iso3_code (nullable) is None + # and model_fields_set contains the field + if self.iso3_code is None and "iso3_code" in self.model_fields_set: + _dict['iso3Code'] = None + + # set to None if indicators (nullable) is None + # and model_fields_set contains the field + if self.indicators is None and "indicators" in self.model_fields_set: + _dict['indicators'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of HungerHotSpotDataDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "iso3Code": obj.get("iso3Code"), + "hungerHotspotsDate": obj.get("hungerHotspotsDate"), + "category": ListItemDto.from_dict(obj["category"]) if obj.get("category") is not None else None, + "indicators": [ListItemDto.from_dict(_item) for _item in obj["indicators"]] if obj.get("indicators") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/hunger_hot_spot_data_dto_paged_result.py b/data_bridges_client/models/hunger_hot_spot_data_dto_paged_result.py new file mode 100644 index 0000000..d709f7b --- /dev/null +++ b/data_bridges_client/models/hunger_hot_spot_data_dto_paged_result.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from data_bridges_client.models.hunger_hot_spot_data_dto import HungerHotSpotDataDTO +from typing import Optional, Set +from typing_extensions import Self + +class HungerHotSpotDataDTOPagedResult(BaseModel): + """ + HungerHotSpotDataDTOPagedResult + """ # noqa: E501 + items: Optional[List[HungerHotSpotDataDTO]] = None + page: Optional[StrictInt] = None + total_items: Optional[StrictInt] = Field(default=None, alias="totalItems") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["items", "page", "totalItems"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of HungerHotSpotDataDTOPagedResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "items", + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) + _dict['items'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if items (nullable) is None + # and model_fields_set contains the field + if self.items is None and "items" in self.model_fields_set: + _dict['items'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of HungerHotSpotDataDTOPagedResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [HungerHotSpotDataDTO.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, + "page": obj.get("page"), + "totalItems": obj.get("totalItems") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/ipc_historical_datum_dto.py b/data_bridges_client/models/ipc_historical_datum_dto.py new file mode 100644 index 0000000..582e157 --- /dev/null +++ b/data_bridges_client/models/ipc_historical_datum_dto.py @@ -0,0 +1,459 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class IpcHistoricalDatumDto(BaseModel): + """ + IpcHistoricalDatumDto + """ # noqa: E501 + analysis_id: Optional[StrictInt] = Field(default=None, alias="analysisId") + analysis_title: Optional[StrictStr] = Field(default=None, alias="analysisTitle") + iso3_alpha3: Optional[StrictStr] = Field(default=None, alias="iso3Alpha3") + country_name: Optional[StrictStr] = Field(default=None, alias="countryName") + analysis_date: Optional[datetime] = Field(default=None, alias="analysisDate") + start_date_current_period: Optional[datetime] = Field(default=None, alias="StartDate_CurrentPeriod") + end_date_current_period: Optional[datetime] = Field(default=None, alias="EndDate_CurrentPeriod") + start_date_projected_period: Optional[datetime] = Field(default=None, alias="StartDate_ProjectedPeriod") + end_date_projected_period: Optional[datetime] = Field(default=None, alias="EndDate_ProjectedPeriod") + start_date_second_projected_period: Optional[datetime] = Field(default=None, alias="StartDate_SecondProjectedPeriod") + end_date_second_projected_period: Optional[datetime] = Field(default=None, alias="EndDate_SecondProjectedPeriod") + population: Optional[Union[StrictFloat, StrictInt]] = None + population_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="populationPercentage") + phase3_plus_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3PlusPopulation") + phase3_plus_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3PlusPercentage") + estimated_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="estimatedPopulation") + phase1_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase1Population") + phase1_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase1Percentage") + phase2_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase2Population") + phase2_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase2Percentage") + phase3_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3Population") + phase3_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3Percentage") + phase4_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase4Population") + phase4_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase4Percentage") + phase5_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase5Population") + phase5_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase5Percentage") + phase3_plus_population_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3PlusPopulationProjected") + phase3_plus_percentage_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3PlusPercentageProjected") + estimated_population_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="estimatedPopulationProjected") + phase1_population_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase1PopulationProjected") + phase1_percentage_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase1PercentageProjected") + phase2_population_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase2PopulationProjected") + phase2_percentage_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase2PercentageProjected") + phase3_population_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3PopulationProjected") + phase3_percentage_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3PercentageProjected") + phase4_population_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase4PopulationProjected") + phase4_percentage_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase4PercentageProjected") + phase5_population_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase5PopulationProjected") + phase5_percentage_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase5PercentageProjected") + phase3_plus_population_second_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3PlusPopulationSecondProjected") + phase3_plus_percentage_second_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3PlusPercentageSecondProjected") + estimated_population_second_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="estimatedPopulationSecondProjected") + phase1_population_second_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase1PopulationSecondProjected") + phase1_percentage_second_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase1PercentageSecondProjected") + phase2_population_second_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase2PopulationSecondProjected") + phase2_percentage_second_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase2PercentageSecondProjected") + phase3_population_second_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3PopulationSecondProjected") + phase3_percentage_second_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3PercentageSecondProjected") + phase4_population_second_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase4PopulationSecondProjected") + phase4_percentage_second_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase4PercentageSecondProjected") + phase5_population_second_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase5PopulationSecondProjected") + phase5_percentage_second_projected: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase5PercentageSecondProjected") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["analysisId", "analysisTitle", "iso3Alpha3", "countryName", "analysisDate", "StartDate_CurrentPeriod", "EndDate_CurrentPeriod", "StartDate_ProjectedPeriod", "EndDate_ProjectedPeriod", "StartDate_SecondProjectedPeriod", "EndDate_SecondProjectedPeriod", "population", "populationPercentage", "phase3PlusPopulation", "phase3PlusPercentage", "estimatedPopulation", "phase1Population", "phase1Percentage", "phase2Population", "phase2Percentage", "phase3Population", "phase3Percentage", "phase4Population", "phase4Percentage", "phase5Population", "phase5Percentage", "phase3PlusPopulationProjected", "phase3PlusPercentageProjected", "estimatedPopulationProjected", "phase1PopulationProjected", "phase1PercentageProjected", "phase2PopulationProjected", "phase2PercentageProjected", "phase3PopulationProjected", "phase3PercentageProjected", "phase4PopulationProjected", "phase4PercentageProjected", "phase5PopulationProjected", "phase5PercentageProjected", "phase3PlusPopulationSecondProjected", "phase3PlusPercentageSecondProjected", "estimatedPopulationSecondProjected", "phase1PopulationSecondProjected", "phase1PercentageSecondProjected", "phase2PopulationSecondProjected", "phase2PercentageSecondProjected", "phase3PopulationSecondProjected", "phase3PercentageSecondProjected", "phase4PopulationSecondProjected", "phase4PercentageSecondProjected", "phase5PopulationSecondProjected", "phase5PercentageSecondProjected"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IpcHistoricalDatumDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if analysis_title (nullable) is None + # and model_fields_set contains the field + if self.analysis_title is None and "analysis_title" in self.model_fields_set: + _dict['analysisTitle'] = None + + # set to None if iso3_alpha3 (nullable) is None + # and model_fields_set contains the field + if self.iso3_alpha3 is None and "iso3_alpha3" in self.model_fields_set: + _dict['iso3Alpha3'] = None + + # set to None if country_name (nullable) is None + # and model_fields_set contains the field + if self.country_name is None and "country_name" in self.model_fields_set: + _dict['countryName'] = None + + # set to None if analysis_date (nullable) is None + # and model_fields_set contains the field + if self.analysis_date is None and "analysis_date" in self.model_fields_set: + _dict['analysisDate'] = None + + # set to None if start_date_current_period (nullable) is None + # and model_fields_set contains the field + if self.start_date_current_period is None and "start_date_current_period" in self.model_fields_set: + _dict['StartDate_CurrentPeriod'] = None + + # set to None if end_date_current_period (nullable) is None + # and model_fields_set contains the field + if self.end_date_current_period is None and "end_date_current_period" in self.model_fields_set: + _dict['EndDate_CurrentPeriod'] = None + + # set to None if start_date_projected_period (nullable) is None + # and model_fields_set contains the field + if self.start_date_projected_period is None and "start_date_projected_period" in self.model_fields_set: + _dict['StartDate_ProjectedPeriod'] = None + + # set to None if end_date_projected_period (nullable) is None + # and model_fields_set contains the field + if self.end_date_projected_period is None and "end_date_projected_period" in self.model_fields_set: + _dict['EndDate_ProjectedPeriod'] = None + + # set to None if start_date_second_projected_period (nullable) is None + # and model_fields_set contains the field + if self.start_date_second_projected_period is None and "start_date_second_projected_period" in self.model_fields_set: + _dict['StartDate_SecondProjectedPeriod'] = None + + # set to None if end_date_second_projected_period (nullable) is None + # and model_fields_set contains the field + if self.end_date_second_projected_period is None and "end_date_second_projected_period" in self.model_fields_set: + _dict['EndDate_SecondProjectedPeriod'] = None + + # set to None if population (nullable) is None + # and model_fields_set contains the field + if self.population is None and "population" in self.model_fields_set: + _dict['population'] = None + + # set to None if population_percentage (nullable) is None + # and model_fields_set contains the field + if self.population_percentage is None and "population_percentage" in self.model_fields_set: + _dict['populationPercentage'] = None + + # set to None if phase3_plus_population (nullable) is None + # and model_fields_set contains the field + if self.phase3_plus_population is None and "phase3_plus_population" in self.model_fields_set: + _dict['phase3PlusPopulation'] = None + + # set to None if phase3_plus_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase3_plus_percentage is None and "phase3_plus_percentage" in self.model_fields_set: + _dict['phase3PlusPercentage'] = None + + # set to None if estimated_population (nullable) is None + # and model_fields_set contains the field + if self.estimated_population is None and "estimated_population" in self.model_fields_set: + _dict['estimatedPopulation'] = None + + # set to None if phase1_population (nullable) is None + # and model_fields_set contains the field + if self.phase1_population is None and "phase1_population" in self.model_fields_set: + _dict['phase1Population'] = None + + # set to None if phase1_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase1_percentage is None and "phase1_percentage" in self.model_fields_set: + _dict['phase1Percentage'] = None + + # set to None if phase2_population (nullable) is None + # and model_fields_set contains the field + if self.phase2_population is None and "phase2_population" in self.model_fields_set: + _dict['phase2Population'] = None + + # set to None if phase2_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase2_percentage is None and "phase2_percentage" in self.model_fields_set: + _dict['phase2Percentage'] = None + + # set to None if phase3_population (nullable) is None + # and model_fields_set contains the field + if self.phase3_population is None and "phase3_population" in self.model_fields_set: + _dict['phase3Population'] = None + + # set to None if phase3_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase3_percentage is None and "phase3_percentage" in self.model_fields_set: + _dict['phase3Percentage'] = None + + # set to None if phase4_population (nullable) is None + # and model_fields_set contains the field + if self.phase4_population is None and "phase4_population" in self.model_fields_set: + _dict['phase4Population'] = None + + # set to None if phase4_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase4_percentage is None and "phase4_percentage" in self.model_fields_set: + _dict['phase4Percentage'] = None + + # set to None if phase5_population (nullable) is None + # and model_fields_set contains the field + if self.phase5_population is None and "phase5_population" in self.model_fields_set: + _dict['phase5Population'] = None + + # set to None if phase5_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase5_percentage is None and "phase5_percentage" in self.model_fields_set: + _dict['phase5Percentage'] = None + + # set to None if phase3_plus_population_projected (nullable) is None + # and model_fields_set contains the field + if self.phase3_plus_population_projected is None and "phase3_plus_population_projected" in self.model_fields_set: + _dict['phase3PlusPopulationProjected'] = None + + # set to None if phase3_plus_percentage_projected (nullable) is None + # and model_fields_set contains the field + if self.phase3_plus_percentage_projected is None and "phase3_plus_percentage_projected" in self.model_fields_set: + _dict['phase3PlusPercentageProjected'] = None + + # set to None if estimated_population_projected (nullable) is None + # and model_fields_set contains the field + if self.estimated_population_projected is None and "estimated_population_projected" in self.model_fields_set: + _dict['estimatedPopulationProjected'] = None + + # set to None if phase1_population_projected (nullable) is None + # and model_fields_set contains the field + if self.phase1_population_projected is None and "phase1_population_projected" in self.model_fields_set: + _dict['phase1PopulationProjected'] = None + + # set to None if phase1_percentage_projected (nullable) is None + # and model_fields_set contains the field + if self.phase1_percentage_projected is None and "phase1_percentage_projected" in self.model_fields_set: + _dict['phase1PercentageProjected'] = None + + # set to None if phase2_population_projected (nullable) is None + # and model_fields_set contains the field + if self.phase2_population_projected is None and "phase2_population_projected" in self.model_fields_set: + _dict['phase2PopulationProjected'] = None + + # set to None if phase2_percentage_projected (nullable) is None + # and model_fields_set contains the field + if self.phase2_percentage_projected is None and "phase2_percentage_projected" in self.model_fields_set: + _dict['phase2PercentageProjected'] = None + + # set to None if phase3_population_projected (nullable) is None + # and model_fields_set contains the field + if self.phase3_population_projected is None and "phase3_population_projected" in self.model_fields_set: + _dict['phase3PopulationProjected'] = None + + # set to None if phase3_percentage_projected (nullable) is None + # and model_fields_set contains the field + if self.phase3_percentage_projected is None and "phase3_percentage_projected" in self.model_fields_set: + _dict['phase3PercentageProjected'] = None + + # set to None if phase4_population_projected (nullable) is None + # and model_fields_set contains the field + if self.phase4_population_projected is None and "phase4_population_projected" in self.model_fields_set: + _dict['phase4PopulationProjected'] = None + + # set to None if phase4_percentage_projected (nullable) is None + # and model_fields_set contains the field + if self.phase4_percentage_projected is None and "phase4_percentage_projected" in self.model_fields_set: + _dict['phase4PercentageProjected'] = None + + # set to None if phase5_population_projected (nullable) is None + # and model_fields_set contains the field + if self.phase5_population_projected is None and "phase5_population_projected" in self.model_fields_set: + _dict['phase5PopulationProjected'] = None + + # set to None if phase5_percentage_projected (nullable) is None + # and model_fields_set contains the field + if self.phase5_percentage_projected is None and "phase5_percentage_projected" in self.model_fields_set: + _dict['phase5PercentageProjected'] = None + + # set to None if phase3_plus_population_second_projected (nullable) is None + # and model_fields_set contains the field + if self.phase3_plus_population_second_projected is None and "phase3_plus_population_second_projected" in self.model_fields_set: + _dict['phase3PlusPopulationSecondProjected'] = None + + # set to None if phase3_plus_percentage_second_projected (nullable) is None + # and model_fields_set contains the field + if self.phase3_plus_percentage_second_projected is None and "phase3_plus_percentage_second_projected" in self.model_fields_set: + _dict['phase3PlusPercentageSecondProjected'] = None + + # set to None if estimated_population_second_projected (nullable) is None + # and model_fields_set contains the field + if self.estimated_population_second_projected is None and "estimated_population_second_projected" in self.model_fields_set: + _dict['estimatedPopulationSecondProjected'] = None + + # set to None if phase1_population_second_projected (nullable) is None + # and model_fields_set contains the field + if self.phase1_population_second_projected is None and "phase1_population_second_projected" in self.model_fields_set: + _dict['phase1PopulationSecondProjected'] = None + + # set to None if phase1_percentage_second_projected (nullable) is None + # and model_fields_set contains the field + if self.phase1_percentage_second_projected is None and "phase1_percentage_second_projected" in self.model_fields_set: + _dict['phase1PercentageSecondProjected'] = None + + # set to None if phase2_population_second_projected (nullable) is None + # and model_fields_set contains the field + if self.phase2_population_second_projected is None and "phase2_population_second_projected" in self.model_fields_set: + _dict['phase2PopulationSecondProjected'] = None + + # set to None if phase2_percentage_second_projected (nullable) is None + # and model_fields_set contains the field + if self.phase2_percentage_second_projected is None and "phase2_percentage_second_projected" in self.model_fields_set: + _dict['phase2PercentageSecondProjected'] = None + + # set to None if phase3_population_second_projected (nullable) is None + # and model_fields_set contains the field + if self.phase3_population_second_projected is None and "phase3_population_second_projected" in self.model_fields_set: + _dict['phase3PopulationSecondProjected'] = None + + # set to None if phase3_percentage_second_projected (nullable) is None + # and model_fields_set contains the field + if self.phase3_percentage_second_projected is None and "phase3_percentage_second_projected" in self.model_fields_set: + _dict['phase3PercentageSecondProjected'] = None + + # set to None if phase4_population_second_projected (nullable) is None + # and model_fields_set contains the field + if self.phase4_population_second_projected is None and "phase4_population_second_projected" in self.model_fields_set: + _dict['phase4PopulationSecondProjected'] = None + + # set to None if phase4_percentage_second_projected (nullable) is None + # and model_fields_set contains the field + if self.phase4_percentage_second_projected is None and "phase4_percentage_second_projected" in self.model_fields_set: + _dict['phase4PercentageSecondProjected'] = None + + # set to None if phase5_population_second_projected (nullable) is None + # and model_fields_set contains the field + if self.phase5_population_second_projected is None and "phase5_population_second_projected" in self.model_fields_set: + _dict['phase5PopulationSecondProjected'] = None + + # set to None if phase5_percentage_second_projected (nullable) is None + # and model_fields_set contains the field + if self.phase5_percentage_second_projected is None and "phase5_percentage_second_projected" in self.model_fields_set: + _dict['phase5PercentageSecondProjected'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IpcHistoricalDatumDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "analysisId": obj.get("analysisId"), + "analysisTitle": obj.get("analysisTitle"), + "iso3Alpha3": obj.get("iso3Alpha3"), + "countryName": obj.get("countryName"), + "analysisDate": obj.get("analysisDate"), + "StartDate_CurrentPeriod": obj.get("StartDate_CurrentPeriod"), + "EndDate_CurrentPeriod": obj.get("EndDate_CurrentPeriod"), + "StartDate_ProjectedPeriod": obj.get("StartDate_ProjectedPeriod"), + "EndDate_ProjectedPeriod": obj.get("EndDate_ProjectedPeriod"), + "StartDate_SecondProjectedPeriod": obj.get("StartDate_SecondProjectedPeriod"), + "EndDate_SecondProjectedPeriod": obj.get("EndDate_SecondProjectedPeriod"), + "population": obj.get("population"), + "populationPercentage": obj.get("populationPercentage"), + "phase3PlusPopulation": obj.get("phase3PlusPopulation"), + "phase3PlusPercentage": obj.get("phase3PlusPercentage"), + "estimatedPopulation": obj.get("estimatedPopulation"), + "phase1Population": obj.get("phase1Population"), + "phase1Percentage": obj.get("phase1Percentage"), + "phase2Population": obj.get("phase2Population"), + "phase2Percentage": obj.get("phase2Percentage"), + "phase3Population": obj.get("phase3Population"), + "phase3Percentage": obj.get("phase3Percentage"), + "phase4Population": obj.get("phase4Population"), + "phase4Percentage": obj.get("phase4Percentage"), + "phase5Population": obj.get("phase5Population"), + "phase5Percentage": obj.get("phase5Percentage"), + "phase3PlusPopulationProjected": obj.get("phase3PlusPopulationProjected"), + "phase3PlusPercentageProjected": obj.get("phase3PlusPercentageProjected"), + "estimatedPopulationProjected": obj.get("estimatedPopulationProjected"), + "phase1PopulationProjected": obj.get("phase1PopulationProjected"), + "phase1PercentageProjected": obj.get("phase1PercentageProjected"), + "phase2PopulationProjected": obj.get("phase2PopulationProjected"), + "phase2PercentageProjected": obj.get("phase2PercentageProjected"), + "phase3PopulationProjected": obj.get("phase3PopulationProjected"), + "phase3PercentageProjected": obj.get("phase3PercentageProjected"), + "phase4PopulationProjected": obj.get("phase4PopulationProjected"), + "phase4PercentageProjected": obj.get("phase4PercentageProjected"), + "phase5PopulationProjected": obj.get("phase5PopulationProjected"), + "phase5PercentageProjected": obj.get("phase5PercentageProjected"), + "phase3PlusPopulationSecondProjected": obj.get("phase3PlusPopulationSecondProjected"), + "phase3PlusPercentageSecondProjected": obj.get("phase3PlusPercentageSecondProjected"), + "estimatedPopulationSecondProjected": obj.get("estimatedPopulationSecondProjected"), + "phase1PopulationSecondProjected": obj.get("phase1PopulationSecondProjected"), + "phase1PercentageSecondProjected": obj.get("phase1PercentageSecondProjected"), + "phase2PopulationSecondProjected": obj.get("phase2PopulationSecondProjected"), + "phase2PercentageSecondProjected": obj.get("phase2PercentageSecondProjected"), + "phase3PopulationSecondProjected": obj.get("phase3PopulationSecondProjected"), + "phase3PercentageSecondProjected": obj.get("phase3PercentageSecondProjected"), + "phase4PopulationSecondProjected": obj.get("phase4PopulationSecondProjected"), + "phase4PercentageSecondProjected": obj.get("phase4PercentageSecondProjected"), + "phase5PopulationSecondProjected": obj.get("phase5PopulationSecondProjected"), + "phase5PercentageSecondProjected": obj.get("phase5PercentageSecondProjected") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/view_extended_alps_value_paged_result.py b/data_bridges_client/models/ipc_historical_datum_dto_paged_result.py similarity index 89% rename from data_bridges_client/models/view_extended_alps_value_paged_result.py rename to data_bridges_client/models/ipc_historical_datum_dto_paged_result.py index d95588f..2e952f6 100644 --- a/data_bridges_client/models/view_extended_alps_value_paged_result.py +++ b/data_bridges_client/models/ipc_historical_datum_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -20,15 +20,15 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt from typing import Any, ClassVar, Dict, List, Optional -from data_bridges_client.models.view_extended_alps_value import ViewExtendedAlpsValue +from data_bridges_client.models.ipc_historical_datum_dto import IpcHistoricalDatumDto from typing import Optional, Set from typing_extensions import Self -class ViewExtendedAlpsValuePagedResult(BaseModel): +class IpcHistoricalDatumDtoPagedResult(BaseModel): """ - ViewExtendedAlpsValuePagedResult + IpcHistoricalDatumDtoPagedResult """ # noqa: E501 - items: Optional[List[ViewExtendedAlpsValue]] = None + items: Optional[List[IpcHistoricalDatumDto]] = None page: Optional[StrictInt] = None total_items: Optional[StrictInt] = Field(default=None, alias="totalItems") additional_properties: Dict[str, Any] = {} @@ -52,7 +52,7 @@ def to_json(self) -> str: @classmethod def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of ViewExtendedAlpsValuePagedResult from a JSON string""" + """Create an instance of IpcHistoricalDatumDtoPagedResult from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: @@ -98,7 +98,7 @@ def to_dict(self) -> Dict[str, Any]: @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of ViewExtendedAlpsValuePagedResult from a dict""" + """Create an instance of IpcHistoricalDatumDtoPagedResult from a dict""" if obj is None: return None @@ -106,7 +106,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "items": [ViewExtendedAlpsValue.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, + "items": [IpcHistoricalDatumDto.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, "page": obj.get("page"), "totalItems": obj.get("totalItems") }) diff --git a/data_bridges_client/models/ipc_value.py b/data_bridges_client/models/ipc_value.py deleted file mode 100644 index 016369a..0000000 --- a/data_bridges_client/models/ipc_value.py +++ /dev/null @@ -1,270 +0,0 @@ -# coding: utf-8 - -""" - VAM-Data-Bridges - - API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern - - The version of the OpenAPI document: 6.0.0 - Contact: wfp.economicanalysis@wfp.org - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - - -from __future__ import annotations -import pprint -import re # noqa: F401 -import json - -from datetime import datetime -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union -from typing import Optional, Set -from typing_extensions import Self - -class IpcValue(BaseModel): - """ - IpcValue - """ # noqa: E501 - ipc_id: Optional[StrictInt] = Field(default=None, alias="ipcId") - ipc_year: Optional[StrictInt] = Field(default=None, alias="ipcYear") - ipc_update_date: Optional[datetime] = Field(default=None, alias="ipcUpdateDate") - iso3_alpha3: Optional[StrictStr] = Field(default=None, alias="iso3Alpha3") - ipc_country_name: Optional[StrictStr] = Field(default=None, alias="ipcCountryName") - ipc_area_name: Optional[StrictStr] = Field(default=None, alias="ipcAreaName") - ipc_phase3_population: Optional[StrictInt] = Field(default=None, alias="ipcPhase3Population") - ipc_phase4_population: Optional[StrictInt] = Field(default=None, alias="ipcPhase4Population") - ipc_phase5_population: Optional[StrictInt] = Field(default=None, alias="ipcPhase5Population") - ipc_phase35population: Optional[StrictInt] = Field(default=None, alias="ipcPhase35population") - ipc_phase45population: Optional[StrictInt] = Field(default=None, alias="ipcPhase45population") - ipc_phase3_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="ipcPhase3Percentage") - ipc_phase4_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="ipcPhase4Percentage") - ipc_phase5_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="ipcPhase5Percentage") - ipc_phase35percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="ipcPhase35percentage") - ipc_phase45percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="ipcPhase45percentage") - ipc_analysed_population: Optional[StrictInt] = Field(default=None, alias="ipcAnalysedPopulation") - ipc_analysed_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="ipcAnalysedPercentage") - ipc_analysis_comment: Optional[StrictStr] = Field(default=None, alias="ipcAnalysisComment") - ipc_data_type: Optional[StrictStr] = Field(default=None, alias="ipcDataType") - ipc_data_source: Optional[StrictStr] = Field(default=None, alias="ipcDataSource") - ipc_reference_period: Optional[StrictStr] = Field(default=None, alias="ipcReferencePeriod") - ipc_create_date: Optional[datetime] = Field(default=None, alias="ipcCreateDate") - ipc_show_on_data_viz: Optional[StrictBool] = Field(default=None, alias="ipcShowOnDataViz") - ipc_is_latest_value: Optional[StrictBool] = Field(default=None, alias="ipcIsLatestValue") - additional_properties: Dict[str, Any] = {} - __properties: ClassVar[List[str]] = ["ipcId", "ipcYear", "ipcUpdateDate", "iso3Alpha3", "ipcCountryName", "ipcAreaName", "ipcPhase3Population", "ipcPhase4Population", "ipcPhase5Population", "ipcPhase35population", "ipcPhase45population", "ipcPhase3Percentage", "ipcPhase4Percentage", "ipcPhase5Percentage", "ipcPhase35percentage", "ipcPhase45percentage", "ipcAnalysedPopulation", "ipcAnalysedPercentage", "ipcAnalysisComment", "ipcDataType", "ipcDataSource", "ipcReferencePeriod", "ipcCreateDate", "ipcShowOnDataViz", "ipcIsLatestValue"] - - model_config = ConfigDict( - populate_by_name=True, - validate_assignment=True, - protected_namespaces=(), - ) - - - def to_str(self) -> str: - """Returns the string representation of the model using alias""" - return pprint.pformat(self.model_dump(by_alias=True)) - - def to_json(self) -> str: - """Returns the JSON representation of the model using alias""" - # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead - return json.dumps(self.to_dict()) - - @classmethod - def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of IpcValue from a JSON string""" - return cls.from_dict(json.loads(json_str)) - - def to_dict(self) -> Dict[str, Any]: - """Return the dictionary representation of the model using alias. - - This has the following differences from calling pydantic's - `self.model_dump(by_alias=True)`: - - * `None` is only added to the output dict for nullable fields that - were set at model initialization. Other fields with value `None` - are ignored. - * Fields in `self.additional_properties` are added to the output dict. - """ - excluded_fields: Set[str] = set([ - "additional_properties", - ]) - - _dict = self.model_dump( - by_alias=True, - exclude=excluded_fields, - exclude_none=True, - ) - # puts key-value pairs in additional_properties in the top level - if self.additional_properties is not None: - for _key, _value in self.additional_properties.items(): - _dict[_key] = _value - - # set to None if ipc_year (nullable) is None - # and model_fields_set contains the field - if self.ipc_year is None and "ipc_year" in self.model_fields_set: - _dict['ipcYear'] = None - - # set to None if ipc_update_date (nullable) is None - # and model_fields_set contains the field - if self.ipc_update_date is None and "ipc_update_date" in self.model_fields_set: - _dict['ipcUpdateDate'] = None - - # set to None if iso3_alpha3 (nullable) is None - # and model_fields_set contains the field - if self.iso3_alpha3 is None and "iso3_alpha3" in self.model_fields_set: - _dict['iso3Alpha3'] = None - - # set to None if ipc_country_name (nullable) is None - # and model_fields_set contains the field - if self.ipc_country_name is None and "ipc_country_name" in self.model_fields_set: - _dict['ipcCountryName'] = None - - # set to None if ipc_area_name (nullable) is None - # and model_fields_set contains the field - if self.ipc_area_name is None and "ipc_area_name" in self.model_fields_set: - _dict['ipcAreaName'] = None - - # set to None if ipc_phase3_population (nullable) is None - # and model_fields_set contains the field - if self.ipc_phase3_population is None and "ipc_phase3_population" in self.model_fields_set: - _dict['ipcPhase3Population'] = None - - # set to None if ipc_phase4_population (nullable) is None - # and model_fields_set contains the field - if self.ipc_phase4_population is None and "ipc_phase4_population" in self.model_fields_set: - _dict['ipcPhase4Population'] = None - - # set to None if ipc_phase5_population (nullable) is None - # and model_fields_set contains the field - if self.ipc_phase5_population is None and "ipc_phase5_population" in self.model_fields_set: - _dict['ipcPhase5Population'] = None - - # set to None if ipc_phase35population (nullable) is None - # and model_fields_set contains the field - if self.ipc_phase35population is None and "ipc_phase35population" in self.model_fields_set: - _dict['ipcPhase35population'] = None - - # set to None if ipc_phase45population (nullable) is None - # and model_fields_set contains the field - if self.ipc_phase45population is None and "ipc_phase45population" in self.model_fields_set: - _dict['ipcPhase45population'] = None - - # set to None if ipc_phase3_percentage (nullable) is None - # and model_fields_set contains the field - if self.ipc_phase3_percentage is None and "ipc_phase3_percentage" in self.model_fields_set: - _dict['ipcPhase3Percentage'] = None - - # set to None if ipc_phase4_percentage (nullable) is None - # and model_fields_set contains the field - if self.ipc_phase4_percentage is None and "ipc_phase4_percentage" in self.model_fields_set: - _dict['ipcPhase4Percentage'] = None - - # set to None if ipc_phase5_percentage (nullable) is None - # and model_fields_set contains the field - if self.ipc_phase5_percentage is None and "ipc_phase5_percentage" in self.model_fields_set: - _dict['ipcPhase5Percentage'] = None - - # set to None if ipc_phase35percentage (nullable) is None - # and model_fields_set contains the field - if self.ipc_phase35percentage is None and "ipc_phase35percentage" in self.model_fields_set: - _dict['ipcPhase35percentage'] = None - - # set to None if ipc_phase45percentage (nullable) is None - # and model_fields_set contains the field - if self.ipc_phase45percentage is None and "ipc_phase45percentage" in self.model_fields_set: - _dict['ipcPhase45percentage'] = None - - # set to None if ipc_analysed_population (nullable) is None - # and model_fields_set contains the field - if self.ipc_analysed_population is None and "ipc_analysed_population" in self.model_fields_set: - _dict['ipcAnalysedPopulation'] = None - - # set to None if ipc_analysed_percentage (nullable) is None - # and model_fields_set contains the field - if self.ipc_analysed_percentage is None and "ipc_analysed_percentage" in self.model_fields_set: - _dict['ipcAnalysedPercentage'] = None - - # set to None if ipc_analysis_comment (nullable) is None - # and model_fields_set contains the field - if self.ipc_analysis_comment is None and "ipc_analysis_comment" in self.model_fields_set: - _dict['ipcAnalysisComment'] = None - - # set to None if ipc_data_type (nullable) is None - # and model_fields_set contains the field - if self.ipc_data_type is None and "ipc_data_type" in self.model_fields_set: - _dict['ipcDataType'] = None - - # set to None if ipc_data_source (nullable) is None - # and model_fields_set contains the field - if self.ipc_data_source is None and "ipc_data_source" in self.model_fields_set: - _dict['ipcDataSource'] = None - - # set to None if ipc_reference_period (nullable) is None - # and model_fields_set contains the field - if self.ipc_reference_period is None and "ipc_reference_period" in self.model_fields_set: - _dict['ipcReferencePeriod'] = None - - # set to None if ipc_create_date (nullable) is None - # and model_fields_set contains the field - if self.ipc_create_date is None and "ipc_create_date" in self.model_fields_set: - _dict['ipcCreateDate'] = None - - # set to None if ipc_show_on_data_viz (nullable) is None - # and model_fields_set contains the field - if self.ipc_show_on_data_viz is None and "ipc_show_on_data_viz" in self.model_fields_set: - _dict['ipcShowOnDataViz'] = None - - # set to None if ipc_is_latest_value (nullable) is None - # and model_fields_set contains the field - if self.ipc_is_latest_value is None and "ipc_is_latest_value" in self.model_fields_set: - _dict['ipcIsLatestValue'] = None - - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IpcValue from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _obj = cls.model_validate({ - "ipcId": obj.get("ipcId"), - "ipcYear": obj.get("ipcYear"), - "ipcUpdateDate": obj.get("ipcUpdateDate"), - "iso3Alpha3": obj.get("iso3Alpha3"), - "ipcCountryName": obj.get("ipcCountryName"), - "ipcAreaName": obj.get("ipcAreaName"), - "ipcPhase3Population": obj.get("ipcPhase3Population"), - "ipcPhase4Population": obj.get("ipcPhase4Population"), - "ipcPhase5Population": obj.get("ipcPhase5Population"), - "ipcPhase35population": obj.get("ipcPhase35population"), - "ipcPhase45population": obj.get("ipcPhase45population"), - "ipcPhase3Percentage": obj.get("ipcPhase3Percentage"), - "ipcPhase4Percentage": obj.get("ipcPhase4Percentage"), - "ipcPhase5Percentage": obj.get("ipcPhase5Percentage"), - "ipcPhase35percentage": obj.get("ipcPhase35percentage"), - "ipcPhase45percentage": obj.get("ipcPhase45percentage"), - "ipcAnalysedPopulation": obj.get("ipcAnalysedPopulation"), - "ipcAnalysedPercentage": obj.get("ipcAnalysedPercentage"), - "ipcAnalysisComment": obj.get("ipcAnalysisComment"), - "ipcDataType": obj.get("ipcDataType"), - "ipcDataSource": obj.get("ipcDataSource"), - "ipcReferencePeriod": obj.get("ipcReferencePeriod"), - "ipcCreateDate": obj.get("ipcCreateDate"), - "ipcShowOnDataViz": obj.get("ipcShowOnDataViz"), - "ipcIsLatestValue": obj.get("ipcIsLatestValue") - }) - # store additional fields in additional_properties - for _key in obj.keys(): - if _key not in cls.__properties: - _obj.additional_properties[_key] = obj.get(_key) - - return _obj - - diff --git a/data_bridges_client/models/ipcch_and_equivalent_peaks_dto.py b/data_bridges_client/models/ipcch_and_equivalent_peaks_dto.py new file mode 100644 index 0000000..a27e563 --- /dev/null +++ b/data_bridges_client/models/ipcch_and_equivalent_peaks_dto.py @@ -0,0 +1,155 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class IpcchAndEquivalentPeaksDTO(BaseModel): + """ + IpcchAndEquivalentPeaksDTO + """ # noqa: E501 + regional_bureau_id: Optional[StrictInt] = Field(default=None, alias="regionalBureauID") + regional_bureau_name: Optional[StrictStr] = Field(default=None, alias="regionalBureauName") + iso3_alpha3: Optional[StrictStr] = Field(default=None, alias="iso3Alpha3") + country_name: Optional[StrictStr] = Field(default=None, alias="countryName") + phase3_population: Optional[StrictInt] = Field(default=None, alias="phase3Population") + phase4_population: Optional[StrictInt] = Field(default=None, alias="phase4Population") + phase5_population: Optional[StrictInt] = Field(default=None, alias="phase5Population") + phase3_plus_population: Optional[StrictInt] = Field(default=None, alias="phase3PlusPopulation") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["regionalBureauID", "regionalBureauName", "iso3Alpha3", "countryName", "phase3Population", "phase4Population", "phase5Population", "phase3PlusPopulation"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IpcchAndEquivalentPeaksDTO from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if regional_bureau_id (nullable) is None + # and model_fields_set contains the field + if self.regional_bureau_id is None and "regional_bureau_id" in self.model_fields_set: + _dict['regionalBureauID'] = None + + # set to None if regional_bureau_name (nullable) is None + # and model_fields_set contains the field + if self.regional_bureau_name is None and "regional_bureau_name" in self.model_fields_set: + _dict['regionalBureauName'] = None + + # set to None if iso3_alpha3 (nullable) is None + # and model_fields_set contains the field + if self.iso3_alpha3 is None and "iso3_alpha3" in self.model_fields_set: + _dict['iso3Alpha3'] = None + + # set to None if country_name (nullable) is None + # and model_fields_set contains the field + if self.country_name is None and "country_name" in self.model_fields_set: + _dict['countryName'] = None + + # set to None if phase3_population (nullable) is None + # and model_fields_set contains the field + if self.phase3_population is None and "phase3_population" in self.model_fields_set: + _dict['phase3Population'] = None + + # set to None if phase4_population (nullable) is None + # and model_fields_set contains the field + if self.phase4_population is None and "phase4_population" in self.model_fields_set: + _dict['phase4Population'] = None + + # set to None if phase5_population (nullable) is None + # and model_fields_set contains the field + if self.phase5_population is None and "phase5_population" in self.model_fields_set: + _dict['phase5Population'] = None + + # set to None if phase3_plus_population (nullable) is None + # and model_fields_set contains the field + if self.phase3_plus_population is None and "phase3_plus_population" in self.model_fields_set: + _dict['phase3PlusPopulation'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IpcchAndEquivalentPeaksDTO from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "regionalBureauID": obj.get("regionalBureauID"), + "regionalBureauName": obj.get("regionalBureauName"), + "iso3Alpha3": obj.get("iso3Alpha3"), + "countryName": obj.get("countryName"), + "phase3Population": obj.get("phase3Population"), + "phase4Population": obj.get("phase4Population"), + "phase5Population": obj.get("phase5Population"), + "phase3PlusPopulation": obj.get("phase3PlusPopulation") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/ipcch_and_equivalent_peaks_dto_paged_result.py b/data_bridges_client/models/ipcch_and_equivalent_peaks_dto_paged_result.py new file mode 100644 index 0000000..362cad9 --- /dev/null +++ b/data_bridges_client/models/ipcch_and_equivalent_peaks_dto_paged_result.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from data_bridges_client.models.ipcch_and_equivalent_peaks_dto import IpcchAndEquivalentPeaksDTO +from typing import Optional, Set +from typing_extensions import Self + +class IpcchAndEquivalentPeaksDTOPagedResult(BaseModel): + """ + IpcchAndEquivalentPeaksDTOPagedResult + """ # noqa: E501 + items: Optional[List[IpcchAndEquivalentPeaksDTO]] = None + page: Optional[StrictInt] = None + total_items: Optional[StrictInt] = Field(default=None, alias="totalItems") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["items", "page", "totalItems"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IpcchAndEquivalentPeaksDTOPagedResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "items", + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) + _dict['items'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if items (nullable) is None + # and model_fields_set contains the field + if self.items is None and "items" in self.model_fields_set: + _dict['items'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IpcchAndEquivalentPeaksDTOPagedResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [IpcchAndEquivalentPeaksDTO.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, + "page": obj.get("page"), + "totalItems": obj.get("totalItems") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/ipcch_base_dto.py b/data_bridges_client/models/ipcch_base_dto.py new file mode 100644 index 0000000..134699d --- /dev/null +++ b/data_bridges_client/models/ipcch_base_dto.py @@ -0,0 +1,256 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class IpcchBaseDto(BaseModel): + """ + IpcchBaseDto + """ # noqa: E501 + iso3_alpha3: Optional[StrictStr] = Field(default=None, alias="iso3Alpha3") + country_name: Optional[StrictStr] = Field(default=None, alias="countryName") + population_group_id: Optional[StrictInt] = Field(default=None, alias="populationGroupId") + population_group_name: Optional[StrictStr] = Field(default=None, alias="populationGroupName") + analysis_title: Optional[StrictStr] = Field(default=None, alias="analysisTitle") + analysis_date: Optional[datetime] = Field(default=None, alias="analysisDate") + period_start: Optional[datetime] = Field(default=None, alias="periodStart") + period_end: Optional[datetime] = Field(default=None, alias="periodEnd") + period_type: Optional[StrictStr] = Field(default=None, alias="periodType") + population: Optional[Union[StrictFloat, StrictInt]] = None + population_analysed: Optional[StrictInt] = Field(default=None, alias="populationAnalysed") + population_analysed_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="populationAnalysedPercentage") + phase3_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3Population") + phase4_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase4Population") + phase5_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase5Population") + phase3_plus_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3PlusPopulation") + phase4_plus_population: Optional[StrictInt] = Field(default=None, alias="phase4PlusPopulation") + phase3_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3Percentage") + phase4_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase4Percentage") + phase5_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase5Percentage") + phase3_plus_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3PlusPercentage") + phase4_plus_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase4PlusPercentage") + data_source: Optional[StrictStr] = Field(default=None, alias="dataSource") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["iso3Alpha3", "countryName", "populationGroupId", "populationGroupName", "analysisTitle", "analysisDate", "periodStart", "periodEnd", "periodType", "population", "populationAnalysed", "populationAnalysedPercentage", "phase3Population", "phase4Population", "phase5Population", "phase3PlusPopulation", "phase4PlusPopulation", "phase3Percentage", "phase4Percentage", "phase5Percentage", "phase3PlusPercentage", "phase4PlusPercentage", "dataSource"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IpcchBaseDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if iso3_alpha3 (nullable) is None + # and model_fields_set contains the field + if self.iso3_alpha3 is None and "iso3_alpha3" in self.model_fields_set: + _dict['iso3Alpha3'] = None + + # set to None if country_name (nullable) is None + # and model_fields_set contains the field + if self.country_name is None and "country_name" in self.model_fields_set: + _dict['countryName'] = None + + # set to None if population_group_name (nullable) is None + # and model_fields_set contains the field + if self.population_group_name is None and "population_group_name" in self.model_fields_set: + _dict['populationGroupName'] = None + + # set to None if analysis_title (nullable) is None + # and model_fields_set contains the field + if self.analysis_title is None and "analysis_title" in self.model_fields_set: + _dict['analysisTitle'] = None + + # set to None if analysis_date (nullable) is None + # and model_fields_set contains the field + if self.analysis_date is None and "analysis_date" in self.model_fields_set: + _dict['analysisDate'] = None + + # set to None if period_start (nullable) is None + # and model_fields_set contains the field + if self.period_start is None and "period_start" in self.model_fields_set: + _dict['periodStart'] = None + + # set to None if period_end (nullable) is None + # and model_fields_set contains the field + if self.period_end is None and "period_end" in self.model_fields_set: + _dict['periodEnd'] = None + + # set to None if period_type (nullable) is None + # and model_fields_set contains the field + if self.period_type is None and "period_type" in self.model_fields_set: + _dict['periodType'] = None + + # set to None if population (nullable) is None + # and model_fields_set contains the field + if self.population is None and "population" in self.model_fields_set: + _dict['population'] = None + + # set to None if population_analysed (nullable) is None + # and model_fields_set contains the field + if self.population_analysed is None and "population_analysed" in self.model_fields_set: + _dict['populationAnalysed'] = None + + # set to None if population_analysed_percentage (nullable) is None + # and model_fields_set contains the field + if self.population_analysed_percentage is None and "population_analysed_percentage" in self.model_fields_set: + _dict['populationAnalysedPercentage'] = None + + # set to None if phase3_population (nullable) is None + # and model_fields_set contains the field + if self.phase3_population is None and "phase3_population" in self.model_fields_set: + _dict['phase3Population'] = None + + # set to None if phase4_population (nullable) is None + # and model_fields_set contains the field + if self.phase4_population is None and "phase4_population" in self.model_fields_set: + _dict['phase4Population'] = None + + # set to None if phase5_population (nullable) is None + # and model_fields_set contains the field + if self.phase5_population is None and "phase5_population" in self.model_fields_set: + _dict['phase5Population'] = None + + # set to None if phase3_plus_population (nullable) is None + # and model_fields_set contains the field + if self.phase3_plus_population is None and "phase3_plus_population" in self.model_fields_set: + _dict['phase3PlusPopulation'] = None + + # set to None if phase4_plus_population (nullable) is None + # and model_fields_set contains the field + if self.phase4_plus_population is None and "phase4_plus_population" in self.model_fields_set: + _dict['phase4PlusPopulation'] = None + + # set to None if phase3_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase3_percentage is None and "phase3_percentage" in self.model_fields_set: + _dict['phase3Percentage'] = None + + # set to None if phase4_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase4_percentage is None and "phase4_percentage" in self.model_fields_set: + _dict['phase4Percentage'] = None + + # set to None if phase5_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase5_percentage is None and "phase5_percentage" in self.model_fields_set: + _dict['phase5Percentage'] = None + + # set to None if phase3_plus_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase3_plus_percentage is None and "phase3_plus_percentage" in self.model_fields_set: + _dict['phase3PlusPercentage'] = None + + # set to None if phase4_plus_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase4_plus_percentage is None and "phase4_plus_percentage" in self.model_fields_set: + _dict['phase4PlusPercentage'] = None + + # set to None if data_source (nullable) is None + # and model_fields_set contains the field + if self.data_source is None and "data_source" in self.model_fields_set: + _dict['dataSource'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IpcchBaseDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "iso3Alpha3": obj.get("iso3Alpha3"), + "countryName": obj.get("countryName"), + "populationGroupId": obj.get("populationGroupId"), + "populationGroupName": obj.get("populationGroupName"), + "analysisTitle": obj.get("analysisTitle"), + "analysisDate": obj.get("analysisDate"), + "periodStart": obj.get("periodStart"), + "periodEnd": obj.get("periodEnd"), + "periodType": obj.get("periodType"), + "population": obj.get("population"), + "populationAnalysed": obj.get("populationAnalysed"), + "populationAnalysedPercentage": obj.get("populationAnalysedPercentage"), + "phase3Population": obj.get("phase3Population"), + "phase4Population": obj.get("phase4Population"), + "phase5Population": obj.get("phase5Population"), + "phase3PlusPopulation": obj.get("phase3PlusPopulation"), + "phase4PlusPopulation": obj.get("phase4PlusPopulation"), + "phase3Percentage": obj.get("phase3Percentage"), + "phase4Percentage": obj.get("phase4Percentage"), + "phase5Percentage": obj.get("phase5Percentage"), + "phase3PlusPercentage": obj.get("phase3PlusPercentage"), + "phase4PlusPercentage": obj.get("phase4PlusPercentage"), + "dataSource": obj.get("dataSource") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/ipc_value_paged_result.py b/data_bridges_client/models/ipcch_base_dto_paged_result.py similarity index 88% rename from data_bridges_client/models/ipc_value_paged_result.py rename to data_bridges_client/models/ipcch_base_dto_paged_result.py index 33049b5..cc2ca2b 100644 --- a/data_bridges_client/models/ipc_value_paged_result.py +++ b/data_bridges_client/models/ipcch_base_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -20,15 +20,15 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt from typing import Any, ClassVar, Dict, List, Optional -from data_bridges_client.models.ipc_value import IpcValue +from data_bridges_client.models.ipcch_base_dto import IpcchBaseDto from typing import Optional, Set from typing_extensions import Self -class IpcValuePagedResult(BaseModel): +class IpcchBaseDtoPagedResult(BaseModel): """ - IpcValuePagedResult + IpcchBaseDtoPagedResult """ # noqa: E501 - items: Optional[List[IpcValue]] = None + items: Optional[List[IpcchBaseDto]] = None page: Optional[StrictInt] = None total_items: Optional[StrictInt] = Field(default=None, alias="totalItems") additional_properties: Dict[str, Any] = {} @@ -52,7 +52,7 @@ def to_json(self) -> str: @classmethod def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of IpcValuePagedResult from a JSON string""" + """Create an instance of IpcchBaseDtoPagedResult from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: @@ -98,7 +98,7 @@ def to_dict(self) -> Dict[str, Any]: @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of IpcValuePagedResult from a dict""" + """Create an instance of IpcchBaseDtoPagedResult from a dict""" if obj is None: return None @@ -106,7 +106,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "items": [IpcValue.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, + "items": [IpcchBaseDto.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, "page": obj.get("page"), "totalItems": obj.get("totalItems") }) diff --git a/data_bridges_client/models/ipcch_peaks_dto.py b/data_bridges_client/models/ipcch_peaks_dto.py new file mode 100644 index 0000000..abdcf69 --- /dev/null +++ b/data_bridges_client/models/ipcch_peaks_dto.py @@ -0,0 +1,258 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class IpcchPeaksDto(BaseModel): + """ + IpcchPeaksDto + """ # noqa: E501 + iso3_alpha3: Optional[StrictStr] = Field(default=None, alias="iso3Alpha3") + country_name: Optional[StrictStr] = Field(default=None, alias="countryName") + population_group_id: Optional[StrictInt] = Field(default=None, alias="populationGroupId") + population_group_name: Optional[StrictStr] = Field(default=None, alias="populationGroupName") + analysis_title: Optional[StrictStr] = Field(default=None, alias="analysisTitle") + analysis_date: Optional[datetime] = Field(default=None, alias="analysisDate") + period_start: Optional[datetime] = Field(default=None, alias="periodStart") + period_end: Optional[datetime] = Field(default=None, alias="periodEnd") + period_type: Optional[StrictStr] = Field(default=None, alias="periodType") + population: Optional[Union[StrictFloat, StrictInt]] = None + population_analysed: Optional[StrictInt] = Field(default=None, alias="populationAnalysed") + population_analysed_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="populationAnalysedPercentage") + phase3_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3Population") + phase4_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase4Population") + phase5_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase5Population") + phase3_plus_population: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3PlusPopulation") + phase4_plus_population: Optional[StrictInt] = Field(default=None, alias="phase4PlusPopulation") + phase3_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3Percentage") + phase4_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase4Percentage") + phase5_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase5Percentage") + phase3_plus_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase3PlusPercentage") + phase4_plus_percentage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="phase4PlusPercentage") + data_source: Optional[StrictStr] = Field(default=None, alias="dataSource") + reference_year: Optional[StrictInt] = Field(default=None, alias="referenceYear") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["iso3Alpha3", "countryName", "populationGroupId", "populationGroupName", "analysisTitle", "analysisDate", "periodStart", "periodEnd", "periodType", "population", "populationAnalysed", "populationAnalysedPercentage", "phase3Population", "phase4Population", "phase5Population", "phase3PlusPopulation", "phase4PlusPopulation", "phase3Percentage", "phase4Percentage", "phase5Percentage", "phase3PlusPercentage", "phase4PlusPercentage", "dataSource", "referenceYear"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IpcchPeaksDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if iso3_alpha3 (nullable) is None + # and model_fields_set contains the field + if self.iso3_alpha3 is None and "iso3_alpha3" in self.model_fields_set: + _dict['iso3Alpha3'] = None + + # set to None if country_name (nullable) is None + # and model_fields_set contains the field + if self.country_name is None and "country_name" in self.model_fields_set: + _dict['countryName'] = None + + # set to None if population_group_name (nullable) is None + # and model_fields_set contains the field + if self.population_group_name is None and "population_group_name" in self.model_fields_set: + _dict['populationGroupName'] = None + + # set to None if analysis_title (nullable) is None + # and model_fields_set contains the field + if self.analysis_title is None and "analysis_title" in self.model_fields_set: + _dict['analysisTitle'] = None + + # set to None if analysis_date (nullable) is None + # and model_fields_set contains the field + if self.analysis_date is None and "analysis_date" in self.model_fields_set: + _dict['analysisDate'] = None + + # set to None if period_start (nullable) is None + # and model_fields_set contains the field + if self.period_start is None and "period_start" in self.model_fields_set: + _dict['periodStart'] = None + + # set to None if period_end (nullable) is None + # and model_fields_set contains the field + if self.period_end is None and "period_end" in self.model_fields_set: + _dict['periodEnd'] = None + + # set to None if period_type (nullable) is None + # and model_fields_set contains the field + if self.period_type is None and "period_type" in self.model_fields_set: + _dict['periodType'] = None + + # set to None if population (nullable) is None + # and model_fields_set contains the field + if self.population is None and "population" in self.model_fields_set: + _dict['population'] = None + + # set to None if population_analysed (nullable) is None + # and model_fields_set contains the field + if self.population_analysed is None and "population_analysed" in self.model_fields_set: + _dict['populationAnalysed'] = None + + # set to None if population_analysed_percentage (nullable) is None + # and model_fields_set contains the field + if self.population_analysed_percentage is None and "population_analysed_percentage" in self.model_fields_set: + _dict['populationAnalysedPercentage'] = None + + # set to None if phase3_population (nullable) is None + # and model_fields_set contains the field + if self.phase3_population is None and "phase3_population" in self.model_fields_set: + _dict['phase3Population'] = None + + # set to None if phase4_population (nullable) is None + # and model_fields_set contains the field + if self.phase4_population is None and "phase4_population" in self.model_fields_set: + _dict['phase4Population'] = None + + # set to None if phase5_population (nullable) is None + # and model_fields_set contains the field + if self.phase5_population is None and "phase5_population" in self.model_fields_set: + _dict['phase5Population'] = None + + # set to None if phase3_plus_population (nullable) is None + # and model_fields_set contains the field + if self.phase3_plus_population is None and "phase3_plus_population" in self.model_fields_set: + _dict['phase3PlusPopulation'] = None + + # set to None if phase4_plus_population (nullable) is None + # and model_fields_set contains the field + if self.phase4_plus_population is None and "phase4_plus_population" in self.model_fields_set: + _dict['phase4PlusPopulation'] = None + + # set to None if phase3_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase3_percentage is None and "phase3_percentage" in self.model_fields_set: + _dict['phase3Percentage'] = None + + # set to None if phase4_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase4_percentage is None and "phase4_percentage" in self.model_fields_set: + _dict['phase4Percentage'] = None + + # set to None if phase5_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase5_percentage is None and "phase5_percentage" in self.model_fields_set: + _dict['phase5Percentage'] = None + + # set to None if phase3_plus_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase3_plus_percentage is None and "phase3_plus_percentage" in self.model_fields_set: + _dict['phase3PlusPercentage'] = None + + # set to None if phase4_plus_percentage (nullable) is None + # and model_fields_set contains the field + if self.phase4_plus_percentage is None and "phase4_plus_percentage" in self.model_fields_set: + _dict['phase4PlusPercentage'] = None + + # set to None if data_source (nullable) is None + # and model_fields_set contains the field + if self.data_source is None and "data_source" in self.model_fields_set: + _dict['dataSource'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IpcchPeaksDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "iso3Alpha3": obj.get("iso3Alpha3"), + "countryName": obj.get("countryName"), + "populationGroupId": obj.get("populationGroupId"), + "populationGroupName": obj.get("populationGroupName"), + "analysisTitle": obj.get("analysisTitle"), + "analysisDate": obj.get("analysisDate"), + "periodStart": obj.get("periodStart"), + "periodEnd": obj.get("periodEnd"), + "periodType": obj.get("periodType"), + "population": obj.get("population"), + "populationAnalysed": obj.get("populationAnalysed"), + "populationAnalysedPercentage": obj.get("populationAnalysedPercentage"), + "phase3Population": obj.get("phase3Population"), + "phase4Population": obj.get("phase4Population"), + "phase5Population": obj.get("phase5Population"), + "phase3PlusPopulation": obj.get("phase3PlusPopulation"), + "phase4PlusPopulation": obj.get("phase4PlusPopulation"), + "phase3Percentage": obj.get("phase3Percentage"), + "phase4Percentage": obj.get("phase4Percentage"), + "phase5Percentage": obj.get("phase5Percentage"), + "phase3PlusPercentage": obj.get("phase3PlusPercentage"), + "phase4PlusPercentage": obj.get("phase4PlusPercentage"), + "dataSource": obj.get("dataSource"), + "referenceYear": obj.get("referenceYear") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/ipcch_peaks_dto_paged_result.py b/data_bridges_client/models/ipcch_peaks_dto_paged_result.py new file mode 100644 index 0000000..2328d38 --- /dev/null +++ b/data_bridges_client/models/ipcch_peaks_dto_paged_result.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from data_bridges_client.models.ipcch_peaks_dto import IpcchPeaksDto +from typing import Optional, Set +from typing_extensions import Self + +class IpcchPeaksDtoPagedResult(BaseModel): + """ + IpcchPeaksDtoPagedResult + """ # noqa: E501 + items: Optional[List[IpcchPeaksDto]] = None + page: Optional[StrictInt] = None + total_items: Optional[StrictInt] = Field(default=None, alias="totalItems") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["items", "page", "totalItems"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IpcchPeaksDtoPagedResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "items", + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) + _dict['items'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if items (nullable) is None + # and model_fields_set contains the field + if self.items is None and "items" in self.model_fields_set: + _dict['items'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IpcchPeaksDtoPagedResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [IpcchPeaksDto.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, + "page": obj.get("page"), + "totalItems": obj.get("totalItems") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/key_name_dto.py b/data_bridges_client/models/key_name_dto.py index 33bcbee..5faf2ca 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/list_item_dto.py b/data_bridges_client/models/list_item_dto.py new file mode 100644 index 0000000..9a49452 --- /dev/null +++ b/data_bridges_client/models/list_item_dto.py @@ -0,0 +1,115 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class ListItemDto(BaseModel): + """ + ListItemDto + """ # noqa: E501 + id: Optional[StrictInt] = None + name: Optional[StrictStr] + label: Optional[StrictStr] + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["id", "name", "label"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ListItemDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if name (nullable) is None + # and model_fields_set contains the field + if self.name is None and "name" in self.model_fields_set: + _dict['name'] = None + + # set to None if label (nullable) is None + # and model_fields_set contains the field + if self.label is None and "label" in self.model_fields_set: + _dict['label'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ListItemDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "name": obj.get("name"), + "label": obj.get("label") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/market_dto.py b/data_bridges_client/models/market_dto.py index 6e7f419..15ba568 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/market_geo_json_root.py b/data_bridges_client/models/market_geo_json_root.py index b3ee011..455eeaa 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 697a667..8b707e2 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/nearby_markets_dto.py b/data_bridges_client/models/nearby_markets_dto.py index e241704..816d070 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/paged_commodity_list_dto.py b/data_bridges_client/models/paged_commodity_list_dto.py index 99a1621..9d5f5b1 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 475b3c8..9a52216 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 f6d6491..6e9ae72 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 f154e65..70dbe8f 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 dfe63fb..ae50d86 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 0d376cf..4cea267 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 8aa1458..da9e1aa 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/paged_survey_list_dto.py b/data_bridges_client/models/paged_survey_list_dto.py index a611a5e..587fb36 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 1edcbbc..29d73bd 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/paged_xls_form_list_dto.py b/data_bridges_client/models/paged_xls_form_list_dto.py index f6e0dc4..0dec87a 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 0a7192f..225c7ba 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/properties.py b/data_bridges_client/models/properties.py index c5ad823..297eccf 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/rpme_assessment.py b/data_bridges_client/models/rpme_assessment.py index f3cb632..7c5ce11 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 202a59a..5826672 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 9936719..b25e1ad 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/rpme_variable.py b/data_bridges_client/models/rpme_variable.py index 230070f..4803624 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/rpme_variable_paged_result.py b/data_bridges_client/models/rpme_variable_paged_result.py index c408fed..8e1b166 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 15d23c4..8b18855 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/usd_indirect_quotation.py b/data_bridges_client/models/usd_indirect_quotation.py index c8a0d8b..ff2ae41 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/usd_indirect_quotation_paged_result.py b/data_bridges_client/models/usd_indirect_quotation_paged_result.py index 47204a0..51d1099 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/view_extended_aggregated_price.py b/data_bridges_client/models/view_extended_monthly_aggregated_price.py similarity index 91% rename from data_bridges_client/models/view_extended_aggregated_price.py rename to data_bridges_client/models/view_extended_monthly_aggregated_price.py index 1fc00f4..17c3cf1 100644 --- a/data_bridges_client/models/view_extended_aggregated_price.py +++ b/data_bridges_client/models/view_extended_monthly_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -24,15 +24,15 @@ from typing import Optional, Set from typing_extensions import Self -class ViewExtendedAggregatedPrice(BaseModel): +class ViewExtendedMonthlyAggregatedPrice(BaseModel): """ - ViewExtendedAggregatedPrice + ViewExtendedMonthlyAggregatedPrice """ # noqa: E501 - commodity_id: Optional[StrictInt] = Field(default=None, alias="commodityID") - market_id: Optional[StrictInt] = Field(default=None, alias="marketID") - price_type_id: Optional[StrictInt] = Field(default=None, alias="priceTypeID") - commodity_unit_id: Optional[StrictInt] = Field(default=None, alias="commodityUnitID") - currency_id: Optional[StrictInt] = Field(default=None, alias="currencyID") + commodity_id: Optional[StrictInt] = Field(default=None, alias="commodityId") + market_id: Optional[StrictInt] = Field(default=None, alias="marketId") + price_type_id: Optional[StrictInt] = Field(default=None, alias="priceTypeId") + commodity_unit_id: Optional[StrictInt] = Field(default=None, alias="commodityUnitId") + currency_id: Optional[StrictInt] = Field(default=None, alias="currencyId") adm0_code: Optional[StrictInt] = Field(default=None, alias="adm0Code") commodity_date_week: Optional[StrictInt] = Field(default=None, alias="commodityDateWeek") commodity_date_month: Optional[StrictInt] = Field(default=None, alias="commodityDateMonth") @@ -43,7 +43,7 @@ class ViewExtendedAggregatedPrice(BaseModel): price_type_name: Optional[StrictStr] = Field(default=None, alias="priceTypeName") commodity_unit_name: Optional[StrictStr] = Field(default=None, alias="commodityUnitName") currency_name: Optional[StrictStr] = Field(default=None, alias="currencyName") - country_iso3: Optional[StrictStr] = Field(default=None, alias="countryISO3") + country_iso3: Optional[StrictStr] = Field(default=None, alias="countryIso3") country_name: Optional[StrictStr] = Field(default=None, alias="countryName") commodity_price_source_name: Optional[StrictStr] = Field(default=None, alias="commodityPriceSourceName") original_frequency: Optional[StrictStr] = Field(default=None, alias="originalFrequency") @@ -51,7 +51,7 @@ class ViewExtendedAggregatedPrice(BaseModel): commodity_price_observations: Optional[StrictInt] = Field(default=None, alias="commodityPriceObservations") commodity_price_flag: Optional[StrictStr] = Field(default=None, alias="commodityPriceFlag") additional_properties: Dict[str, Any] = {} - __properties: ClassVar[List[str]] = ["commodityID", "marketID", "priceTypeID", "commodityUnitID", "currencyID", "adm0Code", "commodityDateWeek", "commodityDateMonth", "commodityDateYear", "commodityPriceDate", "commodityName", "marketName", "priceTypeName", "commodityUnitName", "currencyName", "countryISO3", "countryName", "commodityPriceSourceName", "originalFrequency", "commodityPrice", "commodityPriceObservations", "commodityPriceFlag"] + __properties: ClassVar[List[str]] = ["commodityId", "marketId", "priceTypeId", "commodityUnitId", "currencyId", "adm0Code", "commodityDateWeek", "commodityDateMonth", "commodityDateYear", "commodityPriceDate", "commodityName", "marketName", "priceTypeName", "commodityUnitName", "currencyName", "countryIso3", "countryName", "commodityPriceSourceName", "originalFrequency", "commodityPrice", "commodityPriceObservations", "commodityPriceFlag"] model_config = ConfigDict( populate_by_name=True, @@ -71,7 +71,7 @@ def to_json(self) -> str: @classmethod def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of ViewExtendedAggregatedPrice from a JSON string""" + """Create an instance of ViewExtendedMonthlyAggregatedPrice from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: @@ -152,7 +152,7 @@ def to_dict(self) -> Dict[str, Any]: # set to None if country_iso3 (nullable) is None # and model_fields_set contains the field if self.country_iso3 is None and "country_iso3" in self.model_fields_set: - _dict['countryISO3'] = None + _dict['countryIso3'] = None # set to None if country_name (nullable) is None # and model_fields_set contains the field @@ -188,7 +188,7 @@ def to_dict(self) -> Dict[str, Any]: @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of ViewExtendedAggregatedPrice from a dict""" + """Create an instance of ViewExtendedMonthlyAggregatedPrice from a dict""" if obj is None: return None @@ -196,11 +196,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "commodityID": obj.get("commodityID"), - "marketID": obj.get("marketID"), - "priceTypeID": obj.get("priceTypeID"), - "commodityUnitID": obj.get("commodityUnitID"), - "currencyID": obj.get("currencyID"), + "commodityId": obj.get("commodityId"), + "marketId": obj.get("marketId"), + "priceTypeId": obj.get("priceTypeId"), + "commodityUnitId": obj.get("commodityUnitId"), + "currencyId": obj.get("currencyId"), "adm0Code": obj.get("adm0Code"), "commodityDateWeek": obj.get("commodityDateWeek"), "commodityDateMonth": obj.get("commodityDateMonth"), @@ -211,7 +211,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "priceTypeName": obj.get("priceTypeName"), "commodityUnitName": obj.get("commodityUnitName"), "currencyName": obj.get("currencyName"), - "countryISO3": obj.get("countryISO3"), + "countryIso3": obj.get("countryIso3"), "countryName": obj.get("countryName"), "commodityPriceSourceName": obj.get("commodityPriceSourceName"), "originalFrequency": obj.get("originalFrequency"), diff --git a/data_bridges_client/models/view_extended_monthly_aggregated_price_paged_result.py b/data_bridges_client/models/view_extended_monthly_aggregated_price_paged_result.py new file mode 100644 index 0000000..e74c987 --- /dev/null +++ b/data_bridges_client/models/view_extended_monthly_aggregated_price_paged_result.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from data_bridges_client.models.view_extended_monthly_aggregated_price import ViewExtendedMonthlyAggregatedPrice +from typing import Optional, Set +from typing_extensions import Self + +class ViewExtendedMonthlyAggregatedPricePagedResult(BaseModel): + """ + ViewExtendedMonthlyAggregatedPricePagedResult + """ # noqa: E501 + items: Optional[List[ViewExtendedMonthlyAggregatedPrice]] = None + page: Optional[StrictInt] = None + total_items: Optional[StrictInt] = Field(default=None, alias="totalItems") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["items", "page", "totalItems"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ViewExtendedMonthlyAggregatedPricePagedResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "items", + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item_items in self.items: + if _item_items: + _items.append(_item_items.to_dict()) + _dict['items'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if items (nullable) is None + # and model_fields_set contains the field + if self.items is None and "items" in self.model_fields_set: + _dict['items'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ViewExtendedMonthlyAggregatedPricePagedResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "items": [ViewExtendedMonthlyAggregatedPrice.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None, + "page": obj.get("page"), + "totalItems": obj.get("totalItems") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/data_bridges_client/models/weekly_aggregated_price.py b/data_bridges_client/models/weekly_aggregated_price.py index 3888ab4..c1e64f6 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -33,24 +33,25 @@ class WeeklyAggregatedPrice(BaseModel): price_type_id: Optional[StrictInt] = Field(default=None, alias="priceTypeId") commodity_unit_id: Optional[StrictInt] = Field(default=None, alias="commodityUnitId") currency_id: Optional[StrictInt] = Field(default=None, alias="currencyId") + adm0_code: Optional[StrictInt] = Field(default=None, alias="adm0Code") + commodity_date_week: Optional[StrictInt] = Field(default=None, alias="commodityDateWeek") + commodity_date_month: Optional[StrictInt] = Field(default=None, alias="commodityDateMonth") + commodity_date_year: Optional[StrictInt] = Field(default=None, alias="commodityDateYear") + commodity_price_date: Optional[datetime] = Field(default=None, alias="commodityPriceDate") commodity_name: Optional[StrictStr] = Field(default=None, alias="commodityName") market_name: Optional[StrictStr] = Field(default=None, alias="marketName") price_type_name: Optional[StrictStr] = Field(default=None, alias="priceTypeName") commodity_unit_name: Optional[StrictStr] = Field(default=None, alias="commodityUnitName") currency_name: Optional[StrictStr] = Field(default=None, alias="currencyName") - adm0_code: Optional[StrictInt] = Field(default=None, alias="adm0Code") - country_iso3: Optional[StrictStr] = Field(default=None, alias="countryISO3") + country_iso3: Optional[StrictStr] = Field(default=None, alias="countryIso3") country_name: Optional[StrictStr] = Field(default=None, alias="countryName") - commodity_price: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="commodityPrice") - original_frequency: Optional[StrictStr] = Field(default=None, alias="originalFrequency") commodity_price_source_name: Optional[StrictStr] = Field(default=None, alias="commodityPriceSourceName") + original_frequency: Optional[StrictStr] = Field(default=None, alias="originalFrequency") + commodity_price: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="commodityPrice") commodity_price_observations: Optional[StrictInt] = Field(default=None, alias="commodityPriceObservations") - commodity_date_month: Optional[StrictInt] = Field(default=None, alias="commodityDateMonth") - commodity_date_year: Optional[StrictInt] = Field(default=None, alias="commodityDateYear") - commodity_price_date: Optional[datetime] = Field(default=None, alias="commodityPriceDate") commodity_price_flag: Optional[StrictStr] = Field(default=None, alias="commodityPriceFlag") additional_properties: Dict[str, Any] = {} - __properties: ClassVar[List[str]] = ["commodityId", "marketId", "priceTypeId", "commodityUnitId", "currencyId", "commodityName", "marketName", "priceTypeName", "commodityUnitName", "currencyName", "adm0Code", "countryISO3", "countryName", "commodityPrice", "originalFrequency", "commodityPriceSourceName", "commodityPriceObservations", "commodityDateMonth", "commodityDateYear", "commodityPriceDate", "commodityPriceFlag"] + __properties: ClassVar[List[str]] = ["commodityId", "marketId", "priceTypeId", "commodityUnitId", "currencyId", "adm0Code", "commodityDateWeek", "commodityDateMonth", "commodityDateYear", "commodityPriceDate", "commodityName", "marketName", "priceTypeName", "commodityUnitName", "currencyName", "countryIso3", "countryName", "commodityPriceSourceName", "originalFrequency", "commodityPrice", "commodityPriceObservations", "commodityPriceFlag"] model_config = ConfigDict( populate_by_name=True, @@ -98,6 +99,26 @@ def to_dict(self) -> Dict[str, Any]: for _key, _value in self.additional_properties.items(): _dict[_key] = _value + # set to None if commodity_date_week (nullable) is None + # and model_fields_set contains the field + if self.commodity_date_week is None and "commodity_date_week" in self.model_fields_set: + _dict['commodityDateWeek'] = None + + # set to None if commodity_date_month (nullable) is None + # and model_fields_set contains the field + if self.commodity_date_month is None and "commodity_date_month" in self.model_fields_set: + _dict['commodityDateMonth'] = None + + # set to None if commodity_date_year (nullable) is None + # and model_fields_set contains the field + if self.commodity_date_year is None and "commodity_date_year" in self.model_fields_set: + _dict['commodityDateYear'] = None + + # set to None if commodity_price_date (nullable) is None + # and model_fields_set contains the field + if self.commodity_price_date is None and "commodity_price_date" in self.model_fields_set: + _dict['commodityPriceDate'] = None + # set to None if commodity_name (nullable) is None # and model_fields_set contains the field if self.commodity_name is None and "commodity_name" in self.model_fields_set: @@ -126,22 +147,27 @@ def to_dict(self) -> Dict[str, Any]: # set to None if country_iso3 (nullable) is None # and model_fields_set contains the field if self.country_iso3 is None and "country_iso3" in self.model_fields_set: - _dict['countryISO3'] = None + _dict['countryIso3'] = None # set to None if country_name (nullable) is None # and model_fields_set contains the field if self.country_name is None and "country_name" in self.model_fields_set: _dict['countryName'] = None + # set to None if commodity_price_source_name (nullable) is None + # and model_fields_set contains the field + if self.commodity_price_source_name is None and "commodity_price_source_name" in self.model_fields_set: + _dict['commodityPriceSourceName'] = None + # set to None if original_frequency (nullable) is None # and model_fields_set contains the field if self.original_frequency is None and "original_frequency" in self.model_fields_set: _dict['originalFrequency'] = None - # set to None if commodity_price_source_name (nullable) is None + # set to None if commodity_price (nullable) is None # and model_fields_set contains the field - if self.commodity_price_source_name is None and "commodity_price_source_name" in self.model_fields_set: - _dict['commodityPriceSourceName'] = None + if self.commodity_price is None and "commodity_price" in self.model_fields_set: + _dict['commodityPrice'] = None # set to None if commodity_price_observations (nullable) is None # and model_fields_set contains the field @@ -170,21 +196,22 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "priceTypeId": obj.get("priceTypeId"), "commodityUnitId": obj.get("commodityUnitId"), "currencyId": obj.get("currencyId"), + "adm0Code": obj.get("adm0Code"), + "commodityDateWeek": obj.get("commodityDateWeek"), + "commodityDateMonth": obj.get("commodityDateMonth"), + "commodityDateYear": obj.get("commodityDateYear"), + "commodityPriceDate": obj.get("commodityPriceDate"), "commodityName": obj.get("commodityName"), "marketName": obj.get("marketName"), "priceTypeName": obj.get("priceTypeName"), "commodityUnitName": obj.get("commodityUnitName"), "currencyName": obj.get("currencyName"), - "adm0Code": obj.get("adm0Code"), - "countryISO3": obj.get("countryISO3"), + "countryIso3": obj.get("countryIso3"), "countryName": obj.get("countryName"), - "commodityPrice": obj.get("commodityPrice"), - "originalFrequency": obj.get("originalFrequency"), "commodityPriceSourceName": obj.get("commodityPriceSourceName"), + "originalFrequency": obj.get("originalFrequency"), + "commodityPrice": obj.get("commodityPrice"), "commodityPriceObservations": obj.get("commodityPriceObservations"), - "commodityDateMonth": obj.get("commodityDateMonth"), - "commodityDateYear": obj.get("commodityDateYear"), - "commodityPriceDate": obj.get("commodityPriceDate"), "commodityPriceFlag": obj.get("commodityPriceFlag") }) # store additional fields in additional_properties 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 75ceae3..57a4684 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 e3a8e94..61299fe 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/xls_form_fields_dto.py b/data_bridges_client/models/xls_form_fields_dto.py index 4a50df3..dfb1343 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/xls_form_list_choice_dto.py b/data_bridges_client/models/xls_form_list_choice_dto.py index 4598327..0efe100 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/models/xls_form_list_choices_dto.py b/data_bridges_client/models/xls_form_list_choices_dto.py index 130582d..93e9c8c 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 1696c81..52e0bd6 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/data_bridges_client/token.py b/data_bridges_client/token.py index 41416eb..7152a5c 100644 --- a/data_bridges_client/token.py +++ b/data_bridges_client/token.py @@ -50,7 +50,9 @@ def refresh_urllib3(self, scopes: Optional[str] = None): "POST", f"{self.BASE_URL}/token", body={"grant_type": "client_credentials", "scope": " ".join(scopes)}, - headers=urllib3.make_headers(basic_auth=f"{self.api_key}:{self.api_secret}"), + headers=urllib3.make_headers( + basic_auth=f"{self.api_key}:{self.api_secret}" + ), ) return resp diff --git a/docs/CariAdm0ValuesDTO.md b/docs/CariAdm0ValuesDTO.md new file mode 100644 index 0000000..8a7b82b --- /dev/null +++ b/docs/CariAdm0ValuesDTO.md @@ -0,0 +1,39 @@ +# CariAdm0ValuesDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**survey_id** | **int** | | [optional] +**survey_name** | **str** | | [optional] +**cari_methodology_name** | **str** | | [optional] +**fcs_methodology_name** | **str** | | [optional] +**additional_survey_metadata** | **str** | | [optional] +**adm0_code** | **int** | | [optional] +**adm0_name** | **str** | | [optional] +**cari_indicator_id** | **int** | | [optional] +**cari_indicator_name** | **str** | | [optional] +**cari_indicator_category_id** | **int** | | [optional] +**indicator_category_label** | **str** | | [optional] + +## Example + +```python +from data_bridges_client.models.cari_adm0_values_dto import CariAdm0ValuesDTO + +# TODO update the JSON string below +json = "{}" +# create an instance of CariAdm0ValuesDTO from a JSON string +cari_adm0_values_dto_instance = CariAdm0ValuesDTO.from_json(json) +# print the JSON string representation of the object +print(CariAdm0ValuesDTO.to_json()) + +# convert the object into a dict +cari_adm0_values_dto_dict = cari_adm0_values_dto_instance.to_dict() +# create an instance of CariAdm0ValuesDTO from a dict +cari_adm0_values_dto_from_dict = CariAdm0ValuesDTO.from_dict(cari_adm0_values_dto_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CariAdm0ValuesDTOPagedResult.md b/docs/CariAdm0ValuesDTOPagedResult.md new file mode 100644 index 0000000..8e6c08f --- /dev/null +++ b/docs/CariAdm0ValuesDTOPagedResult.md @@ -0,0 +1,31 @@ +# CariAdm0ValuesDTOPagedResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[CariAdm0ValuesDTO]**](CariAdm0ValuesDTO.md) | | [optional] [readonly] +**page** | **int** | | [optional] +**total_items** | **int** | | [optional] + +## Example + +```python +from data_bridges_client.models.cari_adm0_values_dto_paged_result import CariAdm0ValuesDTOPagedResult + +# TODO update the JSON string below +json = "{}" +# create an instance of CariAdm0ValuesDTOPagedResult from a JSON string +cari_adm0_values_dto_paged_result_instance = CariAdm0ValuesDTOPagedResult.from_json(json) +# print the JSON string representation of the object +print(CariAdm0ValuesDTOPagedResult.to_json()) + +# convert the object into a dict +cari_adm0_values_dto_paged_result_dict = cari_adm0_values_dto_paged_result_instance.to_dict() +# create an instance of CariAdm0ValuesDTOPagedResult from a dict +cari_adm0_values_dto_paged_result_from_dict = CariAdm0ValuesDTOPagedResult.from_dict(cari_adm0_values_dto_paged_result_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CariAdm1ValuesDTO.md b/docs/CariAdm1ValuesDTO.md new file mode 100644 index 0000000..7abfdb7 --- /dev/null +++ b/docs/CariAdm1ValuesDTO.md @@ -0,0 +1,41 @@ +# CariAdm1ValuesDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**survey_id** | **int** | | [optional] +**survey_name** | **str** | | [optional] +**cari_methodology_name** | **str** | | [optional] +**fcs_methodology_name** | **str** | | [optional] +**additional_survey_metadata** | **str** | | [optional] +**adm0_code** | **int** | | [optional] +**adm0_name** | **str** | | [optional] +**cari_indicator_id** | **int** | | [optional] +**cari_indicator_name** | **str** | | [optional] +**cari_indicator_category_id** | **int** | | [optional] +**indicator_category_label** | **str** | | [optional] +**adm1_code** | **int** | | [optional] +**adm1_name** | **str** | | [optional] + +## Example + +```python +from data_bridges_client.models.cari_adm1_values_dto import CariAdm1ValuesDTO + +# TODO update the JSON string below +json = "{}" +# create an instance of CariAdm1ValuesDTO from a JSON string +cari_adm1_values_dto_instance = CariAdm1ValuesDTO.from_json(json) +# print the JSON string representation of the object +print(CariAdm1ValuesDTO.to_json()) + +# convert the object into a dict +cari_adm1_values_dto_dict = cari_adm1_values_dto_instance.to_dict() +# create an instance of CariAdm1ValuesDTO from a dict +cari_adm1_values_dto_from_dict = CariAdm1ValuesDTO.from_dict(cari_adm1_values_dto_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CariAdm1ValuesDTOPagedResult.md b/docs/CariAdm1ValuesDTOPagedResult.md new file mode 100644 index 0000000..5126ef1 --- /dev/null +++ b/docs/CariAdm1ValuesDTOPagedResult.md @@ -0,0 +1,31 @@ +# CariAdm1ValuesDTOPagedResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[CariAdm1ValuesDTO]**](CariAdm1ValuesDTO.md) | | [optional] [readonly] +**page** | **int** | | [optional] +**total_items** | **int** | | [optional] + +## Example + +```python +from data_bridges_client.models.cari_adm1_values_dto_paged_result import CariAdm1ValuesDTOPagedResult + +# TODO update the JSON string below +json = "{}" +# create an instance of CariAdm1ValuesDTOPagedResult from a JSON string +cari_adm1_values_dto_paged_result_instance = CariAdm1ValuesDTOPagedResult.from_json(json) +# print the JSON string representation of the object +print(CariAdm1ValuesDTOPagedResult.to_json()) + +# convert the object into a dict +cari_adm1_values_dto_paged_result_dict = cari_adm1_values_dto_paged_result_instance.to_dict() +# create an instance of CariAdm1ValuesDTOPagedResult from a dict +cari_adm1_values_dto_paged_result_from_dict = CariAdm1ValuesDTOPagedResult.from_dict(cari_adm1_values_dto_paged_result_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CategoriesAndIndicatorsDTO.md b/docs/CategoriesAndIndicatorsDTO.md new file mode 100644 index 0000000..8d0d6e8 --- /dev/null +++ b/docs/CategoriesAndIndicatorsDTO.md @@ -0,0 +1,30 @@ +# CategoriesAndIndicatorsDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**categories** | [**List[ListItemDto]**](ListItemDto.md) | | [optional] +**indicators** | [**List[ListItemDto]**](ListItemDto.md) | | [optional] + +## Example + +```python +from data_bridges_client.models.categories_and_indicators_dto import CategoriesAndIndicatorsDTO + +# TODO update the JSON string below +json = "{}" +# create an instance of CategoriesAndIndicatorsDTO from a JSON string +categories_and_indicators_dto_instance = CategoriesAndIndicatorsDTO.from_json(json) +# print the JSON string representation of the object +print(CategoriesAndIndicatorsDTO.to_json()) + +# convert the object into a dict +categories_and_indicators_dto_dict = categories_and_indicators_dto_instance.to_dict() +# create an instance of CategoriesAndIndicatorsDTO from a dict +categories_and_indicators_dto_from_dict = CategoriesAndIndicatorsDTO.from_dict(categories_and_indicators_dto_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CommoditiesApi.md b/docs/CommoditiesApi.md index dd33737..7ff4c3b 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/6.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/7.0.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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters diff --git a/docs/CommodityUnitsApi.md b/docs/CommodityUnitsApi.md index 5066916..f1f5a27 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/6.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/7.0.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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters diff --git a/docs/CurrencyApi.md b/docs/CurrencyApi.md index e54885c..68bcdb5 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/6.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/7.0.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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters diff --git a/docs/EconomicDataApi.md b/docs/EconomicDataApi.md index d11d7b1..79e61a2 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/6.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/7.0.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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters diff --git a/docs/ViewExtendedAlpsValue.md b/docs/ExtendedAlpsValueDto.md similarity index 72% rename from docs/ViewExtendedAlpsValue.md rename to docs/ExtendedAlpsValueDto.md index 7a793ee..a5a482a 100644 --- a/docs/ViewExtendedAlpsValue.md +++ b/docs/ExtendedAlpsValueDto.md @@ -1,4 +1,4 @@ -# ViewExtendedAlpsValue +# ExtendedAlpsValueDto ## Properties @@ -28,19 +28,19 @@ Name | Type | Description | Notes ## Example ```python -from data_bridges_client.models.view_extended_alps_value import ViewExtendedAlpsValue +from data_bridges_client.models.extended_alps_value_dto import ExtendedAlpsValueDto # TODO update the JSON string below json = "{}" -# create an instance of ViewExtendedAlpsValue from a JSON string -view_extended_alps_value_instance = ViewExtendedAlpsValue.from_json(json) +# create an instance of ExtendedAlpsValueDto from a JSON string +extended_alps_value_dto_instance = ExtendedAlpsValueDto.from_json(json) # print the JSON string representation of the object -print(ViewExtendedAlpsValue.to_json()) +print(ExtendedAlpsValueDto.to_json()) # convert the object into a dict -view_extended_alps_value_dict = view_extended_alps_value_instance.to_dict() -# create an instance of ViewExtendedAlpsValue from a dict -view_extended_alps_value_from_dict = ViewExtendedAlpsValue.from_dict(view_extended_alps_value_dict) +extended_alps_value_dto_dict = extended_alps_value_dto_instance.to_dict() +# create an instance of ExtendedAlpsValueDto from a dict +extended_alps_value_dto_from_dict = ExtendedAlpsValueDto.from_dict(extended_alps_value_dto_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ExtendedAlpsValueDtoPagedResult.md b/docs/ExtendedAlpsValueDtoPagedResult.md new file mode 100644 index 0000000..e14f287 --- /dev/null +++ b/docs/ExtendedAlpsValueDtoPagedResult.md @@ -0,0 +1,31 @@ +# ExtendedAlpsValueDtoPagedResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[ExtendedAlpsValueDto]**](ExtendedAlpsValueDto.md) | | [optional] [readonly] +**page** | **int** | | [optional] +**total_items** | **int** | | [optional] + +## Example + +```python +from data_bridges_client.models.extended_alps_value_dto_paged_result import ExtendedAlpsValueDtoPagedResult + +# TODO update the JSON string below +json = "{}" +# create an instance of ExtendedAlpsValueDtoPagedResult from a JSON string +extended_alps_value_dto_paged_result_instance = ExtendedAlpsValueDtoPagedResult.from_json(json) +# print the JSON string representation of the object +print(ExtendedAlpsValueDtoPagedResult.to_json()) + +# convert the object into a dict +extended_alps_value_dto_paged_result_dict = extended_alps_value_dto_paged_result_instance.to_dict() +# create an instance of ExtendedAlpsValueDtoPagedResult from a dict +extended_alps_value_dto_paged_result_from_dict = ExtendedAlpsValueDtoPagedResult.from_dict(extended_alps_value_dto_paged_result_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/FoodSecurityApi.md b/docs/FoodSecurityApi.md deleted file mode 100644 index 367ba45..0000000 --- a/docs/FoodSecurityApi.md +++ /dev/null @@ -1,90 +0,0 @@ -# data_bridges_client.FoodSecurityApi - -All URIs are relative to *https://api.wfp.org/vam-data-bridges/6.0.0* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**food_security_list_get**](FoodSecurityApi.md#food_security_list_get) | **GET** /FoodSecurity/List | - - -# **food_security_list_get** -> IpcValuePagedResult food_security_list_get(iso3=iso3, year=year, page=page, env=env) - - - - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_foodsecurity-list_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern - -### Example - -* OAuth Authentication (default): - -```python -import data_bridges_client -from data_bridges_client.models.ipc_value_paged_result import IpcValuePagedResult -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/6.0.0 -# See configuration.py for a list of all supported configuration parameters. -configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -configuration.access_token = os.environ["ACCESS_TOKEN"] - -# Enter a context with an instance of the API client -with data_bridges_client.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = data_bridges_client.FoodSecurityApi(api_client) - iso3 = 'iso3_example' # str | The country ISO3 code (optional) - year = 56 # int | (optional) - page = 1 # int | (optional) (default to 1) - env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) - - try: - api_response = api_instance.food_security_list_get(iso3=iso3, year=year, page=page, env=env) - print("The response of FoodSecurityApi->food_security_list_get:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling FoodSecurityApi->food_security_list_get: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **iso3** | **str**| The country ISO3 code | [optional] - **year** | **int**| | [optional] - **page** | **int**| | [optional] [default to 1] - **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] - -### Return type - -[**IpcValuePagedResult**](IpcValuePagedResult.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) - diff --git a/docs/GorpApi.md b/docs/GlobalOutlookApi.md similarity index 63% rename from docs/GorpApi.md rename to docs/GlobalOutlookApi.md index 94681de..00c22c8 100644 --- a/docs/GorpApi.md +++ b/docs/GlobalOutlookApi.md @@ -1,20 +1,20 @@ -# data_bridges_client.GorpApi +# data_bridges_client.GlobalOutlookApi -All URIs are relative to *https://api.wfp.org/vam-data-bridges/6.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/7.0.0* Method | HTTP request | Description ------------- | ------------- | ------------- -[**gorp_country_latest_get**](GorpApi.md#gorp_country_latest_get) | **GET** /Gorp/CountryLatest | Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan. -[**gorp_global_latest_get**](GorpApi.md#gorp_global_latest_get) | **GET** /Gorp/GlobalLatest | Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. -[**gorp_regional_latest_get**](GorpApi.md#gorp_regional_latest_get) | **GET** /Gorp/RegionalLatest | Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. +[**global_outlook_country_latest_get**](GlobalOutlookApi.md#global_outlook_country_latest_get) | **GET** /GlobalOutlook/CountryLatest | Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP's Global Outlook. +[**global_outlook_global_latest_get**](GlobalOutlookApi.md#global_outlook_global_latest_get) | **GET** /GlobalOutlook/GlobalLatest | Return the latest global dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. +[**global_outlook_regional_latest_get**](GlobalOutlookApi.md#global_outlook_regional_latest_get) | **GET** /GlobalOutlook/RegionalLatest | Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. -# **gorp_country_latest_get** -> List[GorpCountryApiDto] gorp_country_latest_get(env=env) +# **global_outlook_country_latest_get** +> List[GlobalOutlookCountryApiDto] global_outlook_country_latest_get(env=env) -Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan. +Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP's Global Outlook. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-countrylatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_globaloutlook-countrylatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -22,14 +22,14 @@ Return the latest country dataset of number of acutely food insecure (in thousan ```python import data_bridges_client -from data_bridges_client.models.gorp_country_api_dto import GorpCountryApiDto +from data_bridges_client.models.global_outlook_country_api_dto import GlobalOutlookCountryApiDto 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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -42,16 +42,16 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] # Enter a context with an instance of the API client with data_bridges_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_bridges_client.GorpApi(api_client) + api_instance = data_bridges_client.GlobalOutlookApi(api_client) env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) try: - # Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan. - api_response = api_instance.gorp_country_latest_get(env=env) - print("The response of GorpApi->gorp_country_latest_get:\n") + # Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP's Global Outlook. + api_response = api_instance.global_outlook_country_latest_get(env=env) + print("The response of GlobalOutlookApi->global_outlook_country_latest_get:\n") pprint(api_response) except Exception as e: - print("Exception when calling GorpApi->gorp_country_latest_get: %s\n" % e) + print("Exception when calling GlobalOutlookApi->global_outlook_country_latest_get: %s\n" % e) ``` @@ -65,7 +65,7 @@ Name | Type | Description | Notes ### Return type -[**List[GorpCountryApiDto]**](GorpCountryApiDto.md) +[**List[GlobalOutlookCountryApiDto]**](GlobalOutlookCountryApiDto.md) ### Authorization @@ -85,12 +85,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **gorp_global_latest_get** -> GorpGlobalApiDto gorp_global_latest_get(env=env) +# **global_outlook_global_latest_get** +> GlobalOutlookApiDto global_outlook_global_latest_get(env=env) -Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. +Return the latest global dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-globallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_globaloutlook-globallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -98,14 +98,14 @@ Return the latest global dataset of number of acutely food insecure (in millions ```python import data_bridges_client -from data_bridges_client.models.gorp_global_api_dto import GorpGlobalApiDto +from data_bridges_client.models.global_outlook_api_dto import GlobalOutlookApiDto 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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -118,16 +118,16 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] # Enter a context with an instance of the API client with data_bridges_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_bridges_client.GorpApi(api_client) + api_instance = data_bridges_client.GlobalOutlookApi(api_client) env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) try: - # Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. - api_response = api_instance.gorp_global_latest_get(env=env) - print("The response of GorpApi->gorp_global_latest_get:\n") + # Return the latest global dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. + api_response = api_instance.global_outlook_global_latest_get(env=env) + print("The response of GlobalOutlookApi->global_outlook_global_latest_get:\n") pprint(api_response) except Exception as e: - print("Exception when calling GorpApi->gorp_global_latest_get: %s\n" % e) + print("Exception when calling GlobalOutlookApi->global_outlook_global_latest_get: %s\n" % e) ``` @@ -141,7 +141,7 @@ Name | Type | Description | Notes ### Return type -[**GorpGlobalApiDto**](GorpGlobalApiDto.md) +[**GlobalOutlookApiDto**](GlobalOutlookApiDto.md) ### Authorization @@ -161,12 +161,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **gorp_regional_latest_get** -> List[GorpRegionalApiDto] gorp_regional_latest_get(env=env) +# **global_outlook_regional_latest_get** +> List[GlobalOutlookRegionalApiDto] global_outlook_regional_latest_get(env=env) -Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. +Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_gorp-regionallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_globaloutlook-regionallatest_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -174,14 +174,14 @@ Return the latest regional dataset of number of acutely food insecure (in millio ```python import data_bridges_client -from data_bridges_client.models.gorp_regional_api_dto import GorpRegionalApiDto +from data_bridges_client.models.global_outlook_regional_api_dto import GlobalOutlookRegionalApiDto 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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -194,16 +194,16 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] # Enter a context with an instance of the API client with data_bridges_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = data_bridges_client.GorpApi(api_client) + api_instance = data_bridges_client.GlobalOutlookApi(api_client) env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) try: - # Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. - api_response = api_instance.gorp_regional_latest_get(env=env) - print("The response of GorpApi->gorp_regional_latest_get:\n") + # Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. + api_response = api_instance.global_outlook_regional_latest_get(env=env) + print("The response of GlobalOutlookApi->global_outlook_regional_latest_get:\n") pprint(api_response) except Exception as e: - print("Exception when calling GorpApi->gorp_regional_latest_get: %s\n" % e) + print("Exception when calling GlobalOutlookApi->global_outlook_regional_latest_get: %s\n" % e) ``` @@ -217,7 +217,7 @@ Name | Type | Description | Notes ### Return type -[**List[GorpRegionalApiDto]**](GorpRegionalApiDto.md) +[**List[GlobalOutlookRegionalApiDto]**](GlobalOutlookRegionalApiDto.md) ### Authorization diff --git a/docs/GlobalOutlookApiDto.md b/docs/GlobalOutlookApiDto.md new file mode 100644 index 0000000..cb45e74 --- /dev/null +++ b/docs/GlobalOutlookApiDto.md @@ -0,0 +1,33 @@ +# GlobalOutlookApiDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_date** | **str** | | [optional] +**region_name** | **str** | | [optional] +**total_value** | **float** | | [optional] +**number_of_countries** | **int** | | [optional] +**comment** | **str** | | [optional] + +## Example + +```python +from data_bridges_client.models.global_outlook_api_dto import GlobalOutlookApiDto + +# TODO update the JSON string below +json = "{}" +# create an instance of GlobalOutlookApiDto from a JSON string +global_outlook_api_dto_instance = GlobalOutlookApiDto.from_json(json) +# print the JSON string representation of the object +print(GlobalOutlookApiDto.to_json()) + +# convert the object into a dict +global_outlook_api_dto_dict = global_outlook_api_dto_instance.to_dict() +# create an instance of GlobalOutlookApiDto from a dict +global_outlook_api_dto_from_dict = GlobalOutlookApiDto.from_dict(global_outlook_api_dto_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GlobalOutlookCountryApiDto.md b/docs/GlobalOutlookCountryApiDto.md new file mode 100644 index 0000000..7482eac --- /dev/null +++ b/docs/GlobalOutlookCountryApiDto.md @@ -0,0 +1,32 @@ +# GlobalOutlookCountryApiDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_date** | **str** | | [optional] +**country_office_iso3** | **str** | | [optional] +**total_value** | **float** | | [optional] +**comment** | **str** | | [optional] + +## Example + +```python +from data_bridges_client.models.global_outlook_country_api_dto import GlobalOutlookCountryApiDto + +# TODO update the JSON string below +json = "{}" +# create an instance of GlobalOutlookCountryApiDto from a JSON string +global_outlook_country_api_dto_instance = GlobalOutlookCountryApiDto.from_json(json) +# print the JSON string representation of the object +print(GlobalOutlookCountryApiDto.to_json()) + +# convert the object into a dict +global_outlook_country_api_dto_dict = global_outlook_country_api_dto_instance.to_dict() +# create an instance of GlobalOutlookCountryApiDto from a dict +global_outlook_country_api_dto_from_dict = GlobalOutlookCountryApiDto.from_dict(global_outlook_country_api_dto_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GlobalOutlookRegionalApiDto.md b/docs/GlobalOutlookRegionalApiDto.md new file mode 100644 index 0000000..9e58e73 --- /dev/null +++ b/docs/GlobalOutlookRegionalApiDto.md @@ -0,0 +1,33 @@ +# GlobalOutlookRegionalApiDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_date** | **str** | | [optional] +**region_name** | **str** | | [optional] +**total_value** | **float** | | [optional] +**number_of_countries** | **int** | | [optional] +**comment** | **str** | | [optional] + +## Example + +```python +from data_bridges_client.models.global_outlook_regional_api_dto import GlobalOutlookRegionalApiDto + +# TODO update the JSON string below +json = "{}" +# create an instance of GlobalOutlookRegionalApiDto from a JSON string +global_outlook_regional_api_dto_instance = GlobalOutlookRegionalApiDto.from_json(json) +# print the JSON string representation of the object +print(GlobalOutlookRegionalApiDto.to_json()) + +# convert the object into a dict +global_outlook_regional_api_dto_dict = global_outlook_regional_api_dto_instance.to_dict() +# create an instance of GlobalOutlookRegionalApiDto from a dict +global_outlook_regional_api_dto_from_dict = GlobalOutlookRegionalApiDto.from_dict(global_outlook_regional_api_dto_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GorpCountryApiDto.md b/docs/GorpCountryApiDto.md deleted file mode 100644 index b338758..0000000 --- a/docs/GorpCountryApiDto.md +++ /dev/null @@ -1,32 +0,0 @@ -# GorpCountryApiDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**gorp_date** | **str** | | [optional] -**country_office_iso3** | **str** | | [optional] -**gorp_total_value** | **float** | | [optional] -**gorp_comment** | **str** | | [optional] - -## Example - -```python -from data_bridges_client.models.gorp_country_api_dto import GorpCountryApiDto - -# TODO update the JSON string below -json = "{}" -# create an instance of GorpCountryApiDto from a JSON string -gorp_country_api_dto_instance = GorpCountryApiDto.from_json(json) -# print the JSON string representation of the object -print(GorpCountryApiDto.to_json()) - -# convert the object into a dict -gorp_country_api_dto_dict = gorp_country_api_dto_instance.to_dict() -# create an instance of GorpCountryApiDto from a dict -gorp_country_api_dto_from_dict = GorpCountryApiDto.from_dict(gorp_country_api_dto_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GorpGlobalApiDto.md b/docs/GorpGlobalApiDto.md deleted file mode 100644 index bd1a0ff..0000000 --- a/docs/GorpGlobalApiDto.md +++ /dev/null @@ -1,33 +0,0 @@ -# GorpGlobalApiDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**gorp_date** | **str** | | [optional] -**gorp_region_name** | **str** | | [optional] -**gorp_total_value** | **float** | | [optional] -**number_of_countries** | **int** | | [optional] -**gorp_comment** | **str** | | [optional] - -## Example - -```python -from data_bridges_client.models.gorp_global_api_dto import GorpGlobalApiDto - -# TODO update the JSON string below -json = "{}" -# create an instance of GorpGlobalApiDto from a JSON string -gorp_global_api_dto_instance = GorpGlobalApiDto.from_json(json) -# print the JSON string representation of the object -print(GorpGlobalApiDto.to_json()) - -# convert the object into a dict -gorp_global_api_dto_dict = gorp_global_api_dto_instance.to_dict() -# create an instance of GorpGlobalApiDto from a dict -gorp_global_api_dto_from_dict = GorpGlobalApiDto.from_dict(gorp_global_api_dto_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GorpRegionalApiDto.md b/docs/GorpRegionalApiDto.md deleted file mode 100644 index 9b2bd69..0000000 --- a/docs/GorpRegionalApiDto.md +++ /dev/null @@ -1,33 +0,0 @@ -# GorpRegionalApiDto - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**gorp_date** | **str** | | [optional] -**gorp_region_name** | **str** | | [optional] -**gorp_total_value** | **float** | | [optional] -**number_of_countries** | **int** | | [optional] -**gorp_comment** | **str** | | [optional] - -## Example - -```python -from data_bridges_client.models.gorp_regional_api_dto import GorpRegionalApiDto - -# TODO update the JSON string below -json = "{}" -# create an instance of GorpRegionalApiDto from a JSON string -gorp_regional_api_dto_instance = GorpRegionalApiDto.from_json(json) -# print the JSON string representation of the object -print(GorpRegionalApiDto.to_json()) - -# convert the object into a dict -gorp_regional_api_dto_dict = gorp_regional_api_dto_instance.to_dict() -# create an instance of GorpRegionalApiDto from a dict -gorp_regional_api_dto_from_dict = GorpRegionalApiDto.from_dict(gorp_regional_api_dto_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/HungerHotSpotDataDTO.md b/docs/HungerHotSpotDataDTO.md new file mode 100644 index 0000000..8f87335 --- /dev/null +++ b/docs/HungerHotSpotDataDTO.md @@ -0,0 +1,32 @@ +# HungerHotSpotDataDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**iso3_code** | **str** | | [optional] +**hunger_hotspots_date** | **datetime** | | [optional] +**category** | [**ListItemDto**](ListItemDto.md) | | [optional] +**indicators** | [**List[ListItemDto]**](ListItemDto.md) | | [optional] + +## Example + +```python +from data_bridges_client.models.hunger_hot_spot_data_dto import HungerHotSpotDataDTO + +# TODO update the JSON string below +json = "{}" +# create an instance of HungerHotSpotDataDTO from a JSON string +hunger_hot_spot_data_dto_instance = HungerHotSpotDataDTO.from_json(json) +# print the JSON string representation of the object +print(HungerHotSpotDataDTO.to_json()) + +# convert the object into a dict +hunger_hot_spot_data_dto_dict = hunger_hot_spot_data_dto_instance.to_dict() +# create an instance of HungerHotSpotDataDTO from a dict +hunger_hot_spot_data_dto_from_dict = HungerHotSpotDataDTO.from_dict(hunger_hot_spot_data_dto_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/HungerHotSpotDataDTOPagedResult.md b/docs/HungerHotSpotDataDTOPagedResult.md new file mode 100644 index 0000000..3151c61 --- /dev/null +++ b/docs/HungerHotSpotDataDTOPagedResult.md @@ -0,0 +1,31 @@ +# HungerHotSpotDataDTOPagedResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[HungerHotSpotDataDTO]**](HungerHotSpotDataDTO.md) | | [optional] [readonly] +**page** | **int** | | [optional] +**total_items** | **int** | | [optional] + +## Example + +```python +from data_bridges_client.models.hunger_hot_spot_data_dto_paged_result import HungerHotSpotDataDTOPagedResult + +# TODO update the JSON string below +json = "{}" +# create an instance of HungerHotSpotDataDTOPagedResult from a JSON string +hunger_hot_spot_data_dto_paged_result_instance = HungerHotSpotDataDTOPagedResult.from_json(json) +# print the JSON string representation of the object +print(HungerHotSpotDataDTOPagedResult.to_json()) + +# convert the object into a dict +hunger_hot_spot_data_dto_paged_result_dict = hunger_hot_spot_data_dto_paged_result_instance.to_dict() +# create an instance of HungerHotSpotDataDTOPagedResult from a dict +hunger_hot_spot_data_dto_paged_result_from_dict = HungerHotSpotDataDTOPagedResult.from_dict(hunger_hot_spot_data_dto_paged_result_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/HungerHotspotApi.md b/docs/HungerHotspotApi.md new file mode 100644 index 0000000..67ae129 --- /dev/null +++ b/docs/HungerHotspotApi.md @@ -0,0 +1,164 @@ +# data_bridges_client.HungerHotspotApi + +All URIs are relative to *https://api.wfp.org/vam-data-bridges/7.0.0* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**hunger_hotspot_categories_and_indicators_get**](HungerHotspotApi.md#hunger_hotspot_categories_and_indicators_get) | **GET** /HungerHotspot/CategoriesAndIndicators | Retrieves Hunger Hotspot categories and indicators. +[**hunger_hotspot_data_get**](HungerHotspotApi.md#hunger_hotspot_data_get) | **GET** /HungerHotspot/Data | Retrieves a paginated list of Hunger Hotspot data. + + +# **hunger_hotspot_categories_and_indicators_get** +> CategoriesAndIndicatorsDTO hunger_hotspot_categories_and_indicators_get(env=env) + +Retrieves Hunger Hotspot categories and indicators. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_hungerhotspot-categoriesandindicators_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.categories_and_indicators_dto import CategoriesAndIndicatorsDTO +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/7.0.0 +# See configuration.py for a list of all supported configuration parameters. +configuration = data_bridges_client.Configuration( + host = "https://api.wfp.org/vam-data-bridges/7.0.0" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +configuration.access_token = os.environ["ACCESS_TOKEN"] + +# Enter a context with an instance of the API client +with data_bridges_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = data_bridges_client.HungerHotspotApi(api_client) + env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) + + try: + # Retrieves Hunger Hotspot categories and indicators. + api_response = api_instance.hunger_hotspot_categories_and_indicators_get(env=env) + print("The response of HungerHotspotApi->hunger_hotspot_categories_and_indicators_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling HungerHotspotApi->hunger_hotspot_categories_and_indicators_get: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] + +### Return type + +[**CategoriesAndIndicatorsDTO**](CategoriesAndIndicatorsDTO.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) + +# **hunger_hotspot_data_get** +> HungerHotSpotDataDTOPagedResult hunger_hotspot_data_get(page=page, env=env) + +Retrieves a paginated list of Hunger Hotspot data. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_hungerhotspot-data_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.hunger_hot_spot_data_dto_paged_result import HungerHotSpotDataDTOPagedResult +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/7.0.0 +# See configuration.py for a list of all supported configuration parameters. +configuration = data_bridges_client.Configuration( + host = "https://api.wfp.org/vam-data-bridges/7.0.0" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +configuration.access_token = os.environ["ACCESS_TOKEN"] + +# Enter a context with an instance of the API client +with data_bridges_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = data_bridges_client.HungerHotspotApi(api_client) + page = 1 # int | The page number for pagination. Defaults to 1. (optional) (default to 1) + env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) + + try: + # Retrieves a paginated list of Hunger Hotspot data. + api_response = api_instance.hunger_hotspot_data_get(page=page, env=env) + print("The response of HungerHotspotApi->hunger_hotspot_data_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling HungerHotspotApi->hunger_hotspot_data_get: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page** | **int**| The page number for pagination. Defaults to 1. | [optional] [default to 1] + **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] + +### Return type + +[**HungerHotSpotDataDTOPagedResult**](HungerHotSpotDataDTOPagedResult.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) + diff --git a/docs/IncubationApi.md b/docs/IncubationApi.md index 204c113..c9798d3 100644 --- a/docs/IncubationApi.md +++ b/docs/IncubationApi.md @@ -1,11 +1,11 @@ # data_bridges_client.IncubationApi -All URIs are relative to *https://api.wfp.org/vam-data-bridges/6.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/7.0.0* Method | HTTP request | Description ------------- | ------------- | ------------- -[**aims_download_all_analysis_rounds_get**](IncubationApi.md#aims_download_all_analysis_rounds_get) | **GET** /Aims/DownloadAllAnalysisRounds | Each asset has a baseline and several rounds. Each round reflects the number of times the asset has been analysed over time. The number of total rounds changes according to the workstream: Asset Detection (AD) assets can have a total of 5 rounds, while there is no limit to the monitoring of Landscape Impact Assessment (LIA) assets. Assets considered for Site Prioritization (SP) have one round only. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). -[**aims_download_polygon_files_get**](IncubationApi.md#aims_download_polygon_files_get) | **GET** /Aims/DownloadPolygonFiles | Polygon files are available for Landscape Impact Assessment (LIA) assets only. The file name corresponds to the “Geotrace” name. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). +[**cari_adm0_values_get**](IncubationApi.md#cari_adm0_values_get) | **GET** /Cari/Adm0Values | Retrieves a paginated list of Adm0 CARI results based on the specified indicator, administrative code, and survey. +[**cari_adm1_values_get**](IncubationApi.md#cari_adm1_values_get) | **GET** /Cari/Adm1Values | Retrieves a paginated list of Adm1 CARI results based on the specified indicator, administrative code, and survey. [**household_draft_internal_base_data_get**](IncubationApi.md#household_draft_internal_base_data_get) | **GET** /Household/DraftInternalBaseData | Get data that includes the core household fields only by Survey ID. To access this data, please contact Wael ATTIA for authorization. This endpoint will send you only data you have access to, based on permissions assigned to your application profile. The \"apiKey\" can be found in the profile section of the DataBridges application. [**household_full_data_get**](IncubationApi.md#household_full_data_get) | **GET** /Household/FullData | Get a full dataset that includes all the fields included in the survey in addition to the core household fields by Survey ID. To access this data, please contact Wael ATTIA for authorization. This endpoint will send you only data you have access to, based on permissions assigned to your application profile. The \"apiKey\" can be found in the profile section of the DataBridges application. [**household_official_use_base_data_get**](IncubationApi.md#household_official_use_base_data_get) | **GET** /Household/OfficialUseBaseData | Get data that includes the core household fields only by Survey ID @@ -15,12 +15,12 @@ Method | HTTP request | Description [**xls_forms_definition_get**](IncubationApi.md#xls_forms_definition_get) | **GET** /XlsForms/definition | Get a complete set of XLS Form definitions of a given XLS Form ID. This is the digital version of the questionnaire used during the data collection exercise. -# **aims_download_all_analysis_rounds_get** -> aims_download_all_analysis_rounds_get(adm0_code, env=env) +# **cari_adm0_values_get** +> CariAdm0ValuesDTOPagedResult cari_adm0_values_get(adm0_code=adm0_code, survey_id=survey_id, indicator_id=indicator_id, page=page, env=env) -Each asset has a baseline and several rounds. Each round reflects the number of times the asset has been analysed over time. The number of total rounds changes according to the workstream: Asset Detection (AD) assets can have a total of 5 rounds, while there is no limit to the monitoring of Landscape Impact Assessment (LIA) assets. Assets considered for Site Prioritization (SP) have one round only. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). +Retrieves a paginated list of Adm0 CARI results based on the specified indicator, administrative code, and survey. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadallanalysisrounds_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![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_cari-adm0values_get\" This method returns a paginated list of results based on the provided filters. Ensure that the parameters are valid and correspond to existing data in the repository. If an error occurs during processing, a bad request response is returned with the error details. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -28,13 +28,14 @@ Each asset has a baseline and several rounds. Each round reflects the number of ```python import data_bridges_client +from data_bridges_client.models.cari_adm0_values_dto_paged_result import CariAdm0ValuesDTOPagedResult 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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -48,14 +49,19 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] with data_bridges_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = data_bridges_client.IncubationApi(api_client) - adm0_code = 56 # int | The country adm0Code + adm0_code = 56 # int | The administrative level 0 code to filter the results. (optional) + survey_id = 56 # int | The unique identifier of the survey to filter the results. (optional) + indicator_id = 56 # int | The unique identifier of the indicator to filter the results. (optional) + page = 1 # int | The page number for pagination. Defaults to 1. (optional) (default to 1) env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) try: - # Each asset has a baseline and several rounds. Each round reflects the number of times the asset has been analysed over time. The number of total rounds changes according to the workstream: Asset Detection (AD) assets can have a total of 5 rounds, while there is no limit to the monitoring of Landscape Impact Assessment (LIA) assets. Assets considered for Site Prioritization (SP) have one round only. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). - api_instance.aims_download_all_analysis_rounds_get(adm0_code, env=env) + # Retrieves a paginated list of Adm0 CARI results based on the specified indicator, administrative code, and survey. + api_response = api_instance.cari_adm0_values_get(adm0_code=adm0_code, survey_id=survey_id, indicator_id=indicator_id, page=page, env=env) + print("The response of IncubationApi->cari_adm0_values_get:\n") + pprint(api_response) except Exception as e: - print("Exception when calling IncubationApi->aims_download_all_analysis_rounds_get: %s\n" % e) + print("Exception when calling IncubationApi->cari_adm0_values_get: %s\n" % e) ``` @@ -65,12 +71,15 @@ with data_bridges_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **adm0_code** | **int**| The country adm0Code | + **adm0_code** | **int**| The administrative level 0 code to filter the results. | [optional] + **survey_id** | **int**| The unique identifier of the survey to filter the results. | [optional] + **indicator_id** | **int**| The unique identifier of the indicator to filter the results. | [optional] + **page** | **int**| The page number for pagination. Defaults to 1. | [optional] [default to 1] **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] ### Return type -void (empty response body) +[**CariAdm0ValuesDTOPagedResult**](CariAdm0ValuesDTOPagedResult.md) ### Authorization @@ -79,22 +88,23 @@ void (empty response body) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: 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) -# **aims_download_polygon_files_get** -> aims_download_polygon_files_get(adm0_code, env=env) +# **cari_adm1_values_get** +> CariAdm1ValuesDTOPagedResult cari_adm1_values_get(adm0_code=adm0_code, survey_id=survey_id, indicator_id=indicator_id, page=page, env=env) -Polygon files are available for Landscape Impact Assessment (LIA) assets only. The file name corresponds to the “Geotrace” name. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). +Retrieves a paginated list of Adm1 CARI results based on the specified indicator, administrative code, and survey. - [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Incubation-red)]() [![Generic badge](https://img.shields.io/badge/Access%20Policy-TEC_Architecture_+_Service_Owner_approvals_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Official%20Use%20Only-yellow)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_aims-downloadpolygonfiles_get\" **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + [![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_cari-adm1values_get\" This method returns a paginated list of results based on the provided filters. Ensure that the parameters are valid and correspond to existing data in the repository. If an error occurs during processing, a bad request response is returned with the error details. **Data Controller** - Wael ATTIA **API Integration Pattern** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern ### Example @@ -102,13 +112,14 @@ Polygon files are available for Landscape Impact Assessment (LIA) assets only. ```python import data_bridges_client +from data_bridges_client.models.cari_adm1_values_dto_paged_result import CariAdm1ValuesDTOPagedResult 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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -122,14 +133,19 @@ configuration.access_token = os.environ["ACCESS_TOKEN"] with data_bridges_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = data_bridges_client.IncubationApi(api_client) - adm0_code = 56 # int | The country adm0Code + adm0_code = 56 # int | The administrative level 0 code to filter the results. (optional) + survey_id = 56 # int | The unique identifier of the survey to filter the results. (optional) + indicator_id = 56 # int | The unique identifier of the indicator to filter the results. (optional) + page = 1 # int | The page number for pagination. Defaults to 1. (optional) (default to 1) env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) try: - # Polygon files are available for Landscape Impact Assessment (LIA) assets only. The file name corresponds to the “Geotrace” name. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). - api_instance.aims_download_polygon_files_get(adm0_code, env=env) + # Retrieves a paginated list of Adm1 CARI results based on the specified indicator, administrative code, and survey. + api_response = api_instance.cari_adm1_values_get(adm0_code=adm0_code, survey_id=survey_id, indicator_id=indicator_id, page=page, env=env) + print("The response of IncubationApi->cari_adm1_values_get:\n") + pprint(api_response) except Exception as e: - print("Exception when calling IncubationApi->aims_download_polygon_files_get: %s\n" % e) + print("Exception when calling IncubationApi->cari_adm1_values_get: %s\n" % e) ``` @@ -139,12 +155,15 @@ with data_bridges_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **adm0_code** | **int**| The country adm0Code | + **adm0_code** | **int**| The administrative level 0 code to filter the results. | [optional] + **survey_id** | **int**| The unique identifier of the survey to filter the results. | [optional] + **indicator_id** | **int**| The unique identifier of the indicator to filter the results. | [optional] + **page** | **int**| The page number for pagination. Defaults to 1. | [optional] [default to 1] **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] ### Return type -void (empty response body) +[**CariAdm1ValuesDTOPagedResult**](CariAdm1ValuesDTOPagedResult.md) ### Authorization @@ -153,13 +172,14 @@ void (empty response body) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: 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) @@ -180,10 +200,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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -266,10 +286,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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -354,10 +374,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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -437,10 +457,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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -520,10 +540,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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -606,10 +626,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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -698,10 +718,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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters diff --git a/docs/IpcHistoricalDatumDto.md b/docs/IpcHistoricalDatumDto.md new file mode 100644 index 0000000..ed7a9f6 --- /dev/null +++ b/docs/IpcHistoricalDatumDto.md @@ -0,0 +1,80 @@ +# IpcHistoricalDatumDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**analysis_id** | **int** | | [optional] +**analysis_title** | **str** | | [optional] +**iso3_alpha3** | **str** | | [optional] +**country_name** | **str** | | [optional] +**analysis_date** | **datetime** | | [optional] +**start_date_current_period** | **datetime** | | [optional] +**end_date_current_period** | **datetime** | | [optional] +**start_date_projected_period** | **datetime** | | [optional] +**end_date_projected_period** | **datetime** | | [optional] +**start_date_second_projected_period** | **datetime** | | [optional] +**end_date_second_projected_period** | **datetime** | | [optional] +**population** | **float** | | [optional] +**population_percentage** | **float** | | [optional] +**phase3_plus_population** | **float** | | [optional] +**phase3_plus_percentage** | **float** | | [optional] +**estimated_population** | **float** | | [optional] +**phase1_population** | **float** | | [optional] +**phase1_percentage** | **float** | | [optional] +**phase2_population** | **float** | | [optional] +**phase2_percentage** | **float** | | [optional] +**phase3_population** | **float** | | [optional] +**phase3_percentage** | **float** | | [optional] +**phase4_population** | **float** | | [optional] +**phase4_percentage** | **float** | | [optional] +**phase5_population** | **float** | | [optional] +**phase5_percentage** | **float** | | [optional] +**phase3_plus_population_projected** | **float** | | [optional] +**phase3_plus_percentage_projected** | **float** | | [optional] +**estimated_population_projected** | **float** | | [optional] +**phase1_population_projected** | **float** | | [optional] +**phase1_percentage_projected** | **float** | | [optional] +**phase2_population_projected** | **float** | | [optional] +**phase2_percentage_projected** | **float** | | [optional] +**phase3_population_projected** | **float** | | [optional] +**phase3_percentage_projected** | **float** | | [optional] +**phase4_population_projected** | **float** | | [optional] +**phase4_percentage_projected** | **float** | | [optional] +**phase5_population_projected** | **float** | | [optional] +**phase5_percentage_projected** | **float** | | [optional] +**phase3_plus_population_second_projected** | **float** | | [optional] +**phase3_plus_percentage_second_projected** | **float** | | [optional] +**estimated_population_second_projected** | **float** | | [optional] +**phase1_population_second_projected** | **float** | | [optional] +**phase1_percentage_second_projected** | **float** | | [optional] +**phase2_population_second_projected** | **float** | | [optional] +**phase2_percentage_second_projected** | **float** | | [optional] +**phase3_population_second_projected** | **float** | | [optional] +**phase3_percentage_second_projected** | **float** | | [optional] +**phase4_population_second_projected** | **float** | | [optional] +**phase4_percentage_second_projected** | **float** | | [optional] +**phase5_population_second_projected** | **float** | | [optional] +**phase5_percentage_second_projected** | **float** | | [optional] + +## Example + +```python +from data_bridges_client.models.ipc_historical_datum_dto import IpcHistoricalDatumDto + +# TODO update the JSON string below +json = "{}" +# create an instance of IpcHistoricalDatumDto from a JSON string +ipc_historical_datum_dto_instance = IpcHistoricalDatumDto.from_json(json) +# print the JSON string representation of the object +print(IpcHistoricalDatumDto.to_json()) + +# convert the object into a dict +ipc_historical_datum_dto_dict = ipc_historical_datum_dto_instance.to_dict() +# create an instance of IpcHistoricalDatumDto from a dict +ipc_historical_datum_dto_from_dict = IpcHistoricalDatumDto.from_dict(ipc_historical_datum_dto_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IpcHistoricalDatumDtoPagedResult.md b/docs/IpcHistoricalDatumDtoPagedResult.md new file mode 100644 index 0000000..030ff9e --- /dev/null +++ b/docs/IpcHistoricalDatumDtoPagedResult.md @@ -0,0 +1,31 @@ +# IpcHistoricalDatumDtoPagedResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[IpcHistoricalDatumDto]**](IpcHistoricalDatumDto.md) | | [optional] [readonly] +**page** | **int** | | [optional] +**total_items** | **int** | | [optional] + +## Example + +```python +from data_bridges_client.models.ipc_historical_datum_dto_paged_result import IpcHistoricalDatumDtoPagedResult + +# TODO update the JSON string below +json = "{}" +# create an instance of IpcHistoricalDatumDtoPagedResult from a JSON string +ipc_historical_datum_dto_paged_result_instance = IpcHistoricalDatumDtoPagedResult.from_json(json) +# print the JSON string representation of the object +print(IpcHistoricalDatumDtoPagedResult.to_json()) + +# convert the object into a dict +ipc_historical_datum_dto_paged_result_dict = ipc_historical_datum_dto_paged_result_instance.to_dict() +# create an instance of IpcHistoricalDatumDtoPagedResult from a dict +ipc_historical_datum_dto_paged_result_from_dict = IpcHistoricalDatumDtoPagedResult.from_dict(ipc_historical_datum_dto_paged_result_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IpcValue.md b/docs/IpcValue.md deleted file mode 100644 index 403657f..0000000 --- a/docs/IpcValue.md +++ /dev/null @@ -1,53 +0,0 @@ -# IpcValue - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ipc_id** | **int** | | [optional] -**ipc_year** | **int** | | [optional] -**ipc_update_date** | **datetime** | | [optional] -**iso3_alpha3** | **str** | | [optional] -**ipc_country_name** | **str** | | [optional] -**ipc_area_name** | **str** | | [optional] -**ipc_phase3_population** | **int** | | [optional] -**ipc_phase4_population** | **int** | | [optional] -**ipc_phase5_population** | **int** | | [optional] -**ipc_phase35population** | **int** | | [optional] -**ipc_phase45population** | **int** | | [optional] -**ipc_phase3_percentage** | **float** | | [optional] -**ipc_phase4_percentage** | **float** | | [optional] -**ipc_phase5_percentage** | **float** | | [optional] -**ipc_phase35percentage** | **float** | | [optional] -**ipc_phase45percentage** | **float** | | [optional] -**ipc_analysed_population** | **int** | | [optional] -**ipc_analysed_percentage** | **float** | | [optional] -**ipc_analysis_comment** | **str** | | [optional] -**ipc_data_type** | **str** | | [optional] -**ipc_data_source** | **str** | | [optional] -**ipc_reference_period** | **str** | | [optional] -**ipc_create_date** | **datetime** | | [optional] -**ipc_show_on_data_viz** | **bool** | | [optional] -**ipc_is_latest_value** | **bool** | | [optional] - -## Example - -```python -from data_bridges_client.models.ipc_value import IpcValue - -# TODO update the JSON string below -json = "{}" -# create an instance of IpcValue from a JSON string -ipc_value_instance = IpcValue.from_json(json) -# print the JSON string representation of the object -print(IpcValue.to_json()) - -# convert the object into a dict -ipc_value_dict = ipc_value_instance.to_dict() -# create an instance of IpcValue from a dict -ipc_value_from_dict = IpcValue.from_dict(ipc_value_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/IpcValuePagedResult.md b/docs/IpcValuePagedResult.md deleted file mode 100644 index 6b6da03..0000000 --- a/docs/IpcValuePagedResult.md +++ /dev/null @@ -1,31 +0,0 @@ -# IpcValuePagedResult - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**items** | [**List[IpcValue]**](IpcValue.md) | | [optional] [readonly] -**page** | **int** | | [optional] -**total_items** | **int** | | [optional] - -## Example - -```python -from data_bridges_client.models.ipc_value_paged_result import IpcValuePagedResult - -# TODO update the JSON string below -json = "{}" -# create an instance of IpcValuePagedResult from a JSON string -ipc_value_paged_result_instance = IpcValuePagedResult.from_json(json) -# print the JSON string representation of the object -print(IpcValuePagedResult.to_json()) - -# convert the object into a dict -ipc_value_paged_result_dict = ipc_value_paged_result_instance.to_dict() -# create an instance of IpcValuePagedResult from a dict -ipc_value_paged_result_from_dict = IpcValuePagedResult.from_dict(ipc_value_paged_result_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/IpcchAndEquivalentPeaksDTO.md b/docs/IpcchAndEquivalentPeaksDTO.md new file mode 100644 index 0000000..6bfd4f2 --- /dev/null +++ b/docs/IpcchAndEquivalentPeaksDTO.md @@ -0,0 +1,36 @@ +# IpcchAndEquivalentPeaksDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**regional_bureau_id** | **int** | | [optional] +**regional_bureau_name** | **str** | | [optional] +**iso3_alpha3** | **str** | | [optional] +**country_name** | **str** | | [optional] +**phase3_population** | **int** | | [optional] +**phase4_population** | **int** | | [optional] +**phase5_population** | **int** | | [optional] +**phase3_plus_population** | **int** | | [optional] + +## Example + +```python +from data_bridges_client.models.ipcch_and_equivalent_peaks_dto import IpcchAndEquivalentPeaksDTO + +# TODO update the JSON string below +json = "{}" +# create an instance of IpcchAndEquivalentPeaksDTO from a JSON string +ipcch_and_equivalent_peaks_dto_instance = IpcchAndEquivalentPeaksDTO.from_json(json) +# print the JSON string representation of the object +print(IpcchAndEquivalentPeaksDTO.to_json()) + +# convert the object into a dict +ipcch_and_equivalent_peaks_dto_dict = ipcch_and_equivalent_peaks_dto_instance.to_dict() +# create an instance of IpcchAndEquivalentPeaksDTO from a dict +ipcch_and_equivalent_peaks_dto_from_dict = IpcchAndEquivalentPeaksDTO.from_dict(ipcch_and_equivalent_peaks_dto_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IpcchAndEquivalentPeaksDTOPagedResult.md b/docs/IpcchAndEquivalentPeaksDTOPagedResult.md new file mode 100644 index 0000000..c77bae9 --- /dev/null +++ b/docs/IpcchAndEquivalentPeaksDTOPagedResult.md @@ -0,0 +1,31 @@ +# IpcchAndEquivalentPeaksDTOPagedResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[IpcchAndEquivalentPeaksDTO]**](IpcchAndEquivalentPeaksDTO.md) | | [optional] [readonly] +**page** | **int** | | [optional] +**total_items** | **int** | | [optional] + +## Example + +```python +from data_bridges_client.models.ipcch_and_equivalent_peaks_dto_paged_result import IpcchAndEquivalentPeaksDTOPagedResult + +# TODO update the JSON string below +json = "{}" +# create an instance of IpcchAndEquivalentPeaksDTOPagedResult from a JSON string +ipcch_and_equivalent_peaks_dto_paged_result_instance = IpcchAndEquivalentPeaksDTOPagedResult.from_json(json) +# print the JSON string representation of the object +print(IpcchAndEquivalentPeaksDTOPagedResult.to_json()) + +# convert the object into a dict +ipcch_and_equivalent_peaks_dto_paged_result_dict = ipcch_and_equivalent_peaks_dto_paged_result_instance.to_dict() +# create an instance of IpcchAndEquivalentPeaksDTOPagedResult from a dict +ipcch_and_equivalent_peaks_dto_paged_result_from_dict = IpcchAndEquivalentPeaksDTOPagedResult.from_dict(ipcch_and_equivalent_peaks_dto_paged_result_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IpcchApi.md b/docs/IpcchApi.md new file mode 100644 index 0000000..644f657 --- /dev/null +++ b/docs/IpcchApi.md @@ -0,0 +1,419 @@ +# data_bridges_client.IpcchApi + +All URIs are relative to *https://api.wfp.org/vam-data-bridges/7.0.0* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**ipcch_ipcch_and_equivalent_historical_peaks_get**](IpcchApi.md#ipcch_ipcch_and_equivalent_historical_peaks_get) | **GET** /Ipcch/IPCCHAndEquivalent-HistoricalPeaks | Retrieves a paginated list of historical IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. +[**ipcch_ipcch_and_equivalent_latest_peaks_get**](IpcchApi.md#ipcch_ipcch_and_equivalent_latest_peaks_get) | **GET** /Ipcch/IPCCHAndEquivalent-LatestPeaks | Retrieves a paginated list of the latest IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. +[**ipcch_ipcch_and_equivalent_most_recent_get**](IpcchApi.md#ipcch_ipcch_and_equivalent_most_recent_get) | **GET** /Ipcch/IPCCHAndEquivalent-MostRecent | Retrieves a paginated list of the most recent IPCCH and Equivalent data, optionally filtered by ISO3 country code. +[**ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get**](IpcchApi.md#ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get) | **GET** /Ipcch/IPCCHAndEquivalentPeaks-WFPDashboard | Retrieves a paginated list of IPCCH and Equivalent Peaks data for the WFP Dashboard. +[**ipcch_ipcch_historical_data_get**](IpcchApi.md#ipcch_ipcch_historical_data_get) | **GET** /Ipcch/IPCCH-HistoricalData | Retrieves a paginated list of IPCCH and Equivalent Historical Data. + + +# **ipcch_ipcch_and_equivalent_historical_peaks_get** +> IpcchPeaksDtoPagedResult ipcch_ipcch_and_equivalent_historical_peaks_get(reference_year=reference_year, iso3=iso3, page=page, env=env) + +Retrieves a paginated list of historical IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalent-historicalpeaks_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.ipcch_peaks_dto_paged_result import IpcchPeaksDtoPagedResult +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/7.0.0 +# See configuration.py for a list of all supported configuration parameters. +configuration = data_bridges_client.Configuration( + host = "https://api.wfp.org/vam-data-bridges/7.0.0" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +configuration.access_token = os.environ["ACCESS_TOKEN"] + +# Enter a context with an instance of the API client +with data_bridges_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = data_bridges_client.IpcchApi(api_client) + reference_year = 56 # int | Year in a 4 digit format, for example: 2025 (optional) + iso3 = 'iso3_example' # str | (optional) + page = 1 # int | (optional) (default to 1) + env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) + + try: + # Retrieves a paginated list of historical IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. + api_response = api_instance.ipcch_ipcch_and_equivalent_historical_peaks_get(reference_year=reference_year, iso3=iso3, page=page, env=env) + print("The response of IpcchApi->ipcch_ipcch_and_equivalent_historical_peaks_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IpcchApi->ipcch_ipcch_and_equivalent_historical_peaks_get: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **reference_year** | **int**| Year in a 4 digit format, for example: 2025 | [optional] + **iso3** | **str**| | [optional] + **page** | **int**| | [optional] [default to 1] + **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] + +### Return type + +[**IpcchPeaksDtoPagedResult**](IpcchPeaksDtoPagedResult.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) + +# **ipcch_ipcch_and_equivalent_latest_peaks_get** +> IpcchPeaksDtoPagedResult ipcch_ipcch_and_equivalent_latest_peaks_get(iso3=iso3, page=page, env=env) + +Retrieves a paginated list of the latest IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalent-latestpeaks_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.ipcch_peaks_dto_paged_result import IpcchPeaksDtoPagedResult +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/7.0.0 +# See configuration.py for a list of all supported configuration parameters. +configuration = data_bridges_client.Configuration( + host = "https://api.wfp.org/vam-data-bridges/7.0.0" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +configuration.access_token = os.environ["ACCESS_TOKEN"] + +# Enter a context with an instance of the API client +with data_bridges_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = data_bridges_client.IpcchApi(api_client) + iso3 = 'iso3_example' # str | (optional) + page = 1 # int | (optional) (default to 1) + env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) + + try: + # Retrieves a paginated list of the latest IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. + api_response = api_instance.ipcch_ipcch_and_equivalent_latest_peaks_get(iso3=iso3, page=page, env=env) + print("The response of IpcchApi->ipcch_ipcch_and_equivalent_latest_peaks_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IpcchApi->ipcch_ipcch_and_equivalent_latest_peaks_get: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **iso3** | **str**| | [optional] + **page** | **int**| | [optional] [default to 1] + **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] + +### Return type + +[**IpcchPeaksDtoPagedResult**](IpcchPeaksDtoPagedResult.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) + +# **ipcch_ipcch_and_equivalent_most_recent_get** +> IpcchBaseDtoPagedResult ipcch_ipcch_and_equivalent_most_recent_get(iso3=iso3, page=page, env=env) + +Retrieves a paginated list of the most recent IPCCH and Equivalent data, optionally filtered by ISO3 country code. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalent-mostrecent_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.ipcch_base_dto_paged_result import IpcchBaseDtoPagedResult +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/7.0.0 +# See configuration.py for a list of all supported configuration parameters. +configuration = data_bridges_client.Configuration( + host = "https://api.wfp.org/vam-data-bridges/7.0.0" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +configuration.access_token = os.environ["ACCESS_TOKEN"] + +# Enter a context with an instance of the API client +with data_bridges_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = data_bridges_client.IpcchApi(api_client) + iso3 = 'iso3_example' # str | (optional) + page = 1 # int | (optional) (default to 1) + env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) + + try: + # Retrieves a paginated list of the most recent IPCCH and Equivalent data, optionally filtered by ISO3 country code. + api_response = api_instance.ipcch_ipcch_and_equivalent_most_recent_get(iso3=iso3, page=page, env=env) + print("The response of IpcchApi->ipcch_ipcch_and_equivalent_most_recent_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IpcchApi->ipcch_ipcch_and_equivalent_most_recent_get: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **iso3** | **str**| | [optional] + **page** | **int**| | [optional] [default to 1] + **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] + +### Return type + +[**IpcchBaseDtoPagedResult**](IpcchBaseDtoPagedResult.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) + +# **ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get** +> IpcchAndEquivalentPeaksDTOPagedResult ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get(iso3=iso3, page=page, env=env) + +Retrieves a paginated list of IPCCH and Equivalent Peaks data for the WFP Dashboard. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcchandequivalentpeakswfpdashboard_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.ipcch_and_equivalent_peaks_dto_paged_result import IpcchAndEquivalentPeaksDTOPagedResult +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/7.0.0 +# See configuration.py for a list of all supported configuration parameters. +configuration = data_bridges_client.Configuration( + host = "https://api.wfp.org/vam-data-bridges/7.0.0" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +configuration.access_token = os.environ["ACCESS_TOKEN"] + +# Enter a context with an instance of the API client +with data_bridges_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = data_bridges_client.IpcchApi(api_client) + iso3 = 'iso3_example' # str | (optional) + page = 1 # int | The page number for pagination. Defaults to 1. (optional) (default to 1) + env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) + + try: + # Retrieves a paginated list of IPCCH and Equivalent Peaks data for the WFP Dashboard. + api_response = api_instance.ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get(iso3=iso3, page=page, env=env) + print("The response of IpcchApi->ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IpcchApi->ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **iso3** | **str**| | [optional] + **page** | **int**| The page number for pagination. Defaults to 1. | [optional] [default to 1] + **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] + +### Return type + +[**IpcchAndEquivalentPeaksDTOPagedResult**](IpcchAndEquivalentPeaksDTOPagedResult.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) + +# **ipcch_ipcch_historical_data_get** +> IpcHistoricalDatumDtoPagedResult ipcch_ipcch_historical_data_get(from_date=from_date, to_date=to_date, iso3=iso3, page=page, env=env) + +Retrieves a paginated list of IPCCH and Equivalent Historical Data. + + [![Generic badge](https://img.shields.io/badge/Maturity%20Level-Production%20Ready-green)]() [![Generic badge](https://img.shields.io/badge/Access_Policy-TEC_Architecture_approval_required-yellow)]() [![Generic badge](https://img.shields.io/badge/Data%20Classification-Public-green)]() ### This endpoint is restricted, it requires the scope: \"vamdatabridges_ipcch-ipcch-historicaldata_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.ipc_historical_datum_dto_paged_result import IpcHistoricalDatumDtoPagedResult +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/7.0.0 +# See configuration.py for a list of all supported configuration parameters. +configuration = data_bridges_client.Configuration( + host = "https://api.wfp.org/vam-data-bridges/7.0.0" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +configuration.access_token = os.environ["ACCESS_TOKEN"] + +# Enter a context with an instance of the API client +with data_bridges_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = data_bridges_client.IpcchApi(api_client) + from_date = '2013-10-20T19:20:30+01:00' # datetime | Date in the format yyyy-mm-dd, refers to the analysis date (optional) + to_date = '2013-10-20T19:20:30+01:00' # datetime | Date in the format yyyy-mm-dd, refers to the analysis date (optional) + iso3 = 'iso3_example' # str | (optional) + page = 1 # int | (optional) (default to 1) + env = 'env_example' # str | Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org (optional) + + try: + # Retrieves a paginated list of IPCCH and Equivalent Historical Data. + api_response = api_instance.ipcch_ipcch_historical_data_get(from_date=from_date, to_date=to_date, iso3=iso3, page=page, env=env) + print("The response of IpcchApi->ipcch_ipcch_historical_data_get:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IpcchApi->ipcch_ipcch_historical_data_get: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **from_date** | **datetime**| Date in the format yyyy-mm-dd, refers to the analysis date | [optional] + **to_date** | **datetime**| Date in the format yyyy-mm-dd, refers to the analysis date | [optional] + **iso3** | **str**| | [optional] + **page** | **int**| | [optional] [default to 1] + **env** | **str**| Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org | [optional] + +### Return type + +[**IpcHistoricalDatumDtoPagedResult**](IpcHistoricalDatumDtoPagedResult.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) + diff --git a/docs/IpcchBaseDto.md b/docs/IpcchBaseDto.md new file mode 100644 index 0000000..8109eda --- /dev/null +++ b/docs/IpcchBaseDto.md @@ -0,0 +1,51 @@ +# IpcchBaseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**iso3_alpha3** | **str** | | [optional] +**country_name** | **str** | | [optional] +**population_group_id** | **int** | | [optional] +**population_group_name** | **str** | | [optional] +**analysis_title** | **str** | | [optional] +**analysis_date** | **datetime** | | [optional] +**period_start** | **datetime** | | [optional] +**period_end** | **datetime** | | [optional] +**period_type** | **str** | | [optional] +**population** | **float** | | [optional] +**population_analysed** | **int** | | [optional] +**population_analysed_percentage** | **float** | | [optional] +**phase3_population** | **float** | | [optional] +**phase4_population** | **float** | | [optional] +**phase5_population** | **float** | | [optional] +**phase3_plus_population** | **float** | | [optional] +**phase4_plus_population** | **int** | | [optional] +**phase3_percentage** | **float** | | [optional] +**phase4_percentage** | **float** | | [optional] +**phase5_percentage** | **float** | | [optional] +**phase3_plus_percentage** | **float** | | [optional] +**phase4_plus_percentage** | **float** | | [optional] +**data_source** | **str** | | [optional] + +## Example + +```python +from data_bridges_client.models.ipcch_base_dto import IpcchBaseDto + +# TODO update the JSON string below +json = "{}" +# create an instance of IpcchBaseDto from a JSON string +ipcch_base_dto_instance = IpcchBaseDto.from_json(json) +# print the JSON string representation of the object +print(IpcchBaseDto.to_json()) + +# convert the object into a dict +ipcch_base_dto_dict = ipcch_base_dto_instance.to_dict() +# create an instance of IpcchBaseDto from a dict +ipcch_base_dto_from_dict = IpcchBaseDto.from_dict(ipcch_base_dto_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IpcchBaseDtoPagedResult.md b/docs/IpcchBaseDtoPagedResult.md new file mode 100644 index 0000000..5e23434 --- /dev/null +++ b/docs/IpcchBaseDtoPagedResult.md @@ -0,0 +1,31 @@ +# IpcchBaseDtoPagedResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[IpcchBaseDto]**](IpcchBaseDto.md) | | [optional] [readonly] +**page** | **int** | | [optional] +**total_items** | **int** | | [optional] + +## Example + +```python +from data_bridges_client.models.ipcch_base_dto_paged_result import IpcchBaseDtoPagedResult + +# TODO update the JSON string below +json = "{}" +# create an instance of IpcchBaseDtoPagedResult from a JSON string +ipcch_base_dto_paged_result_instance = IpcchBaseDtoPagedResult.from_json(json) +# print the JSON string representation of the object +print(IpcchBaseDtoPagedResult.to_json()) + +# convert the object into a dict +ipcch_base_dto_paged_result_dict = ipcch_base_dto_paged_result_instance.to_dict() +# create an instance of IpcchBaseDtoPagedResult from a dict +ipcch_base_dto_paged_result_from_dict = IpcchBaseDtoPagedResult.from_dict(ipcch_base_dto_paged_result_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IpcchPeaksDto.md b/docs/IpcchPeaksDto.md new file mode 100644 index 0000000..b873997 --- /dev/null +++ b/docs/IpcchPeaksDto.md @@ -0,0 +1,52 @@ +# IpcchPeaksDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**iso3_alpha3** | **str** | | [optional] +**country_name** | **str** | | [optional] +**population_group_id** | **int** | | [optional] +**population_group_name** | **str** | | [optional] +**analysis_title** | **str** | | [optional] +**analysis_date** | **datetime** | | [optional] +**period_start** | **datetime** | | [optional] +**period_end** | **datetime** | | [optional] +**period_type** | **str** | | [optional] +**population** | **float** | | [optional] +**population_analysed** | **int** | | [optional] +**population_analysed_percentage** | **float** | | [optional] +**phase3_population** | **float** | | [optional] +**phase4_population** | **float** | | [optional] +**phase5_population** | **float** | | [optional] +**phase3_plus_population** | **float** | | [optional] +**phase4_plus_population** | **int** | | [optional] +**phase3_percentage** | **float** | | [optional] +**phase4_percentage** | **float** | | [optional] +**phase5_percentage** | **float** | | [optional] +**phase3_plus_percentage** | **float** | | [optional] +**phase4_plus_percentage** | **float** | | [optional] +**data_source** | **str** | | [optional] +**reference_year** | **int** | | [optional] + +## Example + +```python +from data_bridges_client.models.ipcch_peaks_dto import IpcchPeaksDto + +# TODO update the JSON string below +json = "{}" +# create an instance of IpcchPeaksDto from a JSON string +ipcch_peaks_dto_instance = IpcchPeaksDto.from_json(json) +# print the JSON string representation of the object +print(IpcchPeaksDto.to_json()) + +# convert the object into a dict +ipcch_peaks_dto_dict = ipcch_peaks_dto_instance.to_dict() +# create an instance of IpcchPeaksDto from a dict +ipcch_peaks_dto_from_dict = IpcchPeaksDto.from_dict(ipcch_peaks_dto_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IpcchPeaksDtoPagedResult.md b/docs/IpcchPeaksDtoPagedResult.md new file mode 100644 index 0000000..7177a40 --- /dev/null +++ b/docs/IpcchPeaksDtoPagedResult.md @@ -0,0 +1,31 @@ +# IpcchPeaksDtoPagedResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[IpcchPeaksDto]**](IpcchPeaksDto.md) | | [optional] [readonly] +**page** | **int** | | [optional] +**total_items** | **int** | | [optional] + +## Example + +```python +from data_bridges_client.models.ipcch_peaks_dto_paged_result import IpcchPeaksDtoPagedResult + +# TODO update the JSON string below +json = "{}" +# create an instance of IpcchPeaksDtoPagedResult from a JSON string +ipcch_peaks_dto_paged_result_instance = IpcchPeaksDtoPagedResult.from_json(json) +# print the JSON string representation of the object +print(IpcchPeaksDtoPagedResult.to_json()) + +# convert the object into a dict +ipcch_peaks_dto_paged_result_dict = ipcch_peaks_dto_paged_result_instance.to_dict() +# create an instance of IpcchPeaksDtoPagedResult from a dict +ipcch_peaks_dto_paged_result_from_dict = IpcchPeaksDtoPagedResult.from_dict(ipcch_peaks_dto_paged_result_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ListItemDto.md b/docs/ListItemDto.md new file mode 100644 index 0000000..9f4fea1 --- /dev/null +++ b/docs/ListItemDto.md @@ -0,0 +1,31 @@ +# ListItemDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [optional] +**name** | **str** | | +**label** | **str** | | + +## Example + +```python +from data_bridges_client.models.list_item_dto import ListItemDto + +# TODO update the JSON string below +json = "{}" +# create an instance of ListItemDto from a JSON string +list_item_dto_instance = ListItemDto.from_json(json) +# print the JSON string representation of the object +print(ListItemDto.to_json()) + +# convert the object into a dict +list_item_dto_dict = list_item_dto_instance.to_dict() +# create an instance of ListItemDto from a dict +list_item_dto_from_dict = ListItemDto.from_dict(list_item_dto_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MarketPricesApi.md b/docs/MarketPricesApi.md index e3828a7..fbdb20e 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/6.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/7.0.0* Method | HTTP request | Description ------------- | ------------- | ------------- @@ -12,7 +12,7 @@ Method | HTTP request | Description # **market_prices_alps_get** -> ViewExtendedAlpsValuePagedResult market_prices_alps_get(country_code=country_code, market_id=market_id, commodity_id=commodity_id, price_type_name=price_type_name, currency_id=currency_id, price_flag=price_flag, start_date=start_date, end_date=end_date, latest_value_only=latest_value_only, page=page, format=format, env=env) +> ExtendedAlpsValueDtoPagedResult market_prices_alps_get(country_code=country_code, market_id=market_id, commodity_id=commodity_id, price_type_name=price_type_name, currency_id=currency_id, price_flag=price_flag, start_date=start_date, end_date=end_date, latest_value_only=latest_value_only, page=page, format=format, env=env) Returns time series values of ALPS and PEWI. @@ -24,14 +24,14 @@ Returns time series values of ALPS and PEWI. ```python import data_bridges_client -from data_bridges_client.models.view_extended_alps_value_paged_result import ViewExtendedAlpsValuePagedResult +from data_bridges_client.models.extended_alps_value_dto_paged_result import ExtendedAlpsValueDtoPagedResult 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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -89,7 +89,7 @@ Name | Type | Description | Notes ### Return type -[**ViewExtendedAlpsValuePagedResult**](ViewExtendedAlpsValuePagedResult.md) +[**ExtendedAlpsValueDtoPagedResult**](ExtendedAlpsValueDtoPagedResult.md) ### Authorization @@ -110,7 +110,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **market_prices_price_daily_get** -> ViewExtendedAggregatedPricePagedResult market_prices_price_daily_get(country_code=country_code, market_id=market_id, commodity_id=commodity_id, price_type_name=price_type_name, currency_id=currency_id, price_flag=price_flag, start_date=start_date, end_date=end_date, latest_value_only=latest_value_only, page=page, format=format, env=env) +> ViewExtendedMonthlyAggregatedPricePagedResult market_prices_price_daily_get(country_code=country_code, market_id=market_id, commodity_id=commodity_id, price_type_name=price_type_name, currency_id=currency_id, price_flag=price_flag, start_date=start_date, end_date=end_date, latest_value_only=latest_value_only, page=page, format=format, env=env) Returns a daily time series of commodity market prices. @@ -122,14 +122,14 @@ Returns a daily time series of commodity market prices. ```python import data_bridges_client -from data_bridges_client.models.view_extended_aggregated_price_paged_result import ViewExtendedAggregatedPricePagedResult +from data_bridges_client.models.view_extended_monthly_aggregated_price_paged_result import ViewExtendedMonthlyAggregatedPricePagedResult 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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -187,7 +187,7 @@ Name | Type | Description | Notes ### Return type -[**ViewExtendedAggregatedPricePagedResult**](ViewExtendedAggregatedPricePagedResult.md) +[**ViewExtendedMonthlyAggregatedPricePagedResult**](ViewExtendedMonthlyAggregatedPricePagedResult.md) ### Authorization @@ -208,7 +208,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **market_prices_price_monthly_get** -> ViewExtendedAggregatedPricePagedResult market_prices_price_monthly_get(country_code=country_code, market_id=market_id, commodity_id=commodity_id, price_type_name=price_type_name, currency_id=currency_id, price_flag=price_flag, start_date=start_date, end_date=end_date, latest_value_only=latest_value_only, page=page, format=format, env=env) +> ViewExtendedMonthlyAggregatedPricePagedResult market_prices_price_monthly_get(country_code=country_code, market_id=market_id, commodity_id=commodity_id, price_type_name=price_type_name, currency_id=currency_id, price_flag=price_flag, start_date=start_date, end_date=end_date, latest_value_only=latest_value_only, page=page, format=format, env=env) Returns a monthly time series of commodity market prices. @@ -220,14 +220,14 @@ Returns a monthly time series of commodity market prices. ```python import data_bridges_client -from data_bridges_client.models.view_extended_aggregated_price_paged_result import ViewExtendedAggregatedPricePagedResult +from data_bridges_client.models.view_extended_monthly_aggregated_price_paged_result import ViewExtendedMonthlyAggregatedPricePagedResult 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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -285,7 +285,7 @@ Name | Type | Description | Notes ### Return type -[**ViewExtendedAggregatedPricePagedResult**](ViewExtendedAggregatedPricePagedResult.md) +[**ViewExtendedMonthlyAggregatedPricePagedResult**](ViewExtendedMonthlyAggregatedPricePagedResult.md) ### Authorization @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters diff --git a/docs/MarketsApi.md b/docs/MarketsApi.md index 2c9a807..459d0cb 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/6.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/7.0.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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters diff --git a/docs/RpmeApi.md b/docs/RpmeApi.md index acd5614..99cca22 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/6.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/7.0.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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters diff --git a/docs/SurveysApi.md b/docs/SurveysApi.md index 7f812f2..0bf2252 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/6.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/7.0.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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters @@ -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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters diff --git a/docs/ViewExtendedAggregatedPricePagedResult.md b/docs/ViewExtendedAggregatedPricePagedResult.md deleted file mode 100644 index 6c53cfe..0000000 --- a/docs/ViewExtendedAggregatedPricePagedResult.md +++ /dev/null @@ -1,31 +0,0 @@ -# ViewExtendedAggregatedPricePagedResult - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**items** | [**List[ViewExtendedAggregatedPrice]**](ViewExtendedAggregatedPrice.md) | | [optional] [readonly] -**page** | **int** | | [optional] -**total_items** | **int** | | [optional] - -## Example - -```python -from data_bridges_client.models.view_extended_aggregated_price_paged_result import ViewExtendedAggregatedPricePagedResult - -# TODO update the JSON string below -json = "{}" -# create an instance of ViewExtendedAggregatedPricePagedResult from a JSON string -view_extended_aggregated_price_paged_result_instance = ViewExtendedAggregatedPricePagedResult.from_json(json) -# print the JSON string representation of the object -print(ViewExtendedAggregatedPricePagedResult.to_json()) - -# convert the object into a dict -view_extended_aggregated_price_paged_result_dict = view_extended_aggregated_price_paged_result_instance.to_dict() -# create an instance of ViewExtendedAggregatedPricePagedResult from a dict -view_extended_aggregated_price_paged_result_from_dict = ViewExtendedAggregatedPricePagedResult.from_dict(view_extended_aggregated_price_paged_result_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ViewExtendedAlpsValuePagedResult.md b/docs/ViewExtendedAlpsValuePagedResult.md deleted file mode 100644 index fa809fd..0000000 --- a/docs/ViewExtendedAlpsValuePagedResult.md +++ /dev/null @@ -1,31 +0,0 @@ -# ViewExtendedAlpsValuePagedResult - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**items** | [**List[ViewExtendedAlpsValue]**](ViewExtendedAlpsValue.md) | | [optional] [readonly] -**page** | **int** | | [optional] -**total_items** | **int** | | [optional] - -## Example - -```python -from data_bridges_client.models.view_extended_alps_value_paged_result import ViewExtendedAlpsValuePagedResult - -# TODO update the JSON string below -json = "{}" -# create an instance of ViewExtendedAlpsValuePagedResult from a JSON string -view_extended_alps_value_paged_result_instance = ViewExtendedAlpsValuePagedResult.from_json(json) -# print the JSON string representation of the object -print(ViewExtendedAlpsValuePagedResult.to_json()) - -# convert the object into a dict -view_extended_alps_value_paged_result_dict = view_extended_alps_value_paged_result_instance.to_dict() -# create an instance of ViewExtendedAlpsValuePagedResult from a dict -view_extended_alps_value_paged_result_from_dict = ViewExtendedAlpsValuePagedResult.from_dict(view_extended_alps_value_paged_result_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ViewExtendedAggregatedPrice.md b/docs/ViewExtendedMonthlyAggregatedPrice.md similarity index 68% rename from docs/ViewExtendedAggregatedPrice.md rename to docs/ViewExtendedMonthlyAggregatedPrice.md index a469a08..e914c07 100644 --- a/docs/ViewExtendedAggregatedPrice.md +++ b/docs/ViewExtendedMonthlyAggregatedPrice.md @@ -1,4 +1,4 @@ -# ViewExtendedAggregatedPrice +# ViewExtendedMonthlyAggregatedPrice ## Properties @@ -31,19 +31,19 @@ Name | Type | Description | Notes ## Example ```python -from data_bridges_client.models.view_extended_aggregated_price import ViewExtendedAggregatedPrice +from data_bridges_client.models.view_extended_monthly_aggregated_price import ViewExtendedMonthlyAggregatedPrice # TODO update the JSON string below json = "{}" -# create an instance of ViewExtendedAggregatedPrice from a JSON string -view_extended_aggregated_price_instance = ViewExtendedAggregatedPrice.from_json(json) +# create an instance of ViewExtendedMonthlyAggregatedPrice from a JSON string +view_extended_monthly_aggregated_price_instance = ViewExtendedMonthlyAggregatedPrice.from_json(json) # print the JSON string representation of the object -print(ViewExtendedAggregatedPrice.to_json()) +print(ViewExtendedMonthlyAggregatedPrice.to_json()) # convert the object into a dict -view_extended_aggregated_price_dict = view_extended_aggregated_price_instance.to_dict() -# create an instance of ViewExtendedAggregatedPrice from a dict -view_extended_aggregated_price_from_dict = ViewExtendedAggregatedPrice.from_dict(view_extended_aggregated_price_dict) +view_extended_monthly_aggregated_price_dict = view_extended_monthly_aggregated_price_instance.to_dict() +# create an instance of ViewExtendedMonthlyAggregatedPrice from a dict +view_extended_monthly_aggregated_price_from_dict = ViewExtendedMonthlyAggregatedPrice.from_dict(view_extended_monthly_aggregated_price_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ViewExtendedMonthlyAggregatedPricePagedResult.md b/docs/ViewExtendedMonthlyAggregatedPricePagedResult.md new file mode 100644 index 0000000..78ab11e --- /dev/null +++ b/docs/ViewExtendedMonthlyAggregatedPricePagedResult.md @@ -0,0 +1,31 @@ +# ViewExtendedMonthlyAggregatedPricePagedResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List[ViewExtendedMonthlyAggregatedPrice]**](ViewExtendedMonthlyAggregatedPrice.md) | | [optional] [readonly] +**page** | **int** | | [optional] +**total_items** | **int** | | [optional] + +## Example + +```python +from data_bridges_client.models.view_extended_monthly_aggregated_price_paged_result import ViewExtendedMonthlyAggregatedPricePagedResult + +# TODO update the JSON string below +json = "{}" +# create an instance of ViewExtendedMonthlyAggregatedPricePagedResult from a JSON string +view_extended_monthly_aggregated_price_paged_result_instance = ViewExtendedMonthlyAggregatedPricePagedResult.from_json(json) +# print the JSON string representation of the object +print(ViewExtendedMonthlyAggregatedPricePagedResult.to_json()) + +# convert the object into a dict +view_extended_monthly_aggregated_price_paged_result_dict = view_extended_monthly_aggregated_price_paged_result_instance.to_dict() +# create an instance of ViewExtendedMonthlyAggregatedPricePagedResult from a dict +view_extended_monthly_aggregated_price_paged_result_from_dict = ViewExtendedMonthlyAggregatedPricePagedResult.from_dict(view_extended_monthly_aggregated_price_paged_result_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/WeeklyAggregatedPrice.md b/docs/WeeklyAggregatedPrice.md index 4b8d6b8..712c40a 100644 --- a/docs/WeeklyAggregatedPrice.md +++ b/docs/WeeklyAggregatedPrice.md @@ -10,21 +10,22 @@ Name | Type | Description | Notes **price_type_id** | **int** | | [optional] **commodity_unit_id** | **int** | | [optional] **currency_id** | **int** | | [optional] +**adm0_code** | **int** | | [optional] +**commodity_date_week** | **int** | | [optional] +**commodity_date_month** | **int** | | [optional] +**commodity_date_year** | **int** | | [optional] +**commodity_price_date** | **datetime** | | [optional] **commodity_name** | **str** | | [optional] **market_name** | **str** | | [optional] **price_type_name** | **str** | | [optional] **commodity_unit_name** | **str** | | [optional] **currency_name** | **str** | | [optional] -**adm0_code** | **int** | | [optional] **country_iso3** | **str** | | [optional] **country_name** | **str** | | [optional] -**commodity_price** | **float** | | [optional] -**original_frequency** | **str** | | [optional] **commodity_price_source_name** | **str** | | [optional] +**original_frequency** | **str** | | [optional] +**commodity_price** | **float** | | [optional] **commodity_price_observations** | **int** | | [optional] -**commodity_date_month** | **int** | | [optional] -**commodity_date_year** | **int** | | [optional] -**commodity_price_date** | **datetime** | | [optional] **commodity_price_flag** | **str** | | [optional] ## Example diff --git a/docs/XlsFormsApi.md b/docs/XlsFormsApi.md index 423b3ec..5da65b1 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/6.0.0* +All URIs are relative to *https://api.wfp.org/vam-data-bridges/7.0.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/6.0.0 +# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/7.0.0 # See configuration.py for a list of all supported configuration parameters. configuration = data_bridges_client.Configuration( - host = "https://api.wfp.org/vam-data-bridges/6.0.0" + host = "https://api.wfp.org/vam-data-bridges/7.0.0" ) # The client must configure the authentication and authorization parameters diff --git a/generate/README.md b/generate/README.md index 7df193e..c13e806 100644 --- a/generate/README.md +++ b/generate/README.md @@ -26,5 +26,5 @@ mv ./token.py data_bridges_client/ ``` openapi-generator-cli generate -g python -i generate/swagger.json -o . --package-name data_bridges_client --git-user-id WFP-VAM --git-repo-id DataBridgesAPI ``` -4. Manually revert changes to `setup.py` and `README.md`. These relate to additional functionality we developed to handle the WFP token refresh workflow. +4. Manually revert changes to `setup.py`, `README.md` and `License.md`. These relate to additional functionality we developed to handle the WFP token refresh workflow. 5. Commit, push and open a PR into `dev` for review. \ No newline at end of file diff --git a/generate/generate.sh b/generate/generate.sh index 1e2cb26..06ba55a 100644 --- a/generate/generate.sh +++ b/generate/generate.sh @@ -1,3 +1,3 @@ #!/bin/bash -openapi-generator-cli version-manager set 5.4.0 +openapi-generator-cli version-manager set 7.8.0 openapi-generator-cli generate -g python -i generate/swagger.json -o . --package-name data_bridges_client --git-user-id WFP-VAM --git-repo-id DataBridgesAPI \ No newline at end of file diff --git a/generate/swagger_v5.1.0.json b/generate/swagger.json similarity index 83% rename from generate/swagger_v5.1.0.json rename to generate/swagger.json index 0ff6768..d967e45 100644 --- a/generate/swagger_v5.1.0.json +++ b/generate/swagger.json @@ -7,17 +7,17 @@ "name" : "VAM-INFO", "email" : "wfp.economicanalysis@wfp.org" }, - "version" : "5.1.0" + "version" : "7.0.0" }, "servers" : [ { - "url" : "https://api.wfp.org/vam-data-bridges/5.1.0" + "url" : "https://api.wfp.org/vam-data-bridges/7.0.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" : "Cari", + "description" : "Cari data" }, { "name" : "Commodities", "description" : "Returns the list of commodities and their categories." @@ -31,14 +31,17 @@ "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" : "GlobalOutlook", + "description" : "Number of acutely food insecure people in countries with WFP operational presence and where data is available, in millions. \r\nSource is WFP's Global Outlook (until 2024: Global Operational Response Plan), numbers are updated with each publication (2 times a year). \r\nNumbers are based on information from Integrated Phase Classification (IPC), Cadre Harmonisé (CH), or comparable analyses (peak values). \r\nAs updates provide improved estimates for the given year, they are not intended for trend analysis." }, { "name" : "Household", "description" : "Household Surveys" + }, { + "name" : "HungerHotspot", + "description" : "Hunger Hotspot data" + }, { + "name" : "Ipcch", + "description" : "IPCCH data" }, { "name" : "MarketPrices", "description" : "Returns time series of commodity market prices at different frequencies." @@ -56,22 +59,56 @@ "description" : "Market Functionality Index XLS Forms" } ], "paths" : { - "/Aims/DownloadAllAnalysisRounds" : { + "/Cari/Adm0Values" : { "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", + "summary" : "Retrieves a paginated list of Adm0 CARI results based on the specified indicator, administrative code, and\r\nsurvey.", + "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_cari-adm0values_get\"\n\nThis method returns a paginated list of results based on the provided filters. Ensure\r\n that the parameters are valid and correspond to existing data in the repository. If an error occurs during\r\n processing, a bad request response is returned with the error details.\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, + "description" : "The administrative level 0 code to filter the results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "surveyId", + "in" : "query", + "description" : "The unique identifier of the survey to filter the results.", + "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32" } + }, { + "name" : "indicatorId", + "in" : "query", + "description" : "The unique identifier of the indicator to filter the results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "page", + "in" : "query", + "description" : "The page number for pagination. Defaults to 1.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } }, { "name" : "env", "in" : "query", @@ -86,32 +123,103 @@ } ], "responses" : { "200" : { - "description" : "OK" + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/CariAdm0ValuesDTOPagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CariAdm0ValuesDTOPagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/CariAdm0ValuesDTOPagedResult" + } + } + } + }, + "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_aims-downloadallanalysisrounds_get" ] + "default" : [ "vamdatabridges_cari-adm0values_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/Aims/DownloadPolygonFiles" : { + "/Cari/Adm1Values" : { "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", + "summary" : "Retrieves a paginated list of Adm1 CARI results based on the specified indicator, administrative code, and\r\nsurvey.", + "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_cari-adm1values_get\"\n\nThis method returns a paginated list of results based on the provided filters. Ensure\r\n that the parameters are valid and correspond to existing data in the repository. If an error occurs during\r\n processing, a bad request response is returned with the error details.\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, + "description" : "The administrative level 0 code to filter the results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "surveyId", + "in" : "query", + "description" : "The unique identifier of the survey to filter the results.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "name" : "indicatorId", + "in" : "query", + "description" : "The unique identifier of the indicator to filter the results.", + "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32" } + }, { + "name" : "page", + "in" : "query", + "description" : "The page number for pagination. Defaults to 1.", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } }, { "name" : "env", "in" : "query", @@ -126,11 +234,48 @@ } ], "responses" : { "200" : { - "description" : "OK" + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/CariAdm1ValuesDTOPagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CariAdm1ValuesDTOPagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/CariAdm1ValuesDTOPagedResult" + } + } + } + }, + "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_aims-downloadpolygonfiles_get" ] + "default" : [ "vamdatabridges_cari-adm1values_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" @@ -1129,44 +1274,12 @@ "x-throttling-tier" : "Unlimited" } }, - "/FoodSecurity/List" : { + "/GlobalOutlook/CountryLatest" : { "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", + "tags" : [ "GlobalOutlook" ], + "summary" : "Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP's Global Outlook.", + "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_globaloutlook-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" : "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", @@ -1184,17 +1297,26 @@ "content" : { "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/IpcValuePagedResult" + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GlobalOutlookCountryApiDto" + } } }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/IpcValuePagedResult" + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GlobalOutlookCountryApiDto" + } } }, "text/json" : { "schema" : { - "$ref" : "#/components/schemas/IpcValuePagedResult" + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GlobalOutlookCountryApiDto" + } } } } @@ -1221,30 +1343,18 @@ } }, "security" : [ { - "default" : [ "vamdatabridges_foodsecurity-list_get" ] + "default" : [ "vamdatabridges_globaloutlook-countrylatest_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/Gorp/List" : { + "/GlobalOutlook/RegionalLatest" : { "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", + "tags" : [ "GlobalOutlook" ], + "summary" : "Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook.", + "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_globaloutlook-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" : "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", @@ -1262,17 +1372,26 @@ "content" : { "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/GorpValueWithChangesPagedResult" + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GlobalOutlookRegionalApiDto" + } } }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/GorpValueWithChangesPagedResult" + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GlobalOutlookRegionalApiDto" + } } }, "text/json" : { "schema" : { - "$ref" : "#/components/schemas/GorpValueWithChangesPagedResult" + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GlobalOutlookRegionalApiDto" + } } } } @@ -1299,30 +1418,18 @@ } }, "security" : [ { - "default" : [ "vamdatabridges_gorp-list_get" ] + "default" : [ "vamdatabridges_globaloutlook-regionallatest_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/Gorp/Latest" : { + "/GlobalOutlook/GlobalLatest" : { "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", + "tags" : [ "GlobalOutlook" ], + "summary" : "Return the latest global dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook.", + "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_globaloutlook-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" : "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", @@ -1340,17 +1447,17 @@ "content" : { "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/GorpValueWithChangesPagedResult" + "$ref" : "#/components/schemas/GlobalOutlookApiDto" } }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/GorpValueWithChangesPagedResult" + "$ref" : "#/components/schemas/GlobalOutlookApiDto" } }, "text/json" : { "schema" : { - "$ref" : "#/components/schemas/GorpValueWithChangesPagedResult" + "$ref" : "#/components/schemas/GlobalOutlookApiDto" } } } @@ -1377,267 +1484,51 @@ } }, "security" : [ { - "default" : [ "vamdatabridges_gorp-latest_get" ] + "default" : [ "vamdatabridges_globaloutlook-globallatest_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/Gorp/CountryLatest" : { + "/Household/Surveys" : { "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", + "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" : "env", + "name" : "adm0Code", "in" : "query", - "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "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", - "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" + "format" : "date-time" } }, { "name" : "endDate", @@ -2254,116 +2145,81 @@ "x-throttling-tier" : "Unlimited" } }, - "/MarketPrices/PriceMonthly" : { + "/HungerHotspot/CategoriesAndIndicators" : { "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", + "tags" : [ "HungerHotspot" ], + "summary" : "Retrieves Hunger Hotspot categories and 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_hungerhotspot-categoriesandindicators_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" : "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", + "name" : "env", "in" : "query", - "description" : "Price type: [retail|wholesale|farmgate]", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", - "default" : "" + "enum" : [ "prod", "dev" ] } - }, { - "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 + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/CategoriesAndIndicatorsDTO" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CategoriesAndIndicatorsDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/CategoriesAndIndicatorsDTO" + } + } + } + }, + "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_hungerhotspot-categoriesandindicators_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/HungerHotspot/Data" : { + "get" : { + "tags" : [ "HungerHotspot" ], + "summary" : "Retrieves a paginated list of Hunger Hotspot data.", + "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_hungerhotspot-data_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", + "description" : "The page number for pagination. Defaults to 1.", "required" : false, "style" : "form", "explode" : true, @@ -2372,17 +2228,6 @@ "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", @@ -2401,17 +2246,17 @@ "content" : { "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/ViewExtendedAggregatedPricePagedResult" + "$ref" : "#/components/schemas/HungerHotSpotDataDTOPagedResult" } }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ViewExtendedAggregatedPricePagedResult" + "$ref" : "#/components/schemas/HungerHotSpotDataDTOPagedResult" } }, "text/json" : { "schema" : { - "$ref" : "#/components/schemas/ViewExtendedAggregatedPricePagedResult" + "$ref" : "#/components/schemas/HungerHotSpotDataDTOPagedResult" } } } @@ -2438,21 +2283,21 @@ } }, "security" : [ { - "default" : [ "vamdatabridges_marketprices-pricemonthly_get" ] + "default" : [ "vamdatabridges_hungerhotspot-data_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/MarketPrices/PriceWeekly" : { + "/Ipcch/IPCCHAndEquivalentPeaks-WFPDashboard" : { "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", + "tags" : [ "Ipcch" ], + "summary" : "Retrieves a paginated list of IPCCH and Equivalent Peaks data for the WFP Dashboard.", + "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_ipcch-ipcchandequivalentpeakswfpdashboard_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", + "name" : "iso3", "in" : "query", - "description" : "The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code.", + "description" : "", "required" : false, "style" : "form", "explode" : true, @@ -2460,67 +2305,87 @@ "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", + "name" : "page", "in" : "query", - "description" : "The exact ID of a Commodity, as found in /Commodities/List", + "description" : "The page number for pagination. Defaults to 1.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", - "default" : 0 + "default" : 1 } }, { - "name" : "priceTypeName", + "name" : "env", "in" : "query", - "description" : "Price type: [retail|wholesale|farmgate]", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", "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 + "enum" : [ "prod", "dev" ] } - }, { - "name" : "priceFlag", - "in" : "query", - "description" : "Type of price data: [actual|aggregate|estimated|forecasted]", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string", - "default" : "" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/IpcchAndEquivalentPeaksDTOPagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/IpcchAndEquivalentPeaksDTOPagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/IpcchAndEquivalentPeaksDTOPagedResult" + } + } + } + }, + "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" + } + } + } } - }, { - "name" : "startDate", + }, + "security" : [ { + "default" : [ "vamdatabridges_ipcch-ipcchandequivalentpeakswfpdashboard_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Ipcch/IPCCH-HistoricalData" : { + "get" : { + "tags" : [ "Ipcch" ], + "summary" : "Retrieves a paginated list of IPCCH and Equivalent Historical Data.", + "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_ipcch-ipcch-historicaldata_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" : "fromDate", "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)", + "description" : "Date in the format yyyy-mm-dd, refers to the analysis date", "required" : false, "style" : "form", "explode" : true, @@ -2529,9 +2394,9 @@ "format" : "date-time" } }, { - "name" : "endDate", + "name" : "toDate", "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)", + "description" : "Date in the format yyyy-mm-dd, refers to the analysis date", "required" : false, "style" : "form", "explode" : true, @@ -2540,20 +2405,19 @@ "format" : "date-time" } }, { - "name" : "latestValueOnly", + "name" : "iso3", "in" : "query", - "description" : "[TRUE|FALSE]", + "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "boolean", - "default" : false + "type" : "string" } }, { "name" : "page", "in" : "query", - "description" : "Page number for paged results", + "description" : "", "required" : false, "style" : "form", "explode" : true, @@ -2562,17 +2426,6 @@ "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", @@ -2591,17 +2444,17 @@ "content" : { "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/PagedCommodityWeeklyAggregatedPriceListDTO" + "$ref" : "#/components/schemas/IpcHistoricalDatumDtoPagedResult" } }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedCommodityWeeklyAggregatedPriceListDTO" + "$ref" : "#/components/schemas/IpcHistoricalDatumDtoPagedResult" } }, "text/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedCommodityWeeklyAggregatedPriceListDTO" + "$ref" : "#/components/schemas/IpcHistoricalDatumDtoPagedResult" } } } @@ -2628,21 +2481,21 @@ } }, "security" : [ { - "default" : [ "vamdatabridges_marketprices-priceweekly_get" ] + "default" : [ "vamdatabridges_ipcch-ipcch-historicaldata_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/MarketPrices/PriceDaily" : { + "/Ipcch/IPCCHAndEquivalent-MostRecent" : { "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", + "tags" : [ "Ipcch" ], + "summary" : "Retrieves a paginated list of the most recent IPCCH and Equivalent data, optionally filtered by ISO3 country code.", + "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_ipcch-ipcchandequivalent-mostrecent_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", + "name" : "iso3", "in" : "query", - "description" : "The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code.", + "description" : "", "required" : false, "style" : "form", "explode" : true, @@ -2650,100 +2503,196 @@ "type" : "string" } }, { - "name" : "marketID", + "name" : "page", "in" : "query", - "description" : "Unique ID of a Market, as found in /Markets/GeoJSONList", + "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", - "default" : 0 + "default" : 1 } }, { - "name" : "commodityID", + "name" : "env", "in" : "query", - "description" : "The exact ID of a Commodity, as found in /Commodities/List", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "integer", - "format" : "int32", - "default" : 0 + "type" : "string", + "enum" : [ "prod", "dev" ] } - }, { - "name" : "priceTypeName", + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/IpcchBaseDtoPagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/IpcchBaseDtoPagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/IpcchBaseDtoPagedResult" + } + } + } + }, + "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_ipcch-ipcchandequivalent-mostrecent_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Ipcch/IPCCHAndEquivalent-LatestPeaks" : { + "get" : { + "tags" : [ "Ipcch" ], + "summary" : "Retrieves a paginated list of the latest IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code.", + "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_ipcch-ipcchandequivalent-latestpeaks_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" : "Price type: [retail|wholesale|farmgate]", + "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "string", - "default" : "" + "type" : "string" } }, { - "name" : "currencyID", + "name" : "page", "in" : "query", - "description" : "The exact ID of a currency, as found in /Currency/List", + "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", - "default" : 0 + "default" : 1 } }, { - "name" : "priceFlag", + "name" : "env", "in" : "query", - "description" : "Type of price data: [actual|aggregate|estimated|forecasted]", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", - "default" : "" + "enum" : [ "prod", "dev" ] } - }, { - "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" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/IpcchPeaksDtoPagedResult" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/IpcchPeaksDtoPagedResult" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/IpcchPeaksDtoPagedResult" + } + } + } + }, + "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" + } + } + } } - }, { - "name" : "endDate", + }, + "security" : [ { + "default" : [ "vamdatabridges_ipcch-ipcchandequivalent-latestpeaks_get" ] + } ], + "x-auth-type" : "Application & Application User", + "x-throttling-tier" : "Unlimited" + } + }, + "/Ipcch/IPCCHAndEquivalent-HistoricalPeaks" : { + "get" : { + "tags" : [ "Ipcch" ], + "summary" : "Retrieves a paginated list of historical IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code.", + "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_ipcch-ipcchandequivalent-historicalpeaks_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" : "referenceYear", "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)", + "description" : "Year in a 4 digit format, for example: 2025", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "string", - "format" : "date-time" + "type" : "integer", + "format" : "int32" } }, { - "name" : "latestValueOnly", + "name" : "iso3", "in" : "query", - "description" : "[TRUE|FALSE]", + "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "boolean", - "default" : false + "type" : "string" } }, { "name" : "page", "in" : "query", - "description" : "Page number for paged results", + "description" : "", "required" : false, "style" : "form", "explode" : true, @@ -2752,17 +2701,6 @@ "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", @@ -2781,17 +2719,17 @@ "content" : { "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/ViewExtendedAggregatedPricePagedResult" + "$ref" : "#/components/schemas/IpcchPeaksDtoPagedResult" } }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ViewExtendedAggregatedPricePagedResult" + "$ref" : "#/components/schemas/IpcchPeaksDtoPagedResult" } }, "text/json" : { "schema" : { - "$ref" : "#/components/schemas/ViewExtendedAggregatedPricePagedResult" + "$ref" : "#/components/schemas/IpcchPeaksDtoPagedResult" } } } @@ -2818,17 +2756,17 @@ } }, "security" : [ { - "default" : [ "vamdatabridges_marketprices-pricedaily_get" ] + "default" : [ "vamdatabridges_ipcch-ipcchandequivalent-historicalpeaks_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/MarketPrices/PriceRaw" : { + "/MarketPrices/PriceMonthly" : { "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", + "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", @@ -2971,17 +2909,17 @@ "content" : { "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/PagedCommodityPriceListDTO" + "$ref" : "#/components/schemas/ViewExtendedMonthlyAggregatedPricePagedResult" } }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedCommodityPriceListDTO" + "$ref" : "#/components/schemas/ViewExtendedMonthlyAggregatedPricePagedResult" } }, "text/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedCommodityPriceListDTO" + "$ref" : "#/components/schemas/ViewExtendedMonthlyAggregatedPricePagedResult" } } } @@ -3008,17 +2946,17 @@ } }, "security" : [ { - "default" : [ "vamdatabridges_marketprices-priceraw_get" ] + "default" : [ "vamdatabridges_marketprices-pricemonthly_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/MarketPrices/Alps" : { + "/MarketPrices/PriceWeekly" : { "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", + "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", @@ -3161,17 +3099,17 @@ "content" : { "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/ViewExtendedAlpsValuePagedResult" + "$ref" : "#/components/schemas/PagedCommodityWeeklyAggregatedPriceListDTO" } }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ViewExtendedAlpsValuePagedResult" + "$ref" : "#/components/schemas/PagedCommodityWeeklyAggregatedPriceListDTO" } }, "text/json" : { "schema" : { - "$ref" : "#/components/schemas/ViewExtendedAlpsValuePagedResult" + "$ref" : "#/components/schemas/PagedCommodityWeeklyAggregatedPriceListDTO" } } } @@ -3198,241 +3136,122 @@ } }, "security" : [ { - "default" : [ "vamdatabridges_marketprices-alps_get" ] + "default" : [ "vamdatabridges_marketprices-priceweekly_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/Markets/GeoJSONList" : { + "/MarketPrices/PriceDaily" : { "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", + "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" : "adm0code", + "name" : "countryCode", "in" : "query", - "description" : "The admin code of the country", + "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" : "integer", - "format" : "int32" + "type" : "string" } }, { - "name" : "env", + "name" : "marketID", "in" : "query", - "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "description" : "Unique ID of a Market, as found in /Markets/GeoJSONList", "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" - } - } - } + "type" : "integer", + "format" : "int32", + "default" : 0 } - }, - "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", + }, { + "name" : "commodityID", "in" : "query", - "description" : "code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "description" : "The exact ID of a Commodity, as found in /Commodities/List", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", - "format" : "int32" + "format" : "int32", + "default" : 0 } }, { - "name" : "lat", + "name" : "priceTypeName", "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", + "description" : "Price type: [retail|wholesale|farmgate]", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "number", - "format" : "double" + "type" : "string", + "default" : "" } }, { - "name" : "lng", + "name" : "currencyID", "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", + "description" : "The exact ID of a currency, as found in /Currency/List", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "number", - "format" : "double" + "type" : "integer", + "format" : "int32", + "default" : 0 } }, { - "name" : "env", + "name" : "priceFlag", "in" : "query", - "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "description" : "Type of price data: [actual|aggregate|estimated|forecasted]", "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" + "default" : "" } }, { - "name" : "localNames", + "name" : "startDate", "in" : "query", - "description" : "If true the name of markets and regions will be localized if available", + "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" : "boolean", - "default" : false + "type" : "string", + "format" : "date-time" } }, { - "name" : "env", + "name" : "endDate", "in" : "query", - "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "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", - "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" - } - } - } + "format" : "date-time" } - }, - "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", + }, { + "name" : "latestValueOnly", "in" : "query", - "description" : "The code to identify the country. It can be a ISO-3166 Alpha 3 code or the VAM internal admin0code", + "description" : "[TRUE|FALSE]", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "string" + "type" : "boolean", + "default" : false } }, { "name" : "page", "in" : "query", - "description" : "page number for paged results", + "description" : "Page number for paged results", "required" : false, "style" : "form", "explode" : true, @@ -3470,75 +3289,17 @@ "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" + "$ref" : "#/components/schemas/ViewExtendedMonthlyAggregatedPricePagedResult" } }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/RpmeVariablePagedResult" + "$ref" : "#/components/schemas/ViewExtendedMonthlyAggregatedPricePagedResult" } }, "text/json" : { "schema" : { - "$ref" : "#/components/schemas/RpmeVariablePagedResult" + "$ref" : "#/components/schemas/ViewExtendedMonthlyAggregatedPricePagedResult" } } } @@ -3565,77 +3326,78 @@ } }, "security" : [ { - "default" : [ "vamdatabridges_rpme-variables_get" ] + "default" : [ "vamdatabridges_marketprices-pricedaily_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/Rpme/OutputValues" : { + "/MarketPrices/PriceRaw" : { "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", + "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" : "page", + "name" : "countryCode", "in" : "query", - "description" : "page number for paged results", + "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" : "integer", - "format" : "int32", - "default" : 1 + "type" : "string" } }, { - "name" : "adm0Code", + "name" : "marketID", "in" : "query", - "description" : "Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "description" : "Unique ID of a Market, as found in /Markets/GeoJSONList", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", - "format" : "int32" + "format" : "int32", + "default" : 0 } }, { - "name" : "surveyId", + "name" : "commodityID", "in" : "query", - "description" : "The ID of the survey", + "description" : "The exact ID of a Commodity, as found in /Commodities/List", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", - "format" : "int32" + "format" : "int32", + "default" : 0 } }, { - "name" : "shopId", + "name" : "priceTypeName", "in" : "query", - "description" : "The ID of the shop", + "description" : "Price type: [retail|wholesale|farmgate]", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "integer", - "format" : "int32" + "type" : "string", + "default" : "" } }, { - "name" : "marketId", + "name" : "currencyID", "in" : "query", - "description" : "The ID of the market", + "description" : "The exact ID of a currency, as found in /Currency/List", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", - "format" : "int32" + "format" : "int32", + "default" : 0 } }, { - "name" : "adm0CodeDots", + "name" : "priceFlag", "in" : "query", - "description" : "", + "description" : "Type of price data: [actual|aggregate|estimated|forecasted]", "required" : false, "style" : "form", "explode" : true, @@ -3644,116 +3406,60 @@ "default" : "" } }, { - "name" : "env", + "name" : "startDate", "in" : "query", - "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "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", - "enum" : [ "prod", "dev" ] + "format" : "date-time" } - } ], - "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", + }, { + "name" : "endDate", "in" : "query", - "description" : "code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "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" : "integer", - "format" : "int32", - "default" : 0 + "type" : "string", + "format" : "date-time" } }, { - "name" : "page", + "name" : "latestValueOnly", "in" : "query", - "description" : "page number for paged results", + "description" : "[TRUE|FALSE]", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "integer", - "format" : "int32", - "default" : 1 + "type" : "boolean", + "default" : false } }, { - "name" : "startDate", + "name" : "page", "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)", + "description" : "Page number for paged results", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "string", - "format" : "date-time" + "type" : "integer", + "format" : "int32", + "default" : 1 } }, { - "name" : "endDate", + "name" : "format", "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)", + "description" : "Output format: [JSON|CSV] Json is the default value", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", - "format" : "date-time" + "default" : "json" } }, { "name" : "env", @@ -3773,17 +3479,17 @@ "content" : { "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/PagedSurveyListDTO" + "$ref" : "#/components/schemas/PagedCommodityPriceListDTO" } }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedSurveyListDTO" + "$ref" : "#/components/schemas/PagedCommodityPriceListDTO" } }, "text/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedSurveyListDTO" + "$ref" : "#/components/schemas/PagedCommodityPriceListDTO" } } } @@ -3810,21 +3516,31 @@ } }, "security" : [ { - "default" : [ "vamdatabridges_rpme-surveys_get" ] + "default" : [ "vamdatabridges_marketprices-priceraw_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/Rpme/XLSForms" : { + "/MarketPrices/Alps" : { "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", + "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" : "adm0Code", + "name" : "countryCode", "in" : "query", - "description" : "code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "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, @@ -3834,111 +3550,88 @@ "default" : 0 } }, { - "name" : "page", + "name" : "commodityID", "in" : "query", - "description" : "page number for paged results", + "description" : "The exact ID of a Commodity, as found in /Commodities/List", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", - "default" : 1 + "default" : 0 } }, { - "name" : "startDate", + "name" : "priceTypeName", "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)", + "description" : "Price type: [retail|wholesale|farmgate]", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", - "format" : "date-time" + "default" : "" } }, { - "name" : "endDate", + "name" : "currencyID", "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)", + "description" : "The exact ID of a currency, as found in /Currency/List", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "string", - "format" : "date-time" + "type" : "integer", + "format" : "int32", + "default" : 0 } }, { - "name" : "env", + "name" : "priceFlag", "in" : "query", - "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", + "description" : "Type of price data: [actual|aggregate|estimated|forecasted]", "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" - } - } - } + "default" : "" } - }, - "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", + }, { + "name" : "startDate", "in" : "query", - "description" : "unique identifier for the collected data, as retrieved from /Surveys API.", + "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" : "integer", - "format" : "int32" + "type" : "string", + "format" : "date-time" } }, { - "name" : "format", + "name" : "endDate", "in" : "query", - "description" : "Output format: [JSON|CSV] Json is the default value", + "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", - "default" : "json" + "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", + "description" : "Page number for paged results", "required" : false, "style" : "form", "explode" : true, @@ -3948,16 +3641,15 @@ "default" : 1 } }, { - "name" : "pageSize", + "name" : "format", "in" : "query", - "description" : "page size for paged results, default value is 20.", + "description" : "Output format: [JSON|CSV] Json is the default value", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "integer", - "format" : "int32", - "default" : 20 + "type" : "string", + "default" : "json" } }, { "name" : "env", @@ -3977,17 +3669,17 @@ "content" : { "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + "$ref" : "#/components/schemas/ExtendedAlpsValueDtoPagedResult" } }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + "$ref" : "#/components/schemas/ExtendedAlpsValueDtoPagedResult" } }, "text/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + "$ref" : "#/components/schemas/ExtendedAlpsValueDtoPagedResult" } } } @@ -4011,44 +3703,24 @@ } } } - }, - "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" ] + "default" : [ "vamdatabridges_marketprices-alps_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/Rpme/BaseData" : { + "/Markets/GeoJSONList" : { "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", + "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" : "surveyID", + "name" : "adm0code", "in" : "query", - "description" : "unique identifier for the collected data, as retrieved from /Surveys API.", + "description" : "The admin code of the country", "required" : false, "style" : "form", "explode" : true, @@ -4057,33 +3729,9 @@ "format" : "int32" } }, { - "name" : "page", + "name" : "env", "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", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", "required" : false, "style" : "form", "explode" : true, @@ -4096,19 +3744,9 @@ "200" : { "description" : "OK", "content" : { - "text/plain" : { - "schema" : { - "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" - } - }, - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" - } - }, - "text/json" : { + "application/geo+json" : { "schema" : { - "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + "$ref" : "#/components/schemas/MarketGeoJsonRoot" } } } @@ -4116,58 +3754,28 @@ "400" : { "description" : "Bad Request", "content" : { - "text/plain" : { - "schema" : { - "$ref" : "#/components/schemas/BadRequestDTO" - } - }, - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/BadRequestDTO" - } - }, - "text/json" : { + "application/geo+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" ] + "default" : [ "vamdatabridges_markets-geojsonlist_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/MFI/Surveys" : { + "/Markets/NearbyMarkets" : { "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", + "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", + "name" : "adm0code", "in" : "query", "description" : "code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", "required" : false, @@ -4175,42 +3783,29 @@ "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 + "format" : "int32" } }, { - "name" : "startDate", + "name" : "lat", "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)", + "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" : "string", - "format" : "date-time" + "type" : "number", + "format" : "double" } }, { - "name" : "endDate", + "name" : "lng", "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)", + "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" : "string", - "format" : "date-time" + "type" : "number", + "format" : "double" } }, { "name" : "env", @@ -4230,7 +3825,10 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedSurveyListDTO" + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NearbyMarketsDTO" + } } } } @@ -4247,21 +3845,21 @@ } }, "security" : [ { - "default" : [ "vamdatabridges_mfi-surveys_get" ] + "default" : [ "vamdatabridges_markets-nearbymarkets_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/MFI/Surveys/ProcessedData" : { + "/Markets/MarketsAsCSV" : { "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", + "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" : "surveyID", + "name" : "adm0code", "in" : "query", - "description" : "The ID of the survey", + "description" : "The admin code of the country", "required" : false, "style" : "form", "explode" : true, @@ -4270,65 +3868,69 @@ "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", + "name" : "localNames", "in" : "query", - "description" : "Output format: [JSON|CSV] Json is the default value", + "description" : "If true the name of markets and regions will be localized if available", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "string", - "default" : "json" + "type" : "boolean", + "default" : false } }, { - "name" : "startDate", + "name" : "env", "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)", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", - "format" : "date-time" + "enum" : [ "prod", "dev" ] } - }, { - "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" + } ], + "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" + } + } + } } - }, { - "name" : "adm0Codes", + }, + "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" : "Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "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, @@ -4336,25 +3938,27 @@ "type" : "string" } }, { - "name" : "marketID", + "name" : "page", "in" : "query", - "description" : "The ID of the market", + "description" : "page number for paged results", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", - "format" : "int32" + "format" : "int32", + "default" : 1 } }, { - "name" : "surveyType", + "name" : "format", "in" : "query", - "description" : "The survey type", + "description" : "Output format: [JSON|CSV] Json is the default value", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "string" + "type" : "string", + "default" : "json" } }, { "name" : "env", @@ -4374,122 +3978,159 @@ "content" : { "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/PagedProcessedDataDTO" + "$ref" : "#/components/schemas/PagedMarketListDTO" } }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedProcessedDataDTO" + "$ref" : "#/components/schemas/PagedMarketListDTO" } }, "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" + "$ref" : "#/components/schemas/PagedMarketListDTO" } } } } }, "security" : [ { - "default" : [ "vamdatabridges_mfi-surveys-processeddata_get" ] + "default" : [ "vamdatabridges_markets-list_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/MFI/Surveys/ProcessedDataWithKeysetPagination" : { + "/Rpme/Variables" : { "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", + "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" : "surveyID", + "name" : "page", "in" : "query", - "description" : "The ID of the survey", + "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", - "format" : "int32" + "format" : "int32", + "default" : 1 } }, { - "name" : "scrollId", + "name" : "env", "in" : "query", - "description" : "The pointer to the next paged results", + "description" : "Environment.\n * `prod` - api.vam.wfp.org\n * `dev` - dev.api.vam.wfp.org", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "integer", - "format" : "int32", - "default" : 0 + "type" : "string", + "enum" : [ "prod", "dev" ] } - }, { - "name" : "pageSize", + } ], + "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" : 1000 + "default" : 1 } }, { - "name" : "startDate", + "name" : "adm0Code", "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)", + "description" : "Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "string", - "format" : "date-time" + "type" : "integer", + "format" : "int32" } }, { - "name" : "endDate", + "name" : "surveyId", "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)", + "description" : "The ID of the survey", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "string", - "format" : "date-time" + "type" : "integer", + "format" : "int32" } }, { - "name" : "adm0Codes", + "name" : "shopId", "in" : "query", - "description" : "Code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "description" : "The ID of the shop", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "string" + "type" : "integer", + "format" : "int32" } }, { - "name" : "marketID", + "name" : "marketId", "in" : "query", "description" : "The ID of the market", "required" : false, @@ -4500,14 +4141,15 @@ "format" : "int32" } }, { - "name" : "surveyType", + "name" : "adm0CodeDots", "in" : "query", - "description" : "The survey type", + "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "string" + "type" : "string", + "default" : "" } }, { "name" : "env", @@ -4527,17 +4169,17 @@ "content" : { "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/PagedProcessedDataDTO" + "$ref" : "#/components/schemas/RpmeAssessmentPagedResult" } }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedProcessedDataDTO" + "$ref" : "#/components/schemas/RpmeAssessmentPagedResult" } }, "text/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedProcessedDataDTO" + "$ref" : "#/components/schemas/RpmeAssessmentPagedResult" } } } @@ -4564,62 +4206,62 @@ } }, "security" : [ { - "default" : [ "vamdatabridges_mfi-surveys-processeddatakeysetpagination_get" ] + "default" : [ "vamdatabridges_rpme-outputvalues_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/MFI/Surveys/FullData" : { + "/Rpme/Surveys" : { "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", + "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" : "surveyID", + "name" : "adm0Code", "in" : "query", - "description" : "unique identifier for the collected data, as retrieved from /Surveys API.", + "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" + "format" : "int32", + "default" : 0 } }, { - "name" : "format", + "name" : "page", "in" : "query", - "description" : "Output format: [JSON|CSV] Json is the default value", + "description" : "page number for paged results", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "string", - "default" : "json" + "type" : "integer", + "format" : "int32", + "default" : 1 } }, { - "name" : "page", + "name" : "startDate", "in" : "query", - "description" : "page number for paged results", + "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" : "integer", - "format" : "int32", - "default" : 1 + "type" : "string", + "format" : "date-time" } }, { - "name" : "pageSize", + "name" : "endDate", "in" : "query", - "description" : "page size for paged results, default value is 20.", + "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" : "integer", - "format" : "int32", - "default" : 20 + "type" : "string", + "format" : "date-time" } }, { "name" : "env", @@ -4639,17 +4281,17 @@ "content" : { "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + "$ref" : "#/components/schemas/PagedSurveyListDTO" } }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + "$ref" : "#/components/schemas/PagedSurveyListDTO" } }, "text/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + "$ref" : "#/components/schemas/PagedSurveyListDTO" } } } @@ -4673,50 +4315,31 @@ } } } - }, - "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" ] + "default" : [ "vamdatabridges_rpme-surveys_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/MFI/Surveys/BaseData" : { + "/Rpme/XLSForms" : { "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", + "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" : "surveyID", + "name" : "adm0Code", "in" : "query", - "description" : "unique identifier for the collected data, as retrieved from /Surveys API.", + "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" + "format" : "int32", + "default" : 0 } }, { "name" : "page", @@ -4731,16 +4354,26 @@ "default" : 1 } }, { - "name" : "pageSize", + "name" : "startDate", "in" : "query", - "description" : "page size for paged results, default value is 20.", + "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" : "integer", - "format" : "int32", - "default" : 20 + "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", @@ -4758,19 +4391,9 @@ "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" + "$ref" : "#/components/schemas/PagedXlsFormListDTO" } } } @@ -4778,17 +4401,119 @@ "400" : { "description" : "Bad Request", "content" : { - "text/plain" : { - "schema" : { - "$ref" : "#/components/schemas/BadRequestDTO" - } - }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/BadRequestDTO" } - }, - "text/json" : { + } + } + } + }, + "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" } @@ -4817,28 +4542,27 @@ } }, "security" : [ { - "default" : [ "vamdatabridges_mfi-surveys-basedata_get" ] + "default" : [ "vamdatabridges_rpme-fulldata_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/MFI/XlsForms" : { + "/Rpme/BaseData" : { "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", + "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" : "adm0Code", + "name" : "surveyID", "in" : "query", - "description" : "code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion", + "description" : "unique identifier for the collected data, as retrieved from /Surveys API.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", - "format" : "int32", - "default" : 0 + "format" : "int32" } }, { "name" : "page", @@ -4853,26 +4577,16 @@ "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", + "name" : "pageSize", "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)", + "description" : "page size for paged results, default value is 20.", "required" : false, "style" : "form", "explode" : true, "schema" : { - "type" : "string", - "format" : "date-time" + "type" : "integer", + "format" : "int32", + "default" : 20 } }, { "name" : "env", @@ -4890,9 +4604,19 @@ "200" : { "description" : "OK", "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, "application/json" : { "schema" : { - "$ref" : "#/components/schemas/PagedXlsFormListDTO" + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" + } + }, + "text/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedSurveyResponsesDTO" } } } @@ -4900,36 +4624,101 @@ "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-xlsforms_get" ] + "default" : [ "vamdatabridges_rpme-basedata_get" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, - "/XlsForms/definition" : { + "/MFI/Surveys" : { "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", + "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" : "xlsFormId", + "name" : "adm0Code", "in" : "query", - "description" : "unique identifier for the XLS Form, as retrieved from /XLSForms", + "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" + "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", @@ -4949,10 +4738,7 @@ "content" : { "application/json" : { "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/XlsFormDefinitionNewSchemaDTO" - } + "$ref" : "#/components/schemas/PagedSurveyListDTO" } } } @@ -4969,315 +4755,1932 @@ } }, "security" : [ { - "default" : [ "vamdatabridges_xlsforms-definition_get" ] + "default" : [ "vamdatabridges_mfi-surveys_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", + }, + "/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" : "" + }, + "CariAdm0ValuesDTO" : { + "type" : "object", + "properties" : { + "surveyID" : { + "type" : "integer", + "format" : "int32" + }, + "surveyName" : { + "type" : "string", + "nullable" : true + }, + "cariMethodologyName" : { + "type" : "string", + "nullable" : true + }, + "fcsMethodologyName" : { + "type" : "string", + "nullable" : true + }, + "additionalSurveyMetadata" : { + "type" : "string", + "nullable" : true + }, + "adm0Code" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "adm0Name" : { + "type" : "string", + "nullable" : true + }, + "cariIndicatorID" : { + "type" : "integer", + "format" : "int32" + }, + "cariIndicatorName" : { + "type" : "string", + "nullable" : true + }, + "cariIndicatorCategoryID" : { + "type" : "integer", + "format" : "int32" + }, + "indicatorCategoryLabel" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "CariAdm0ValuesDTOPagedResult" : { + "type" : "object", + "properties" : { + "items" : { + "type" : "array", + "nullable" : true, + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/CariAdm0ValuesDTO" + } + }, + "page" : { + "type" : "integer", + "format" : "int32" + }, + "totalItems" : { + "type" : "integer", + "format" : "int32" + } + }, + "additionalProperties" : { } + }, + "CariAdm1ValuesDTO" : { + "type" : "object", + "properties" : { + "surveyID" : { + "type" : "integer", + "format" : "int32" + }, + "surveyName" : { + "type" : "string", + "nullable" : true + }, + "cariMethodologyName" : { + "type" : "string", + "nullable" : true + }, + "fcsMethodologyName" : { + "type" : "string", + "nullable" : true + }, + "additionalSurveyMetadata" : { + "type" : "string", + "nullable" : true + }, + "adm0Code" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "adm0Name" : { + "type" : "string", + "nullable" : true + }, + "cariIndicatorID" : { + "type" : "integer", + "format" : "int32" + }, + "cariIndicatorName" : { + "type" : "string", + "nullable" : true + }, + "cariIndicatorCategoryID" : { + "type" : "integer", + "format" : "int32" + }, + "indicatorCategoryLabel" : { + "type" : "string", + "nullable" : true + }, + "adm1Code" : { + "type" : "integer", + "format" : "int32", + "nullable" : true + }, + "adm1Name" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "CariAdm1ValuesDTOPagedResult" : { + "type" : "object", + "properties" : { + "items" : { + "type" : "array", + "nullable" : true, + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/CariAdm1ValuesDTO" + } + }, + "page" : { + "type" : "integer", + "format" : "int32" + }, + "totalItems" : { + "type" : "integer", + "format" : "int32" + } + }, + "additionalProperties" : { } + }, + "CategoriesAndIndicatorsDTO" : { + "type" : "object", + "properties" : { + "categories" : { + "type" : "array", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/ListItemDto" + } + }, + "indicators" : { + "type" : "array", + "nullable" : true, + "items" : { + "$ref" : "#/components/schemas/ListItemDto" + } + } + }, + "additionalProperties" : { } + }, + "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" : { } + }, + "ExtendedAlpsValueDto" : { + "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" : { } + }, + "ExtendedAlpsValueDtoPagedResult" : { + "type" : "object", + "properties" : { + "items" : { + "type" : "array", + "nullable" : true, + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/ExtendedAlpsValueDto" + } + }, + "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" : { }, - "description" : "" + "additionalProperties" : { } }, - "CommodityDTO" : { + "GlobalOutlookApiDto" : { "type" : "object", "properties" : { - "id" : { - "type" : "integer", - "description" : "The internal ID of the commodity", - "format" : "int32" + "date" : { + "type" : "string", + "nullable" : true }, - "parentId" : { + "regionName" : { + "type" : "string", + "nullable" : true + }, + "totalValue" : { + "type" : "number", + "format" : "double" + }, + "numberOfCountries" : { "type" : "integer", - "description" : "The internal parent ID of the commodity", "format" : "int32", "nullable" : true }, - "name" : { + "comment" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "GlobalOutlookCountryApiDto" : { + "type" : "object", + "properties" : { + "date" : { "type" : "string", - "description" : "The name of the commodity", "nullable" : true }, - "coicop2018" : { + "countryOfficeIso3" : { "type" : "string", - "description" : "The COICOP 2018 definition", "nullable" : true }, - "supply" : { + "totalValue" : { + "type" : "number", + "format" : "double" + }, + "comment" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, + "GlobalOutlookRegionalApiDto" : { + "type" : "object", + "properties" : { + "date" : { + "type" : "string", + "nullable" : true + }, + "regionName" : { + "type" : "string", + "nullable" : true + }, + "totalValue" : { + "type" : "number", + "format" : "double" + }, + "numberOfCountries" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "categoryId" : { + "comment" : { + "type" : "string", + "nullable" : true + } + }, + "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" }, - "createDate" : { + "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" : { } + }, + "HungerHotSpotDataDTO" : { + "type" : "object", + "properties" : { + "iso3Code" : { "type" : "string", - "format" : "date-time" + "nullable" : true }, - "updateDate" : { + "hungerHotspotsDate" : { "type" : "string", - "format" : "date-time", - "nullable" : true + "format" : "date-time" }, - "qualities" : { - "type" : "array", - "nullable" : true, - "items" : { - "$ref" : "#/components/schemas/CommodityQualityDTO" - } + "category" : { + "$ref" : "#/components/schemas/ListItemDto" }, - "processing" : { + "indicators" : { "type" : "array", "nullable" : true, "items" : { - "$ref" : "#/components/schemas/CommodityProcessingDTO" + "$ref" : "#/components/schemas/ListItemDto" } } }, "additionalProperties" : { } }, - "CommodityPriceDTO" : { + "HungerHotSpotDataDTOPagedResult" : { "type" : "object", "properties" : { - "id" : { - "type" : "integer", - "description" : "The internal ID of the commodity", - "format" : "int32" - }, - "commodityId" : { - "type" : "integer", - "format" : "int32" + "items" : { + "type" : "array", + "nullable" : true, + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/HungerHotSpotDataDTO" + } }, - "marketId" : { + "page" : { "type" : "integer", "format" : "int32" }, - "priceTypeId" : { + "totalItems" : { "type" : "integer", "format" : "int32" - }, - "commodityUnitId" : { + } + }, + "additionalProperties" : { } + }, + "IpcHistoricalDatumDto" : { + "type" : "object", + "properties" : { + "analysisId" : { "type" : "integer", "format" : "int32" }, - "currencyId" : { - "type" : "integer", - "format" : "int32" + "analysisTitle" : { + "type" : "string", + "nullable" : true }, - "commodityName" : { + "iso3Alpha3" : { "type" : "string", "nullable" : true }, - "marketName" : { + "countryName" : { "type" : "string", "nullable" : true }, - "priceTypeName" : { + "analysisDate" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "unitName" : { + "StartDate_CurrentPeriod" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "currencyName" : { + "EndDate_CurrentPeriod" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "originalFrequency" : { + "StartDate_ProjectedPeriod" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "adm0Code" : { - "type" : "integer", - "format" : "int32" + "EndDate_ProjectedPeriod" : { + "type" : "string", + "format" : "date-time", + "nullable" : true }, - "countryISO3" : { + "StartDate_SecondProjectedPeriod" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "countryName" : { + "EndDate_SecondProjectedPeriod" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "commodityPrice" : { + "population" : { "type" : "number", - "format" : "double" + "format" : "double", + "nullable" : true }, - "commodityPriceSourceName" : { - "type" : "string", + "populationPercentage" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "commodityPriceMetadata" : { + "phase3PlusPopulation" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "commodityPriceDate" : { - "type" : "string", - "format" : "date-time" + "phase3PlusPercentage" : { + "type" : "number", + "format" : "double", + "nullable" : true }, - "commodityPriceObservations" : { - "type" : "integer", - "format" : "int32", + "estimatedPopulation" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "commodityPriceDateDay" : { - "type" : "integer", - "format" : "int32", + "phase1Population" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "commodityPriceDateWeek" : { - "type" : "integer", - "format" : "int32", + "phase1Percentage" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "commodityPriceDateMonth" : { - "type" : "integer", - "format" : "int32", + "phase2Population" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "commodityPriceDateYear" : { - "type" : "integer", - "format" : "int32" + "phase2Percentage" : { + "type" : "number", + "format" : "double", + "nullable" : true }, - "commodityPriceInsertDate" : { - "type" : "string", - "format" : "date-time", + "phase3Population" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "commodityPriceFlag" : { - "type" : "string", + "phase3Percentage" : { + "type" : "number", + "format" : "double", "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", + "phase4Population" : { + "type" : "number", + "format" : "double", "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", + "phase4Percentage" : { + "type" : "number", + "format" : "double", "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", + "phase5Population" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "extendedName" : { - "type" : "string", + "phase5Percentage" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "createDate" : { - "type" : "string", - "format" : "date-time" + "phase3PlusPopulationProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true }, - "updateDate" : { - "type" : "string", - "format" : "date-time", + "phase3PlusPercentageProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "estimatedPopulationProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase1PopulationProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase1PercentageProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase2PopulationProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase2PercentageProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase3PopulationProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase3PercentageProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase4PopulationProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase4PercentageProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase5PopulationProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase5PercentageProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase3PlusPopulationSecondProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase3PlusPercentageSecondProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "estimatedPopulationSecondProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase1PopulationSecondProjected" : { + "type" : "number", + "format" : "double", "nullable" : true - } - }, - "additionalProperties" : { } - }, - "EconomicDataDTO" : { - "type" : "object", - "properties" : { - "date" : { - "type" : "string", - "format" : "date-time" }, - "value" : { + "phase1PercentageSecondProjected" : { "type" : "number", - "format" : "double" - } - }, - "additionalProperties" : { } - }, - "EconomicIndicatorProperty" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "integer", - "format" : "int32" + "format" : "double", + "nullable" : true }, - "name" : { - "type" : "string", + "phase2PopulationSecondProjected" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "frequency" : { - "type" : "string", + "phase2PercentageSecondProjected" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "unit" : { - "type" : "string", + "phase3PopulationSecondProjected" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "dataSource" : { - "type" : "string", + "phase3PercentageSecondProjected" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "countryIso3" : { - "type" : "string", + "phase4PopulationSecondProjected" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "latestValue" : { + "phase4PercentageSecondProjected" : { "type" : "number", - "format" : "double" + "format" : "double", + "nullable" : true }, - "latestValueDate" : { - "type" : "string", - "format" : "date-time" + "phase5PopulationSecondProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase5PercentageSecondProjected" : { + "type" : "number", + "format" : "double", + "nullable" : true } }, "additionalProperties" : { } }, - "EconomicIndicatorPropertyPagedResult" : { + "IpcHistoricalDatumDtoPagedResult" : { "type" : "object", "properties" : { "items" : { @@ -5285,7 +6688,7 @@ "nullable" : true, "readOnly" : true, "items" : { - "$ref" : "#/components/schemas/EconomicIndicatorProperty" + "$ref" : "#/components/schemas/IpcHistoricalDatumDto" } }, "page" : { @@ -5299,171 +6702,50 @@ }, "additionalProperties" : { } }, - "Feature" : { + "IpcchAndEquivalentPeaksDTO" : { "type" : "object", "properties" : { - "type" : { - "type" : "string", - "nullable" : true - }, - "id" : { + "regionalBureauID" : { "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", + "format" : "int32", "nullable" : true }, - "countryOfficeIso3" : { + "regionalBureauName" : { "type" : "string", "nullable" : true }, - "gorpTotalValue" : { - "type" : "number", - "format" : "double" - }, - "gorpComment" : { - "type" : "string", - "nullable" : true - } - }, - "additionalProperties" : { } - }, - "GorpGlobalApiDto" : { - "type" : "object", - "properties" : { - "gorpDate" : { + "iso3Alpha3" : { "type" : "string", "nullable" : true }, - "gorpRegionName" : { + "countryName" : { "type" : "string", "nullable" : true }, - "gorpTotalValue" : { - "type" : "number", - "format" : "double" - }, - "numberOfCountries" : { + "phase3Population" : { "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" : { + "phase4Population" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "gorpComment" : { - "type" : "string", - "nullable" : true - } - }, - "additionalProperties" : { } - }, - "GorpValueWithChanges" : { - "type" : "object", - "properties" : { - "year" : { + "phase5Population" : { "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", + "format" : "int32", "nullable" : true }, - "numberOfCountries" : { + "phase3PlusPopulation" : { "type" : "integer", - "format" : "int32" + "format" : "int32", + "nullable" : true } }, "additionalProperties" : { } }, - "GorpValueWithChangesPagedResult" : { + "IpcchAndEquivalentPeaksDTOPagedResult" : { "type" : "object", "properties" : { "items" : { @@ -5471,7 +6753,7 @@ "nullable" : true, "readOnly" : true, "items" : { - "$ref" : "#/components/schemas/GorpValueWithChanges" + "$ref" : "#/components/schemas/IpcchAndEquivalentPeaksDTO" } }, "page" : { @@ -5485,145 +6767,121 @@ }, "additionalProperties" : { } }, - "HouseholdSurveyListDTO" : { + "IpcchBaseDto" : { "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" : { + "iso3Alpha3" : { "type" : "string", - "description" : "The date when the survey has started", - "format" : "date-time", "nullable" : true }, - "surveyEndDate" : { + "countryName" : { "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" + "populationGroupId" : { + "type" : "integer", + "format" : "int32" }, - "surveyValidationReport" : { + "populationGroupName" : { "type" : "string", - "description" : "The detailed report on the validation performed on the survey schema", "nullable" : true }, - "surveyOriginalFilename" : { - "maxLength" : 256, - "minLength" : 0, + "analysisTitle" : { "type" : "string", - "description" : "The filename of the survey CSV file", "nullable" : true }, - "xlsFormName" : { + "analysisDate" : { "type" : "string", - "description" : "The name of the XLSForm used to collect data", + "format" : "date-time", "nullable" : true }, - "baseXlsFormName" : { + "periodStart" : { "type" : "string", - "description" : "The name of the base XLSForm used to build the XLSForm", + "format" : "date-time", "nullable" : true }, - "countryName" : { + "periodEnd" : { "type" : "string", - "description" : "The name of the country where the survey has taken place", + "format" : "date-time", "nullable" : true }, - "adm0Code" : { - "type" : "integer", - "description" : "The internal code of the country where the survey has taken place", - "format" : "int32" - }, - "iso3Alpha3" : { + "periodType" : { "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", + "population" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "approvedBy" : { - "type" : "string", + "populationAnalysed" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "originalCsvFile" : { - "type" : "string", - "description" : "The link to download the original CSV file", + "populationAnalysedPercentage" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "baseData" : { - "type" : "string", - "description" : "The link to the JSON data reshaped on the base XLSForm", + "phase3Population" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "surveyAttributes" : { - "type" : "array", - "nullable" : true, - "items" : { - "$ref" : "#/components/schemas/KeyNameDto" - } - }, - "organizations" : { - "type" : "array", - "nullable" : true, - "items" : { - "$ref" : "#/components/schemas/KeyNameDto" - } + "phase4Population" : { + "type" : "number", + "format" : "double", + "nullable" : true }, - "surveyModalityName" : { - "type" : "string", + "phase5Population" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "surveyCategoryName" : { - "type" : "string", + "phase3PlusPopulation" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "surveySubCategoryName" : { - "type" : "string", + "phase4PlusPopulation" : { + "type" : "integer", + "format" : "int32", "nullable" : true }, - "surveyPhaseName" : { - "type" : "string", + "phase3Percentage" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "surveyVisibility" : { - "type" : "string", + "phase4Percentage" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "isContinuousMonitoring" : { - "type" : "boolean" + "phase5Percentage" : { + "type" : "number", + "format" : "double", + "nullable" : true }, - "surveyName" : { - "type" : "string", + "phase3PlusPercentage" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "xlsFormId" : { - "type" : "integer", - "format" : "int32" + "phase4PlusPercentage" : { + "type" : "number", + "format" : "double", + "nullable" : true }, - "baseXlsFormId" : { - "type" : "integer", - "format" : "int32" + "dataSource" : { + "type" : "string", + "nullable" : true } }, "additionalProperties" : { } }, - "HouseholdSurveyListDTOPagedResult" : { + "IpcchBaseDtoPagedResult" : { "type" : "object", "properties" : { "items" : { @@ -5631,7 +6889,7 @@ "nullable" : true, "readOnly" : true, "items" : { - "$ref" : "#/components/schemas/HouseholdSurveyListDTO" + "$ref" : "#/components/schemas/IpcchBaseDto" } }, "page" : { @@ -5645,113 +6903,125 @@ }, "additionalProperties" : { } }, - "IpcValue" : { + "IpcchPeaksDto" : { "type" : "object", "properties" : { - "ipcId" : { - "type" : "integer", - "format" : "int32" + "iso3Alpha3" : { + "type" : "string", + "nullable" : true + }, + "countryName" : { + "type" : "string", + "nullable" : true }, - "ipcYear" : { + "populationGroupId" : { "type" : "integer", "format" : "int32" }, - "iso3Alpha3" : { - "maxLength" : 3, - "minLength" : 0, + "populationGroupName" : { "type" : "string", "nullable" : true }, - "ipcIsLatestValue" : { - "type" : "boolean" + "analysisTitle" : { + "type" : "string", + "nullable" : true }, - "ipcCountryName" : { - "maxLength" : 128, - "minLength" : 0, + "analysisDate" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "ipcAreaName" : { - "maxLength" : 128, - "minLength" : 0, + "periodStart" : { "type" : "string", + "format" : "date-time", "nullable" : true }, - "ipcPhase3Population" : { - "type" : "integer", - "format" : "int32", + "periodEnd" : { + "type" : "string", + "format" : "date-time", "nullable" : true }, - "ipcPhase4Population" : { - "type" : "integer", - "format" : "int32", + "periodType" : { + "type" : "string", + "nullable" : true + }, + "population" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "ipcPhase5Population" : { + "populationAnalysed" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "ipcPhase3Percentage" : { + "populationAnalysedPercentage" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase3Population" : { + "type" : "number", + "format" : "double", + "nullable" : true + }, + "phase4Population" : { "type" : "number", "format" : "double", "nullable" : true }, - "ipcPhase4Percentage" : { + "phase5Population" : { "type" : "number", "format" : "double", "nullable" : true }, - "ipcPhase5Percentage" : { + "phase3PlusPopulation" : { "type" : "number", "format" : "double", "nullable" : true }, - "ipcAnalysedPopulation" : { + "phase4PlusPopulation" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "ipcAnalysedPercentage" : { + "phase3Percentage" : { "type" : "number", "format" : "double", "nullable" : true }, - "ipcAnalysisComment" : { - "type" : "string", + "phase4Percentage" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "ipcDataType" : { - "maxLength" : 256, - "minLength" : 0, - "type" : "string", + "phase5Percentage" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "ipcDataSource" : { - "maxLength" : 128, - "minLength" : 0, - "type" : "string", + "phase3PlusPercentage" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "ipcReferencePeriod" : { - "maxLength" : 256, - "minLength" : 0, - "type" : "string", + "phase4PlusPercentage" : { + "type" : "number", + "format" : "double", "nullable" : true }, - "ipcCreateDate" : { - "type" : "string", - "format" : "date-time" - }, - "ipcUpdateDate" : { + "dataSource" : { "type" : "string", - "format" : "date-time", "nullable" : true + }, + "referenceYear" : { + "type" : "integer", + "format" : "int32" } }, "additionalProperties" : { } }, - "IpcValuePagedResult" : { + "IpcchPeaksDtoPagedResult" : { "type" : "object", "properties" : { "items" : { @@ -5759,7 +7029,7 @@ "nullable" : true, "readOnly" : true, "items" : { - "$ref" : "#/components/schemas/IpcValue" + "$ref" : "#/components/schemas/IpcchPeaksDto" } }, "page" : { @@ -5787,6 +7057,25 @@ }, "additionalProperties" : { } }, + "ListItemDto" : { + "required" : [ "label", "name" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int32" + }, + "name" : { + "type" : "string", + "nullable" : true + }, + "label" : { + "type" : "string", + "nullable" : true + } + }, + "additionalProperties" : { } + }, "MFIProcessedDataDTO" : { "type" : "object", "properties" : { @@ -6632,26 +7921,26 @@ }, "additionalProperties" : { } }, - "ViewExtendedAggregatedPrice" : { + "ViewExtendedMonthlyAggregatedPrice" : { "type" : "object", "properties" : { - "commodityID" : { + "commodityId" : { "type" : "integer", "format" : "int32" }, - "marketID" : { + "marketId" : { "type" : "integer", "format" : "int32" }, - "priceTypeID" : { + "priceTypeId" : { "type" : "integer", "format" : "int32" }, - "commodityUnitID" : { + "commodityUnitId" : { "type" : "integer", "format" : "int32" }, - "currencyID" : { + "currencyId" : { "type" : "integer", "format" : "int32" }, @@ -6700,7 +7989,7 @@ "type" : "string", "nullable" : true }, - "countryISO3" : { + "countryIso3" : { "type" : "string", "nullable" : true }, @@ -6733,7 +8022,7 @@ }, "additionalProperties" : { } }, - "ViewExtendedAggregatedPricePagedResult" : { + "ViewExtendedMonthlyAggregatedPricePagedResult" : { "type" : "object", "properties" : { "items" : { @@ -6741,7 +8030,7 @@ "nullable" : true, "readOnly" : true, "items" : { - "$ref" : "#/components/schemas/ViewExtendedAggregatedPrice" + "$ref" : "#/components/schemas/ViewExtendedMonthlyAggregatedPrice" } }, "page" : { @@ -6755,48 +8044,44 @@ }, "additionalProperties" : { } }, - "ViewExtendedAlpsValue" : { + "WeeklyAggregatedPrice" : { "type" : "object", "properties" : { - "commodityID" : { + "commodityId" : { "type" : "integer", "format" : "int32" }, - "marketID" : { + "marketId" : { "type" : "integer", "format" : "int32" }, - "priceTypeID" : { + "priceTypeId" : { "type" : "integer", "format" : "int32" }, - "commodityUnitID" : { + "commodityUnitId" : { "type" : "integer", "format" : "int32" }, - "currencyID" : { + "currencyId" : { "type" : "integer", "format" : "int32" }, "adm0Code" : { "type" : "integer", - "format" : "int32", - "nullable" : true - }, - "countryName" : { - "type" : "string", - "nullable" : true + "format" : "int32" }, - "commodityPriceDateYear" : { + "commodityDateWeek" : { "type" : "integer", - "format" : "int32" + "format" : "int32", + "nullable" : true }, - "commodityPriceDateMonth" : { + "commodityDateMonth" : { "type" : "integer", "format" : "int32", "nullable" : true }, - "commodityPriceDateWeek" : { + "commodityDateYear" : { "type" : "integer", "format" : "int32", "nullable" : true @@ -6826,108 +8111,25 @@ "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" : { + "countryIso3" : { "type" : "string", "nullable" : true }, - "currencyName" : { + "countryName" : { "type" : "string", "nullable" : true }, - "adm0Code" : { - "type" : "integer", - "format" : "int32" - }, - "countryISO3" : { + "commodityPriceSourceName" : { "type" : "string", "nullable" : true }, - "countryName" : { + "originalFrequency" : { "type" : "string", "nullable" : true }, "commodityPrice" : { "type" : "number", - "format" : "double" - }, - "originalFrequency" : { - "type" : "string", - "nullable" : true - }, - "commodityPriceSourceName" : { - "type" : "string", + "format" : "double", "nullable" : true }, "commodityPriceObservations" : { @@ -6935,18 +8137,6 @@ "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 @@ -7093,10 +8283,12 @@ "authorizationUrl" : "https://api.wfp.org/authorize", "scopes" : { "vamdatabridges_rpme-fulldata_get" : "vamdatabridges_rpme-fulldata_get", - "vamdatabridges_foodsecurity-list_get" : "vamdatabridges_foodsecurity-list_get", + "vamdatabridges_ipcch-ipcchandequivalent-latestpeaks_get" : "vamdatabridges_ipcch-ipcchandequivalent-latestpeaks_get", + "vamdatabridges_ipcch-ipcchandequivalentpeakswfpdashboard_get" : "vamdatabridges_ipcch-ipcchandequivalentpeakswfpdashboard_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_globaloutlook-globallatest_get" : "vamdatabridges_globaloutlook-globallatest_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", @@ -7106,42 +8298,46 @@ "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_cari-adm1values_get" : "vamdatabridges_cari-adm1values_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_globaloutlook-regionallatest_get" : "vamdatabridges_globaloutlook-regionallatest_get", "vamdatabridges_household-fulldata_get" : "vamdatabridges_household-fulldata_get", + "vamdatabridges_hungerhotspot-categoriesandindicators_get" : "vamdatabridges_hungerhotspot-categoriesandindicators_get", "vamdatabridges_household-officialusebasedata_get" : "vamdatabridges_household-officialusebasedata_get", + "vamdatabridges_globaloutlook-countrylatest_get" : "vamdatabridges_globaloutlook-countrylatest_get", "vamdatabridges_marketprices-pricemonthly_get" : "vamdatabridges_marketprices-pricemonthly_get", - "vamdatabridges_aims-downloadallanalysisrounds_get" : "vamdatabridges_aims-downloadallanalysisrounds_get", + "vamdatabridges_ipcch-ipcch-historicaldata_get" : "vamdatabridges_ipcch-ipcch-historicaldata_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_ipcch-ipcchandequivalent-historicalpeaks_get" : "vamdatabridges_ipcch-ipcchandequivalent-historicalpeaks_get", + "vamdatabridges_ipcch-ipcchandequivalent-mostrecent_get" : "vamdatabridges_ipcch-ipcchandequivalent-mostrecent_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_hungerhotspot-data_get" : "vamdatabridges_hungerhotspot-data_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_cari-adm0values_get" : "vamdatabridges_cari-adm0values_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_ipcch-ipcchandequivalent-latestpeaks_get" : "vamdatabridges_ipcch-ipcchandequivalent-latestpeaks_get", + "vamdatabridges_ipcch-ipcchandequivalentpeakswfpdashboard_get" : "vamdatabridges_ipcch-ipcchandequivalentpeakswfpdashboard_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_globaloutlook-globallatest_get" : "vamdatabridges_globaloutlook-globallatest_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", @@ -7151,34 +8347,36 @@ "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_cari-adm1values_get" : "vamdatabridges_cari-adm1values_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_globaloutlook-regionallatest_get" : "vamdatabridges_globaloutlook-regionallatest_get", "vamdatabridges_household-fulldata_get" : "vamdatabridges_household-fulldata_get", + "vamdatabridges_hungerhotspot-categoriesandindicators_get" : "vamdatabridges_hungerhotspot-categoriesandindicators_get", "vamdatabridges_household-officialusebasedata_get" : "vamdatabridges_household-officialusebasedata_get", + "vamdatabridges_globaloutlook-countrylatest_get" : "vamdatabridges_globaloutlook-countrylatest_get", "vamdatabridges_marketprices-pricemonthly_get" : "vamdatabridges_marketprices-pricemonthly_get", - "vamdatabridges_aims-downloadallanalysisrounds_get" : "vamdatabridges_aims-downloadallanalysisrounds_get", + "vamdatabridges_ipcch-ipcch-historicaldata_get" : "vamdatabridges_ipcch-ipcch-historicaldata_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_ipcch-ipcchandequivalent-historicalpeaks_get" : "vamdatabridges_ipcch-ipcchandequivalent-historicalpeaks_get", + "vamdatabridges_ipcch-ipcchandequivalent-mostrecent_get" : "vamdatabridges_ipcch-ipcchandequivalent-mostrecent_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_hungerhotspot-data_get" : "vamdatabridges_hungerhotspot-data_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_cari-adm0values_get" : "vamdatabridges_cari-adm0values_get", "vamdatabridges_rpme-basedata_get" : "vamdatabridges_rpme-basedata_get" } } @@ -7221,9 +8419,15 @@ "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.1.0" + "version" : "5.0.0" }, { "changes" : "\n\n\n*What's New*:\n- GET /MFI/Surveys/ProcessedDataWithKeysetPagination", "version" : "5.1.0" + }, { + "changes" : "\n*This version is not backward-compatible with previous versions.*\n*What's Deleted*:\n- GET /Gorp/Latest\n- GET /Gorp/List\n*What's Changed*:\n- Changed response schema in GET /FoodSecurity/List (Non-backward compatible)\n", + "version" : "6.0.0" + }, { + "changes" : "\n*This version is not backward-compatible with previous versions.*\n*What's New*:\n- GET /Cari/Adm0Values\n- GET /Cari/Adm1Values\n- GET /GlobalOutlook/CountryLatest\n- GET /GlobalOutlook/RegionalLatest\n- GET /GlobalOutlook/GlobalLatest\n- GET /HungerHotspot/CategoriesAndIndicators\n- GET /HungerHotspot/Data\n- GET /Ipcch/IPCCHAndEquivalentPeaks-WFPDashboard\n- GET /Ipcch/IPCCH-HistoricalData\n- GET /Ipcch/IPCCHAndEquivalent-MostRecent\n- GET /Ipcch/IPCCHAndEquivalent-LatestPeaks\n- GET /Ipcch/IPCCHAndEquivalent-HistoricalPeaks\n*What's Deleted*:\n- GET /Aims/DownloadAllAnalysisRounds\n- GET /Aims/DownloadPolygonFiles\n- GET /FoodSecurity/List\n- GET /Gorp/CountryLatest\n- GET /Gorp/GlobalLatest\n- GET /Gorp/RegionalLatest\n*What's Changed*:\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/PriceWeekly \n", + "version" : "7.0.0" } ] } \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 0363b0a..9592626 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,16 +1,16 @@ [tool.poetry] name = "data_bridges_client" -version = "6.0.0" +version = "7.0.0" description = "VAM-Data-Bridges" authors = ["VAM-INFO "] -license = "NoLicense" +license = "Affero GPL 3.0" readme = "README.md" repository = "https://github.com/WFP-VAM/DataBridgesAPI" keywords = ["OpenAPI", "OpenAPI-Generator", "VAM-Data-Bridges"] include = ["data_bridges_client/py.typed"] [tool.poetry.dependencies] -python = "^3.7" +python = "^3.10" urllib3 = ">= 1.25.3" python-dateutil = ">=2.8.2" @@ -35,8 +35,8 @@ extension-pkg-whitelist = "pydantic" [tool.mypy] files = [ "data_bridges_client", - #"test", # auto-generated tests - "tests", # hand-written tests + "test", # auto-generated tests + # "tests", # hand-written tests ] # TODO: enable "strict" once all these individual checks are passing # strict = true diff --git a/setup.py b/setup.py index 9cf0a94..dc6b43b 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 = "6.0.0" -PYTHON_REQUIRES = ">=3.7" +VERSION = "7.0.0" +PYTHON_REQUIRES = ">=3.10" 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 2ebe3c4..c48a452 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_cari_adm0_values_dto.py b/test/test_cari_adm0_values_dto.py new file mode 100644 index 0000000..9ad7610 --- /dev/null +++ b/test/test_cari_adm0_values_dto.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.cari_adm0_values_dto import CariAdm0ValuesDTO + +class TestCariAdm0ValuesDTO(unittest.TestCase): + """CariAdm0ValuesDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CariAdm0ValuesDTO: + """Test CariAdm0ValuesDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CariAdm0ValuesDTO` + """ + model = CariAdm0ValuesDTO() + if include_optional: + return CariAdm0ValuesDTO( + survey_id = 56, + survey_name = '', + cari_methodology_name = '', + fcs_methodology_name = '', + additional_survey_metadata = '', + adm0_code = 56, + adm0_name = '', + cari_indicator_id = 56, + cari_indicator_name = '', + cari_indicator_category_id = 56, + indicator_category_label = '' + ) + else: + return CariAdm0ValuesDTO( + ) + """ + + def testCariAdm0ValuesDTO(self): + """Test CariAdm0ValuesDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_view_extended_alps_value_paged_result.py b/test/test_cari_adm0_values_dto_paged_result.py similarity index 65% rename from test/test_view_extended_alps_value_paged_result.py rename to test/test_cari_adm0_values_dto_paged_result.py index c9dd9ca..8c6e32c 100644 --- a/test/test_view_extended_alps_value_paged_result.py +++ b/test/test_cari_adm0_values_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,10 +15,10 @@ import unittest -from data_bridges_client.models.view_extended_alps_value_paged_result import ViewExtendedAlpsValuePagedResult +from data_bridges_client.models.cari_adm0_values_dto_paged_result import CariAdm0ValuesDTOPagedResult -class TestViewExtendedAlpsValuePagedResult(unittest.TestCase): - """ViewExtendedAlpsValuePagedResult unit test stubs""" +class TestCariAdm0ValuesDTOPagedResult(unittest.TestCase): + """CariAdm0ValuesDTOPagedResult unit test stubs""" def setUp(self): pass @@ -26,16 +26,16 @@ def setUp(self): def tearDown(self): pass - def make_instance(self, include_optional) -> ViewExtendedAlpsValuePagedResult: - """Test ViewExtendedAlpsValuePagedResult + def make_instance(self, include_optional) -> CariAdm0ValuesDTOPagedResult: + """Test CariAdm0ValuesDTOPagedResult include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ - # uncomment below to create an instance of `ViewExtendedAlpsValuePagedResult` + # uncomment below to create an instance of `CariAdm0ValuesDTOPagedResult` """ - model = ViewExtendedAlpsValuePagedResult() + model = CariAdm0ValuesDTOPagedResult() if include_optional: - return ViewExtendedAlpsValuePagedResult( + return CariAdm0ValuesDTOPagedResult( items = [ { 'key' : null @@ -45,12 +45,12 @@ def make_instance(self, include_optional) -> ViewExtendedAlpsValuePagedResult: total_items = 56 ) else: - return ViewExtendedAlpsValuePagedResult( + return CariAdm0ValuesDTOPagedResult( ) """ - def testViewExtendedAlpsValuePagedResult(self): - """Test ViewExtendedAlpsValuePagedResult""" + def testCariAdm0ValuesDTOPagedResult(self): + """Test CariAdm0ValuesDTOPagedResult""" # inst_req_only = self.make_instance(include_optional=False) # inst_req_and_optional = self.make_instance(include_optional=True) diff --git a/test/test_cari_adm1_values_dto.py b/test/test_cari_adm1_values_dto.py new file mode 100644 index 0000000..19f741c --- /dev/null +++ b/test/test_cari_adm1_values_dto.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.cari_adm1_values_dto import CariAdm1ValuesDTO + +class TestCariAdm1ValuesDTO(unittest.TestCase): + """CariAdm1ValuesDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CariAdm1ValuesDTO: + """Test CariAdm1ValuesDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CariAdm1ValuesDTO` + """ + model = CariAdm1ValuesDTO() + if include_optional: + return CariAdm1ValuesDTO( + survey_id = 56, + survey_name = '', + cari_methodology_name = '', + fcs_methodology_name = '', + additional_survey_metadata = '', + adm0_code = 56, + adm0_name = '', + cari_indicator_id = 56, + cari_indicator_name = '', + cari_indicator_category_id = 56, + indicator_category_label = '', + adm1_code = 56, + adm1_name = '' + ) + else: + return CariAdm1ValuesDTO( + ) + """ + + def testCariAdm1ValuesDTO(self): + """Test CariAdm1ValuesDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_cari_adm1_values_dto_paged_result.py b/test/test_cari_adm1_values_dto_paged_result.py new file mode 100644 index 0000000..379ee72 --- /dev/null +++ b/test/test_cari_adm1_values_dto_paged_result.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.cari_adm1_values_dto_paged_result import CariAdm1ValuesDTOPagedResult + +class TestCariAdm1ValuesDTOPagedResult(unittest.TestCase): + """CariAdm1ValuesDTOPagedResult unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CariAdm1ValuesDTOPagedResult: + """Test CariAdm1ValuesDTOPagedResult + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CariAdm1ValuesDTOPagedResult` + """ + model = CariAdm1ValuesDTOPagedResult() + if include_optional: + return CariAdm1ValuesDTOPagedResult( + items = [ + { + 'key' : null + } + ], + page = 56, + total_items = 56 + ) + else: + return CariAdm1ValuesDTOPagedResult( + ) + """ + + def testCariAdm1ValuesDTOPagedResult(self): + """Test CariAdm1ValuesDTOPagedResult""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_categories_and_indicators_dto.py b/test/test_categories_and_indicators_dto.py new file mode 100644 index 0000000..c2d8efa --- /dev/null +++ b/test/test_categories_and_indicators_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.categories_and_indicators_dto import CategoriesAndIndicatorsDTO + +class TestCategoriesAndIndicatorsDTO(unittest.TestCase): + """CategoriesAndIndicatorsDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CategoriesAndIndicatorsDTO: + """Test CategoriesAndIndicatorsDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CategoriesAndIndicatorsDTO` + """ + model = CategoriesAndIndicatorsDTO() + if include_optional: + return CategoriesAndIndicatorsDTO( + categories = [ + { + 'key' : null + } + ], + indicators = [ + { + 'key' : null + } + ] + ) + else: + return CategoriesAndIndicatorsDTO( + ) + """ + + def testCategoriesAndIndicatorsDTO(self): + """Test CategoriesAndIndicatorsDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_commodities_api.py b/test/test_commodities_api.py index 3dd8c98..78e8cd3 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_commodity_dto.py b/test/test_commodity_dto.py index 05bdc9c..c89a83e 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 bc70f31..c618476 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 1b3ad17..2ec77c0 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 2e3bd41..ec8293d 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 e6a296e..7d3ac99 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_currency_api.py b/test/test_currency_api.py index 170772c..4720bfa 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_currency_dto.py b/test/test_currency_dto.py index 217e709..83b4a87 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 af73ad4..42e7dbe 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_economic_data_dto.py b/test/test_economic_data_dto.py index a6b9754..9623cef 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 2397c78..d54dcea 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 cbd9b70..43281c7 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: 6.0.0 + The version of the OpenAPI document: 7.0.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_extended_alps_value_dto.py similarity index 77% rename from test/test_view_extended_alps_value.py rename to test/test_extended_alps_value_dto.py index 624d631..e5befce 100644 --- a/test/test_view_extended_alps_value.py +++ b/test/test_extended_alps_value_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,10 +15,10 @@ import unittest -from data_bridges_client.models.view_extended_alps_value import ViewExtendedAlpsValue +from data_bridges_client.models.extended_alps_value_dto import ExtendedAlpsValueDto -class TestViewExtendedAlpsValue(unittest.TestCase): - """ViewExtendedAlpsValue unit test stubs""" +class TestExtendedAlpsValueDto(unittest.TestCase): + """ExtendedAlpsValueDto unit test stubs""" def setUp(self): pass @@ -26,16 +26,16 @@ def setUp(self): def tearDown(self): pass - def make_instance(self, include_optional) -> ViewExtendedAlpsValue: - """Test ViewExtendedAlpsValue + def make_instance(self, include_optional) -> ExtendedAlpsValueDto: + """Test ExtendedAlpsValueDto include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ - # uncomment below to create an instance of `ViewExtendedAlpsValue` + # uncomment below to create an instance of `ExtendedAlpsValueDto` """ - model = ViewExtendedAlpsValue() + model = ExtendedAlpsValueDto() if include_optional: - return ViewExtendedAlpsValue( + return ExtendedAlpsValueDto( commodity_id = 56, market_id = 56, price_type_id = 56, @@ -57,12 +57,12 @@ def make_instance(self, include_optional) -> ViewExtendedAlpsValue: analysis_value_price_flag = '' ) else: - return ViewExtendedAlpsValue( + return ExtendedAlpsValueDto( ) """ - def testViewExtendedAlpsValue(self): - """Test ViewExtendedAlpsValue""" + def testExtendedAlpsValueDto(self): + """Test ExtendedAlpsValueDto""" # inst_req_only = self.make_instance(include_optional=False) # inst_req_and_optional = self.make_instance(include_optional=True) diff --git a/test/test_extended_alps_value_dto_paged_result.py b/test/test_extended_alps_value_dto_paged_result.py new file mode 100644 index 0000000..81edf80 --- /dev/null +++ b/test/test_extended_alps_value_dto_paged_result.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.extended_alps_value_dto_paged_result import ExtendedAlpsValueDtoPagedResult + +class TestExtendedAlpsValueDtoPagedResult(unittest.TestCase): + """ExtendedAlpsValueDtoPagedResult unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ExtendedAlpsValueDtoPagedResult: + """Test ExtendedAlpsValueDtoPagedResult + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ExtendedAlpsValueDtoPagedResult` + """ + model = ExtendedAlpsValueDtoPagedResult() + if include_optional: + return ExtendedAlpsValueDtoPagedResult( + items = [ + { + 'key' : null + } + ], + page = 56, + total_items = 56 + ) + else: + return ExtendedAlpsValueDtoPagedResult( + ) + """ + + def testExtendedAlpsValueDtoPagedResult(self): + """Test ExtendedAlpsValueDtoPagedResult""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_feature.py b/test/test_feature.py index 473cb6a..c105fdf 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_geometry.py b/test/test_geometry.py index 9147433..a8e05f0 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: 6.0.0 + The version of the OpenAPI document: 7.0.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_global_outlook_api.py similarity index 58% rename from test/test_gorp_api.py rename to test/test_global_outlook_api.py index fb8f6ba..9384bf5 100644 --- a/test/test_gorp_api.py +++ b/test/test_global_outlook_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,36 +15,36 @@ import unittest -from data_bridges_client.api.gorp_api import GorpApi +from data_bridges_client.api.global_outlook_api import GlobalOutlookApi -class TestGorpApi(unittest.TestCase): - """GorpApi unit test stubs""" +class TestGlobalOutlookApi(unittest.TestCase): + """GlobalOutlookApi unit test stubs""" def setUp(self) -> None: - self.api = GorpApi() + self.api = GlobalOutlookApi() def tearDown(self) -> None: pass - def test_gorp_country_latest_get(self) -> None: - """Test case for gorp_country_latest_get + def test_global_outlook_country_latest_get(self) -> None: + """Test case for global_outlook_country_latest_get - Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP Global Operational Response Plan. + Return the latest country dataset of number of acutely food insecure (in thousands) based on WFP's Global Outlook. """ pass - def test_gorp_global_latest_get(self) -> None: - """Test case for gorp_global_latest_get + def test_global_outlook_global_latest_get(self) -> None: + """Test case for global_outlook_global_latest_get - Return the latest global dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + Return the latest global dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. """ pass - def test_gorp_regional_latest_get(self) -> None: - """Test case for gorp_regional_latest_get + def test_global_outlook_regional_latest_get(self) -> None: + """Test case for global_outlook_regional_latest_get - Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP Global Operational Response Plan. + Return the latest regional dataset of number of acutely food insecure (in millions) based on WFP's Global Outlook. """ pass diff --git a/test/test_gorp_global_api_dto.py b/test/test_global_outlook_api_dto.py similarity index 63% rename from test/test_gorp_global_api_dto.py rename to test/test_global_outlook_api_dto.py index 0f29b5d..99c7e69 100644 --- a/test/test_gorp_global_api_dto.py +++ b/test/test_global_outlook_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,10 +15,10 @@ import unittest -from data_bridges_client.models.gorp_global_api_dto import GorpGlobalApiDto +from data_bridges_client.models.global_outlook_api_dto import GlobalOutlookApiDto -class TestGorpGlobalApiDto(unittest.TestCase): - """GorpGlobalApiDto unit test stubs""" +class TestGlobalOutlookApiDto(unittest.TestCase): + """GlobalOutlookApiDto unit test stubs""" def setUp(self): pass @@ -26,29 +26,29 @@ def setUp(self): def tearDown(self): pass - def make_instance(self, include_optional) -> GorpGlobalApiDto: - """Test GorpGlobalApiDto + def make_instance(self, include_optional) -> GlobalOutlookApiDto: + """Test GlobalOutlookApiDto include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ - # uncomment below to create an instance of `GorpGlobalApiDto` + # uncomment below to create an instance of `GlobalOutlookApiDto` """ - model = GorpGlobalApiDto() + model = GlobalOutlookApiDto() if include_optional: - return GorpGlobalApiDto( - gorp_date = '', - gorp_region_name = '', - gorp_total_value = 1.337, + return GlobalOutlookApiDto( + var_date = '', + region_name = '', + total_value = 1.337, number_of_countries = 56, - gorp_comment = '' + comment = '' ) else: - return GorpGlobalApiDto( + return GlobalOutlookApiDto( ) """ - def testGorpGlobalApiDto(self): - """Test GorpGlobalApiDto""" + def testGlobalOutlookApiDto(self): + """Test GlobalOutlookApiDto""" # inst_req_only = self.make_instance(include_optional=False) # inst_req_and_optional = self.make_instance(include_optional=True) diff --git a/test/test_global_outlook_country_api_dto.py b/test/test_global_outlook_country_api_dto.py new file mode 100644 index 0000000..389541c --- /dev/null +++ b/test/test_global_outlook_country_api_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.global_outlook_country_api_dto import GlobalOutlookCountryApiDto + +class TestGlobalOutlookCountryApiDto(unittest.TestCase): + """GlobalOutlookCountryApiDto unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GlobalOutlookCountryApiDto: + """Test GlobalOutlookCountryApiDto + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `GlobalOutlookCountryApiDto` + """ + model = GlobalOutlookCountryApiDto() + if include_optional: + return GlobalOutlookCountryApiDto( + var_date = '', + country_office_iso3 = '', + total_value = 1.337, + comment = '' + ) + else: + return GlobalOutlookCountryApiDto( + ) + """ + + def testGlobalOutlookCountryApiDto(self): + """Test GlobalOutlookCountryApiDto""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_gorp_regional_api_dto.py b/test/test_global_outlook_regional_api_dto.py similarity index 60% rename from test/test_gorp_regional_api_dto.py rename to test/test_global_outlook_regional_api_dto.py index aa2df2d..921b63f 100644 --- a/test/test_gorp_regional_api_dto.py +++ b/test/test_global_outlook_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,10 +15,10 @@ import unittest -from data_bridges_client.models.gorp_regional_api_dto import GorpRegionalApiDto +from data_bridges_client.models.global_outlook_regional_api_dto import GlobalOutlookRegionalApiDto -class TestGorpRegionalApiDto(unittest.TestCase): - """GorpRegionalApiDto unit test stubs""" +class TestGlobalOutlookRegionalApiDto(unittest.TestCase): + """GlobalOutlookRegionalApiDto unit test stubs""" def setUp(self): pass @@ -26,29 +26,29 @@ def setUp(self): def tearDown(self): pass - def make_instance(self, include_optional) -> GorpRegionalApiDto: - """Test GorpRegionalApiDto + def make_instance(self, include_optional) -> GlobalOutlookRegionalApiDto: + """Test GlobalOutlookRegionalApiDto include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ - # uncomment below to create an instance of `GorpRegionalApiDto` + # uncomment below to create an instance of `GlobalOutlookRegionalApiDto` """ - model = GorpRegionalApiDto() + model = GlobalOutlookRegionalApiDto() if include_optional: - return GorpRegionalApiDto( - gorp_date = '', - gorp_region_name = '', - gorp_total_value = 1.337, + return GlobalOutlookRegionalApiDto( + var_date = '', + region_name = '', + total_value = 1.337, number_of_countries = 56, - gorp_comment = '' + comment = '' ) else: - return GorpRegionalApiDto( + return GlobalOutlookRegionalApiDto( ) """ - def testGorpRegionalApiDto(self): - """Test GorpRegionalApiDto""" + def testGlobalOutlookRegionalApiDto(self): + """Test GlobalOutlookRegionalApiDto""" # inst_req_only = self.make_instance(include_optional=False) # inst_req_and_optional = self.make_instance(include_optional=True) diff --git a/test/test_household_survey_list_dto.py b/test/test_household_survey_list_dto.py index 24e8423..6ed206a 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 0cbc1d7..c2409e1 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_hunger_hot_spot_data_dto.py b/test/test_hunger_hot_spot_data_dto.py new file mode 100644 index 0000000..2ed48ec --- /dev/null +++ b/test/test_hunger_hot_spot_data_dto.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.hunger_hot_spot_data_dto import HungerHotSpotDataDTO + +class TestHungerHotSpotDataDTO(unittest.TestCase): + """HungerHotSpotDataDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> HungerHotSpotDataDTO: + """Test HungerHotSpotDataDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `HungerHotSpotDataDTO` + """ + model = HungerHotSpotDataDTO() + if include_optional: + return HungerHotSpotDataDTO( + iso3_code = '', + hunger_hotspots_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + category = { + 'key' : null + }, + indicators = [ + { + 'key' : null + } + ] + ) + else: + return HungerHotSpotDataDTO( + ) + """ + + def testHungerHotSpotDataDTO(self): + """Test HungerHotSpotDataDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_hunger_hot_spot_data_dto_paged_result.py b/test/test_hunger_hot_spot_data_dto_paged_result.py new file mode 100644 index 0000000..3ce65c9 --- /dev/null +++ b/test/test_hunger_hot_spot_data_dto_paged_result.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.hunger_hot_spot_data_dto_paged_result import HungerHotSpotDataDTOPagedResult + +class TestHungerHotSpotDataDTOPagedResult(unittest.TestCase): + """HungerHotSpotDataDTOPagedResult unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> HungerHotSpotDataDTOPagedResult: + """Test HungerHotSpotDataDTOPagedResult + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `HungerHotSpotDataDTOPagedResult` + """ + model = HungerHotSpotDataDTOPagedResult() + if include_optional: + return HungerHotSpotDataDTOPagedResult( + items = [ + { + 'key' : null + } + ], + page = 56, + total_items = 56 + ) + else: + return HungerHotSpotDataDTOPagedResult( + ) + """ + + def testHungerHotSpotDataDTOPagedResult(self): + """Test HungerHotSpotDataDTOPagedResult""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_food_security_api.py b/test/test_hunger_hotspot_api.py similarity index 57% rename from test/test_food_security_api.py rename to test/test_hunger_hotspot_api.py index e35bc6e..2049c9a 100644 --- a/test/test_food_security_api.py +++ b/test/test_hunger_hotspot_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,21 +15,29 @@ import unittest -from data_bridges_client.api.food_security_api import FoodSecurityApi +from data_bridges_client.api.hunger_hotspot_api import HungerHotspotApi -class TestFoodSecurityApi(unittest.TestCase): - """FoodSecurityApi unit test stubs""" +class TestHungerHotspotApi(unittest.TestCase): + """HungerHotspotApi unit test stubs""" def setUp(self) -> None: - self.api = FoodSecurityApi() + self.api = HungerHotspotApi() def tearDown(self) -> None: pass - def test_food_security_list_get(self) -> None: - """Test case for food_security_list_get + def test_hunger_hotspot_categories_and_indicators_get(self) -> None: + """Test case for hunger_hotspot_categories_and_indicators_get + Retrieves Hunger Hotspot categories and indicators. + """ + pass + + def test_hunger_hotspot_data_get(self) -> None: + """Test case for hunger_hotspot_data_get + + Retrieves a paginated list of Hunger Hotspot data. """ pass diff --git a/test/test_incubation_api.py b/test/test_incubation_api.py index 7f4b1e6..e294dc7 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -27,17 +27,17 @@ def setUp(self) -> None: def tearDown(self) -> None: pass - def test_aims_download_all_analysis_rounds_get(self) -> None: - """Test case for aims_download_all_analysis_rounds_get + def test_cari_adm0_values_get(self) -> None: + """Test case for cari_adm0_values_get - Each asset has a baseline and several rounds. Each round reflects the number of times the asset has been analysed over time. The number of total rounds changes according to the workstream: Asset Detection (AD) assets can have a total of 5 rounds, while there is no limit to the monitoring of Landscape Impact Assessment (LIA) assets. Assets considered for Site Prioritization (SP) have one round only. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). + Retrieves a paginated list of Adm0 CARI results based on the specified indicator, administrative code, and survey. """ pass - def test_aims_download_polygon_files_get(self) -> None: - """Test case for aims_download_polygon_files_get + def test_cari_adm1_values_get(self) -> None: + """Test case for cari_adm1_values_get - Polygon files are available for Landscape Impact Assessment (LIA) assets only. The file name corresponds to the “Geotrace” name. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only). + Retrieves a paginated list of Adm1 CARI results based on the specified indicator, administrative code, and survey. """ pass diff --git a/test/test_ipc_historical_datum_dto.py b/test/test_ipc_historical_datum_dto.py new file mode 100644 index 0000000..b68a78e --- /dev/null +++ b/test/test_ipc_historical_datum_dto.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.ipc_historical_datum_dto import IpcHistoricalDatumDto + +class TestIpcHistoricalDatumDto(unittest.TestCase): + """IpcHistoricalDatumDto unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> IpcHistoricalDatumDto: + """Test IpcHistoricalDatumDto + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `IpcHistoricalDatumDto` + """ + model = IpcHistoricalDatumDto() + if include_optional: + return IpcHistoricalDatumDto( + analysis_id = 56, + analysis_title = '', + iso3_alpha3 = '', + country_name = '', + analysis_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + start_date_current_period = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + end_date_current_period = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + start_date_projected_period = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + end_date_projected_period = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + start_date_second_projected_period = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + end_date_second_projected_period = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + population = 1.337, + population_percentage = 1.337, + phase3_plus_population = 1.337, + phase3_plus_percentage = 1.337, + estimated_population = 1.337, + phase1_population = 1.337, + phase1_percentage = 1.337, + phase2_population = 1.337, + phase2_percentage = 1.337, + phase3_population = 1.337, + phase3_percentage = 1.337, + phase4_population = 1.337, + phase4_percentage = 1.337, + phase5_population = 1.337, + phase5_percentage = 1.337, + phase3_plus_population_projected = 1.337, + phase3_plus_percentage_projected = 1.337, + estimated_population_projected = 1.337, + phase1_population_projected = 1.337, + phase1_percentage_projected = 1.337, + phase2_population_projected = 1.337, + phase2_percentage_projected = 1.337, + phase3_population_projected = 1.337, + phase3_percentage_projected = 1.337, + phase4_population_projected = 1.337, + phase4_percentage_projected = 1.337, + phase5_population_projected = 1.337, + phase5_percentage_projected = 1.337, + phase3_plus_population_second_projected = 1.337, + phase3_plus_percentage_second_projected = 1.337, + estimated_population_second_projected = 1.337, + phase1_population_second_projected = 1.337, + phase1_percentage_second_projected = 1.337, + phase2_population_second_projected = 1.337, + phase2_percentage_second_projected = 1.337, + phase3_population_second_projected = 1.337, + phase3_percentage_second_projected = 1.337, + phase4_population_second_projected = 1.337, + phase4_percentage_second_projected = 1.337, + phase5_population_second_projected = 1.337, + phase5_percentage_second_projected = 1.337 + ) + else: + return IpcHistoricalDatumDto( + ) + """ + + def testIpcHistoricalDatumDto(self): + """Test IpcHistoricalDatumDto""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ipc_historical_datum_dto_paged_result.py b/test/test_ipc_historical_datum_dto_paged_result.py new file mode 100644 index 0000000..c1cb934 --- /dev/null +++ b/test/test_ipc_historical_datum_dto_paged_result.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.ipc_historical_datum_dto_paged_result import IpcHistoricalDatumDtoPagedResult + +class TestIpcHistoricalDatumDtoPagedResult(unittest.TestCase): + """IpcHistoricalDatumDtoPagedResult unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> IpcHistoricalDatumDtoPagedResult: + """Test IpcHistoricalDatumDtoPagedResult + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `IpcHistoricalDatumDtoPagedResult` + """ + model = IpcHistoricalDatumDtoPagedResult() + if include_optional: + return IpcHistoricalDatumDtoPagedResult( + items = [ + { + 'key' : null + } + ], + page = 56, + total_items = 56 + ) + else: + return IpcHistoricalDatumDtoPagedResult( + ) + """ + + def testIpcHistoricalDatumDtoPagedResult(self): + """Test IpcHistoricalDatumDtoPagedResult""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ipc_value.py b/test/test_ipc_value.py deleted file mode 100644 index 3fbc229..0000000 --- a/test/test_ipc_value.py +++ /dev/null @@ -1,76 +0,0 @@ -# coding: utf-8 - -""" - VAM-Data-Bridges - - API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern - - The version of the OpenAPI document: 6.0.0 - Contact: wfp.economicanalysis@wfp.org - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - - -import unittest - -from data_bridges_client.models.ipc_value import IpcValue - -class TestIpcValue(unittest.TestCase): - """IpcValue unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> IpcValue: - """Test IpcValue - include_optional is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `IpcValue` - """ - model = IpcValue() - if include_optional: - return IpcValue( - ipc_id = 56, - ipc_year = 56, - ipc_update_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - iso3_alpha3 = '', - ipc_country_name = '', - ipc_area_name = '', - ipc_phase3_population = 56, - ipc_phase4_population = 56, - ipc_phase5_population = 56, - ipc_phase35population = 56, - ipc_phase45population = 56, - ipc_phase3_percentage = 1.337, - ipc_phase4_percentage = 1.337, - ipc_phase5_percentage = 1.337, - ipc_phase35percentage = 1.337, - ipc_phase45percentage = 1.337, - ipc_analysed_population = 56, - ipc_analysed_percentage = 1.337, - ipc_analysis_comment = '', - ipc_data_type = '', - ipc_data_source = '', - ipc_reference_period = '', - ipc_create_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - ipc_show_on_data_viz = True, - ipc_is_latest_value = True - ) - else: - return IpcValue( - ) - """ - - def testIpcValue(self): - """Test IpcValue""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_ipcch_and_equivalent_peaks_dto.py b/test/test_ipcch_and_equivalent_peaks_dto.py new file mode 100644 index 0000000..cdddbf2 --- /dev/null +++ b/test/test_ipcch_and_equivalent_peaks_dto.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.ipcch_and_equivalent_peaks_dto import IpcchAndEquivalentPeaksDTO + +class TestIpcchAndEquivalentPeaksDTO(unittest.TestCase): + """IpcchAndEquivalentPeaksDTO unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> IpcchAndEquivalentPeaksDTO: + """Test IpcchAndEquivalentPeaksDTO + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `IpcchAndEquivalentPeaksDTO` + """ + model = IpcchAndEquivalentPeaksDTO() + if include_optional: + return IpcchAndEquivalentPeaksDTO( + regional_bureau_id = 56, + regional_bureau_name = '', + iso3_alpha3 = '', + country_name = '', + phase3_population = 56, + phase4_population = 56, + phase5_population = 56, + phase3_plus_population = 56 + ) + else: + return IpcchAndEquivalentPeaksDTO( + ) + """ + + def testIpcchAndEquivalentPeaksDTO(self): + """Test IpcchAndEquivalentPeaksDTO""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ipcch_and_equivalent_peaks_dto_paged_result.py b/test/test_ipcch_and_equivalent_peaks_dto_paged_result.py new file mode 100644 index 0000000..e10e0cf --- /dev/null +++ b/test/test_ipcch_and_equivalent_peaks_dto_paged_result.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.ipcch_and_equivalent_peaks_dto_paged_result import IpcchAndEquivalentPeaksDTOPagedResult + +class TestIpcchAndEquivalentPeaksDTOPagedResult(unittest.TestCase): + """IpcchAndEquivalentPeaksDTOPagedResult unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> IpcchAndEquivalentPeaksDTOPagedResult: + """Test IpcchAndEquivalentPeaksDTOPagedResult + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `IpcchAndEquivalentPeaksDTOPagedResult` + """ + model = IpcchAndEquivalentPeaksDTOPagedResult() + if include_optional: + return IpcchAndEquivalentPeaksDTOPagedResult( + items = [ + { + 'key' : null + } + ], + page = 56, + total_items = 56 + ) + else: + return IpcchAndEquivalentPeaksDTOPagedResult( + ) + """ + + def testIpcchAndEquivalentPeaksDTOPagedResult(self): + """Test IpcchAndEquivalentPeaksDTOPagedResult""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ipcch_api.py b/test/test_ipcch_api.py new file mode 100644 index 0000000..e75f289 --- /dev/null +++ b/test/test_ipcch_api.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.api.ipcch_api import IpcchApi + + +class TestIpcchApi(unittest.TestCase): + """IpcchApi unit test stubs""" + + def setUp(self) -> None: + self.api = IpcchApi() + + def tearDown(self) -> None: + pass + + def test_ipcch_ipcch_and_equivalent_historical_peaks_get(self) -> None: + """Test case for ipcch_ipcch_and_equivalent_historical_peaks_get + + Retrieves a paginated list of historical IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. + """ + pass + + def test_ipcch_ipcch_and_equivalent_latest_peaks_get(self) -> None: + """Test case for ipcch_ipcch_and_equivalent_latest_peaks_get + + Retrieves a paginated list of the latest IPCCH and Equivalent peaks data, optionally filtered by ISO3 country code. + """ + pass + + def test_ipcch_ipcch_and_equivalent_most_recent_get(self) -> None: + """Test case for ipcch_ipcch_and_equivalent_most_recent_get + + Retrieves a paginated list of the most recent IPCCH and Equivalent data, optionally filtered by ISO3 country code. + """ + pass + + def test_ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get(self) -> None: + """Test case for ipcch_ipcch_and_equivalent_peaks_wfp_dashboard_get + + Retrieves a paginated list of IPCCH and Equivalent Peaks data for the WFP Dashboard. + """ + pass + + def test_ipcch_ipcch_historical_data_get(self) -> None: + """Test case for ipcch_ipcch_historical_data_get + + Retrieves a paginated list of IPCCH and Equivalent Historical Data. + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ipcch_base_dto.py b/test/test_ipcch_base_dto.py new file mode 100644 index 0000000..52e2e42 --- /dev/null +++ b/test/test_ipcch_base_dto.py @@ -0,0 +1,74 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.ipcch_base_dto import IpcchBaseDto + +class TestIpcchBaseDto(unittest.TestCase): + """IpcchBaseDto unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> IpcchBaseDto: + """Test IpcchBaseDto + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `IpcchBaseDto` + """ + model = IpcchBaseDto() + if include_optional: + return IpcchBaseDto( + iso3_alpha3 = '', + country_name = '', + population_group_id = 56, + population_group_name = '', + analysis_title = '', + analysis_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + period_start = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + period_end = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + period_type = '', + population = 1.337, + population_analysed = 56, + population_analysed_percentage = 1.337, + phase3_population = 1.337, + phase4_population = 1.337, + phase5_population = 1.337, + phase3_plus_population = 1.337, + phase4_plus_population = 56, + phase3_percentage = 1.337, + phase4_percentage = 1.337, + phase5_percentage = 1.337, + phase3_plus_percentage = 1.337, + phase4_plus_percentage = 1.337, + data_source = '' + ) + else: + return IpcchBaseDto( + ) + """ + + def testIpcchBaseDto(self): + """Test IpcchBaseDto""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ipc_value_paged_result.py b/test/test_ipcch_base_dto_paged_result.py similarity index 68% rename from test/test_ipc_value_paged_result.py rename to test/test_ipcch_base_dto_paged_result.py index 4678d33..b6a34f1 100644 --- a/test/test_ipc_value_paged_result.py +++ b/test/test_ipcch_base_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,10 +15,10 @@ import unittest -from data_bridges_client.models.ipc_value_paged_result import IpcValuePagedResult +from data_bridges_client.models.ipcch_base_dto_paged_result import IpcchBaseDtoPagedResult -class TestIpcValuePagedResult(unittest.TestCase): - """IpcValuePagedResult unit test stubs""" +class TestIpcchBaseDtoPagedResult(unittest.TestCase): + """IpcchBaseDtoPagedResult unit test stubs""" def setUp(self): pass @@ -26,16 +26,16 @@ def setUp(self): def tearDown(self): pass - def make_instance(self, include_optional) -> IpcValuePagedResult: - """Test IpcValuePagedResult + def make_instance(self, include_optional) -> IpcchBaseDtoPagedResult: + """Test IpcchBaseDtoPagedResult include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ - # uncomment below to create an instance of `IpcValuePagedResult` + # uncomment below to create an instance of `IpcchBaseDtoPagedResult` """ - model = IpcValuePagedResult() + model = IpcchBaseDtoPagedResult() if include_optional: - return IpcValuePagedResult( + return IpcchBaseDtoPagedResult( items = [ { 'key' : null @@ -45,12 +45,12 @@ def make_instance(self, include_optional) -> IpcValuePagedResult: total_items = 56 ) else: - return IpcValuePagedResult( + return IpcchBaseDtoPagedResult( ) """ - def testIpcValuePagedResult(self): - """Test IpcValuePagedResult""" + def testIpcchBaseDtoPagedResult(self): + """Test IpcchBaseDtoPagedResult""" # inst_req_only = self.make_instance(include_optional=False) # inst_req_and_optional = self.make_instance(include_optional=True) diff --git a/test/test_ipcch_peaks_dto.py b/test/test_ipcch_peaks_dto.py new file mode 100644 index 0000000..f72f64a --- /dev/null +++ b/test/test_ipcch_peaks_dto.py @@ -0,0 +1,75 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.ipcch_peaks_dto import IpcchPeaksDto + +class TestIpcchPeaksDto(unittest.TestCase): + """IpcchPeaksDto unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> IpcchPeaksDto: + """Test IpcchPeaksDto + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `IpcchPeaksDto` + """ + model = IpcchPeaksDto() + if include_optional: + return IpcchPeaksDto( + iso3_alpha3 = '', + country_name = '', + population_group_id = 56, + population_group_name = '', + analysis_title = '', + analysis_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + period_start = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + period_end = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + period_type = '', + population = 1.337, + population_analysed = 56, + population_analysed_percentage = 1.337, + phase3_population = 1.337, + phase4_population = 1.337, + phase5_population = 1.337, + phase3_plus_population = 1.337, + phase4_plus_population = 56, + phase3_percentage = 1.337, + phase4_percentage = 1.337, + phase5_percentage = 1.337, + phase3_plus_percentage = 1.337, + phase4_plus_percentage = 1.337, + data_source = '', + reference_year = 56 + ) + else: + return IpcchPeaksDto( + ) + """ + + def testIpcchPeaksDto(self): + """Test IpcchPeaksDto""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ipcch_peaks_dto_paged_result.py b/test/test_ipcch_peaks_dto_paged_result.py new file mode 100644 index 0000000..c2529b6 --- /dev/null +++ b/test/test_ipcch_peaks_dto_paged_result.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + VAM-Data-Bridges + + API Documentation of the **DataBridges** platform: https://databridges.vam.wfp.org/. For API discussions and details: #api-integration-vam-data-bridges on Slack, [Teams channel](https://teams.microsoft.com/l/team/19%3a4ca595f7681f4ffa8a86b7af58832e8d%40thread.skype/conversations?groupId=cbd1e508-c6e8-459d-96b7-6cac3039c42c&tenantId=462ad9ae-d7d9-4206-b874-71b1e079776f) **API Integration** - This endpoint uses [Hey Jude](https://docs.api.wfp.org/providers/#api-patterns) pattern + + The version of the OpenAPI document: 7.0.0 + Contact: wfp.economicanalysis@wfp.org + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from data_bridges_client.models.ipcch_peaks_dto_paged_result import IpcchPeaksDtoPagedResult + +class TestIpcchPeaksDtoPagedResult(unittest.TestCase): + """IpcchPeaksDtoPagedResult unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> IpcchPeaksDtoPagedResult: + """Test IpcchPeaksDtoPagedResult + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `IpcchPeaksDtoPagedResult` + """ + model = IpcchPeaksDtoPagedResult() + if include_optional: + return IpcchPeaksDtoPagedResult( + items = [ + { + 'key' : null + } + ], + page = 56, + total_items = 56 + ) + else: + return IpcchPeaksDtoPagedResult( + ) + """ + + def testIpcchPeaksDtoPagedResult(self): + """Test IpcchPeaksDtoPagedResult""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_key_name_dto.py b/test/test_key_name_dto.py index 0d8a5d1..027ce92 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: 6.0.0 + The version of the OpenAPI document: 7.0.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_list_item_dto.py similarity index 63% rename from test/test_gorp_country_api_dto.py rename to test/test_list_item_dto.py index a23fd40..82ca947 100644 --- a/test/test_gorp_country_api_dto.py +++ b/test/test_list_item_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,10 +15,10 @@ import unittest -from data_bridges_client.models.gorp_country_api_dto import GorpCountryApiDto +from data_bridges_client.models.list_item_dto import ListItemDto -class TestGorpCountryApiDto(unittest.TestCase): - """GorpCountryApiDto unit test stubs""" +class TestListItemDto(unittest.TestCase): + """ListItemDto unit test stubs""" def setUp(self): pass @@ -26,28 +26,29 @@ def setUp(self): def tearDown(self): pass - def make_instance(self, include_optional) -> GorpCountryApiDto: - """Test GorpCountryApiDto + def make_instance(self, include_optional) -> ListItemDto: + """Test ListItemDto include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ - # uncomment below to create an instance of `GorpCountryApiDto` + # uncomment below to create an instance of `ListItemDto` """ - model = GorpCountryApiDto() + model = ListItemDto() if include_optional: - return GorpCountryApiDto( - gorp_date = '', - country_office_iso3 = '', - gorp_total_value = 1.337, - gorp_comment = '' + return ListItemDto( + id = 56, + name = '', + label = '' ) else: - return GorpCountryApiDto( + return ListItemDto( + name = '', + label = '', ) """ - def testGorpCountryApiDto(self): - """Test GorpCountryApiDto""" + def testListItemDto(self): + """Test ListItemDto""" # inst_req_only = self.make_instance(include_optional=False) # inst_req_and_optional = self.make_instance(include_optional=True) diff --git a/test/test_market_dto.py b/test/test_market_dto.py index c94cbf1..9aea88b 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 859b469..dd2046d 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 3e791a3..afa438e 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_markets_api.py b/test/test_markets_api.py index 42a3126..0824098 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_mfi_processed_data_dto.py b/test/test_mfi_processed_data_dto.py index 88cba06..aad07e6 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 ce3b46a..a8730fb 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 7d453db..2678850 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 c31f778..e84c767 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 294f758..178477f 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 6aee4b1..2c223d9 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 7b5423c..4e1ffe5 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 8cd4e0e..614e9f5 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 04f288e..defdca5 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_paged_survey_list_dto.py b/test/test_paged_survey_list_dto.py index efa74a9..e58be18 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 b1ff09d..6fad96c 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 917e13a..8776611 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 e729a28..f99cac6 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 650140c..924ed94 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 0b91898..316ae48 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_rpme_assessment.py b/test/test_rpme_assessment.py index 5f38116..d441ebf 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 9e088c0..d68b4ec 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 d7f5660..3eec31a 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 e783c15..2888b1c 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 042b3b6..8d9cfe2 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 d5c7d42..cf44dc3 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 161e3cb..5e06055 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/test/test_usd_indirect_quotation.py b/test/test_usd_indirect_quotation.py index ca5e394..ba6728a 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 b9eb27f..3ee915d 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: 6.0.0 + The version of the OpenAPI document: 7.0.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_monthly_aggregated_price.py similarity index 75% rename from test/test_view_extended_aggregated_price.py rename to test/test_view_extended_monthly_aggregated_price.py index 69e7ac2..4b0626a 100644 --- a/test/test_view_extended_aggregated_price.py +++ b/test/test_view_extended_monthly_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,10 +15,10 @@ import unittest -from data_bridges_client.models.view_extended_aggregated_price import ViewExtendedAggregatedPrice +from data_bridges_client.models.view_extended_monthly_aggregated_price import ViewExtendedMonthlyAggregatedPrice -class TestViewExtendedAggregatedPrice(unittest.TestCase): - """ViewExtendedAggregatedPrice unit test stubs""" +class TestViewExtendedMonthlyAggregatedPrice(unittest.TestCase): + """ViewExtendedMonthlyAggregatedPrice unit test stubs""" def setUp(self): pass @@ -26,16 +26,16 @@ def setUp(self): def tearDown(self): pass - def make_instance(self, include_optional) -> ViewExtendedAggregatedPrice: - """Test ViewExtendedAggregatedPrice + def make_instance(self, include_optional) -> ViewExtendedMonthlyAggregatedPrice: + """Test ViewExtendedMonthlyAggregatedPrice include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ - # uncomment below to create an instance of `ViewExtendedAggregatedPrice` + # uncomment below to create an instance of `ViewExtendedMonthlyAggregatedPrice` """ - model = ViewExtendedAggregatedPrice() + model = ViewExtendedMonthlyAggregatedPrice() if include_optional: - return ViewExtendedAggregatedPrice( + return ViewExtendedMonthlyAggregatedPrice( commodity_id = 56, market_id = 56, price_type_id = 56, @@ -60,12 +60,12 @@ def make_instance(self, include_optional) -> ViewExtendedAggregatedPrice: commodity_price_flag = '' ) else: - return ViewExtendedAggregatedPrice( + return ViewExtendedMonthlyAggregatedPrice( ) """ - def testViewExtendedAggregatedPrice(self): - """Test ViewExtendedAggregatedPrice""" + def testViewExtendedMonthlyAggregatedPrice(self): + """Test ViewExtendedMonthlyAggregatedPrice""" # inst_req_only = self.make_instance(include_optional=False) # inst_req_and_optional = self.make_instance(include_optional=True) diff --git a/test/test_view_extended_aggregated_price_paged_result.py b/test/test_view_extended_monthly_aggregated_price_paged_result.py similarity index 63% rename from test/test_view_extended_aggregated_price_paged_result.py rename to test/test_view_extended_monthly_aggregated_price_paged_result.py index 79b6876..9c2023b 100644 --- a/test/test_view_extended_aggregated_price_paged_result.py +++ b/test/test_view_extended_monthly_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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,10 +15,10 @@ import unittest -from data_bridges_client.models.view_extended_aggregated_price_paged_result import ViewExtendedAggregatedPricePagedResult +from data_bridges_client.models.view_extended_monthly_aggregated_price_paged_result import ViewExtendedMonthlyAggregatedPricePagedResult -class TestViewExtendedAggregatedPricePagedResult(unittest.TestCase): - """ViewExtendedAggregatedPricePagedResult unit test stubs""" +class TestViewExtendedMonthlyAggregatedPricePagedResult(unittest.TestCase): + """ViewExtendedMonthlyAggregatedPricePagedResult unit test stubs""" def setUp(self): pass @@ -26,16 +26,16 @@ def setUp(self): def tearDown(self): pass - def make_instance(self, include_optional) -> ViewExtendedAggregatedPricePagedResult: - """Test ViewExtendedAggregatedPricePagedResult + def make_instance(self, include_optional) -> ViewExtendedMonthlyAggregatedPricePagedResult: + """Test ViewExtendedMonthlyAggregatedPricePagedResult include_optional is a boolean, when False only required params are included, when True both required and optional params are included """ - # uncomment below to create an instance of `ViewExtendedAggregatedPricePagedResult` + # uncomment below to create an instance of `ViewExtendedMonthlyAggregatedPricePagedResult` """ - model = ViewExtendedAggregatedPricePagedResult() + model = ViewExtendedMonthlyAggregatedPricePagedResult() if include_optional: - return ViewExtendedAggregatedPricePagedResult( + return ViewExtendedMonthlyAggregatedPricePagedResult( items = [ { 'key' : null @@ -45,12 +45,12 @@ def make_instance(self, include_optional) -> ViewExtendedAggregatedPricePagedRes total_items = 56 ) else: - return ViewExtendedAggregatedPricePagedResult( + return ViewExtendedMonthlyAggregatedPricePagedResult( ) """ - def testViewExtendedAggregatedPricePagedResult(self): - """Test ViewExtendedAggregatedPricePagedResult""" + def testViewExtendedMonthlyAggregatedPricePagedResult(self): + """Test ViewExtendedMonthlyAggregatedPricePagedResult""" # inst_req_only = self.make_instance(include_optional=False) # inst_req_and_optional = self.make_instance(include_optional=True) diff --git a/test/test_weekly_aggregated_price.py b/test/test_weekly_aggregated_price.py index 399db62..5e69e77 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -41,21 +41,22 @@ def make_instance(self, include_optional) -> WeeklyAggregatedPrice: price_type_id = 56, commodity_unit_id = 56, currency_id = 56, + adm0_code = 56, + commodity_date_week = 56, + commodity_date_month = 56, + commodity_date_year = 56, + commodity_price_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), commodity_name = '', market_name = '', price_type_name = '', commodity_unit_name = '', currency_name = '', - adm0_code = 56, country_iso3 = '', country_name = '', - commodity_price = 1.337, - original_frequency = '', commodity_price_source_name = '', + original_frequency = '', + commodity_price = 1.337, commodity_price_observations = 56, - commodity_date_month = 56, - commodity_date_year = 56, - commodity_price_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), commodity_price_flag = '' ) else: diff --git a/test/test_xls_form_definition_new_schema_dto.py b/test/test_xls_form_definition_new_schema_dto.py index 5c7f918..05cf842 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 3432cb2..d07276e 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 5c7e965..183d1c3 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 b1bf100..5941f05 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 a52d87d..055181f 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: 6.0.0 + The version of the OpenAPI document: 7.0.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 b41b62c..fbea411 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: 6.0.0 + The version of the OpenAPI document: 7.0.0 Contact: wfp.economicanalysis@wfp.org Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/uv.lock b/uv.lock new file mode 100644 index 0000000..7518fc9 --- /dev/null +++ b/uv.lock @@ -0,0 +1,3 @@ +version = 1 +revision = 3 +requires-python = ">=3.12"