reliefweb-api 1.0.0

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/reliefweb-api.rb

@@ -0,0 +1,81 @@
+=begin
+#The ReliefWeb API
+
+#Interactive API documentation for the data API of Reliefweb.int. ReliefWeb is a leading source of information on global crises and disasters.<br><br> Our continuous coverage and archive going back to the 1970s makes ReliefWeb an unparalleled resource for both current and historical data on humanitarian response.<br><br> The vast majority of content on ReliefWeb has been contributed by humanitarian partners. We owe it to the community to make data more accessible and reusable, so that developers can build tools that increase exposure for valuable content and facilitate analysis for better decisions.
+
+OpenAPI spec version: v1
+Contact: api@reliefweb.int
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+# Common files
+require 'reliefweb-api/api_client'
+require 'reliefweb-api/api_error'
+require 'reliefweb-api/version'
+require 'reliefweb-api/configuration'
+
+# Models
+require 'reliefweb-api/models/category'
+require 'reliefweb-api/models/country'
+require 'reliefweb-api/models/date'
+require 'reliefweb-api/models/disaster'
+require 'reliefweb-api/models/error'
+require 'reliefweb-api/models/error_definition'
+require 'reliefweb-api/models/facets_field_post'
+require 'reliefweb-api/models/facets_filter_post'
+require 'reliefweb-api/models/facets_interval_post'
+require 'reliefweb-api/models/facets_limit_post'
+require 'reliefweb-api/models/facets_name_post'
+require 'reliefweb-api/models/facets_sort_post'
+require 'reliefweb-api/models/fields_exclude_post'
+require 'reliefweb-api/models/fields_include_post'
+require 'reliefweb-api/models/file'
+require 'reliefweb-api/models/filter_conditions_post'
+require 'reliefweb-api/models/filter_field_post'
+require 'reliefweb-api/models/filter_negate_post'
+require 'reliefweb-api/models/filter_operator_post'
+require 'reliefweb-api/models/filter_value_post'
+require 'reliefweb-api/models/job'
+require 'reliefweb-api/models/language'
+require 'reliefweb-api/models/limit_post'
+require 'reliefweb-api/models/location'
+require 'reliefweb-api/models/offset_post'
+require 'reliefweb-api/models/post_params'
+require 'reliefweb-api/models/preset_post'
+require 'reliefweb-api/models/profile_post'
+require 'reliefweb-api/models/query_fields_post'
+require 'reliefweb-api/models/query_operator_post'
+require 'reliefweb-api/models/query_value_post'
+require 'reliefweb-api/models/report'
+require 'reliefweb-api/models/sort_post'
+require 'reliefweb-api/models/source'
+require 'reliefweb-api/models/training'
+
+# APIs
+require 'reliefweb-api/api/countries_api'
+require 'reliefweb-api/api/disasters_api'
+require 'reliefweb-api/api/discovery_api'
+require 'reliefweb-api/api/jobs_api'
+require 'reliefweb-api/api/reports_api'
+require 'reliefweb-api/api/sources_api'
+require 'reliefweb-api/api/training_api'
+
+module ReliefWebAPI
+  class << self
+    # Customize default settings for the SDK using block.
+    #   ReliefWebAPI.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/reliefweb-api/api/countries_api.rb

@@ -0,0 +1,277 @@
+=begin
+#The ReliefWeb API
+
+#Interactive API documentation for the data API of Reliefweb.int. ReliefWeb is a leading source of information on global crises and disasters.<br><br> Our continuous coverage and archive going back to the 1970s makes ReliefWeb an unparalleled resource for both current and historical data on humanitarian response.<br><br> The vast majority of content on ReliefWeb has been contributed by humanitarian partners. We owe it to the community to make data more accessible and reusable, so that developers can build tools that increase exposure for valuable content and facilitate analysis for better decisions.
+
+OpenAPI spec version: v1
+Contact: api@reliefweb.int
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'uri'
+
+module ReliefWebAPI
+  class CountriesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List or search countries covered by ReliefWeb. 
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :query_value Specify the terms of your fuzzy search. The default is no query. 
+    # @option opts [String] :query_operator Specify the operator by which your search query words will be combined. 
+    # @option opts [Array<String>] :query_fields Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation. 
+    # @option opts [String] :filter_field Field to filter by. Every condition must contain either a &lt;code&gt;field&lt;/code&gt; or &lt;code&gt;conditions&lt;/code&gt; property. 
+    # @option opts [Array<String>] :filter_value Value for the field being filtered. Leave blank to require existence of the field, must be present for &lt;code&gt;range&lt;/code&gt; and &lt;code&gt;value&lt;/code&gt; conditions. 
+    # @option opts [String] :filter_operator Operator by which filters will be combined. 
+    # @option opts [BOOLEAN] :filter_negate Reverse the filter to include those items that do not match. 
+    # @option opts [Array<String>] :filter_conditions This property is used to combine conditions with a logical connector (the &lt;code&gt;operator&lt;/code&gt; property). Every condition must contain one of the &lt;code&gt;field&lt;/code&gt; or &lt;code&gt;conditions&lt;/code&gt; properties. 
+    # @option opts [String] :facets_field Field to facet by. May include dates, references or the status field. 
+    # @option opts [String] :facets_name Identifier for resulting facet data. Useful when faceting multiple ways on the same field. 
+    # @option opts [Integer] :facets_limit Limit the number of facets returned for non-date based facets. 
+    # @option opts [String] :facets_sort The sort order of non-date facets. Sorting may be by &lt;code&gt;value&lt;/code&gt; or &lt;code&gt;count&lt;/code&gt; of terms, and ascending or descending. &lt;code&gt;count&lt;/code&gt; defaults to &lt;code&gt;desc&lt;/code&gt;, &lt;code&gt;value&lt;/code&gt; defaults to &lt;code&gt;asc&lt;/code&gt;. 
+    # @option opts [Array<String>] :facets_filter Apply all the same capabilities of the filter parameter to the specific results of this facet request. 
+    # @option opts [String] :facets_interval Round date information to the nearest interval unit. Apply all the same capabilities of the filter parameter to the specific results of this facet request. 
+    # @option opts [Array<String>] :fields_include Specify which fields to include for each item. Defaults to an item label. 
+    # @option opts [Array<String>] :fields_exclude Specify sub-fields to exclude from overall results. For example, if you include &lt;code&gt;date&lt;/code&gt; you may exclude &lt;code&gt;date.changed&lt;/code&gt;. 
+    # @option opts [Integer] :limit The maximum number of items to return for a list query. The default is &lt;code&gt;10&lt;/code&gt; and the maximum &lt;code&gt;1000&lt;/code&gt;.  (default to 10)
+    # @option opts [Integer] :offset The offset from which to return the items in a list query. Allows paging through all results. The default is &lt;code&gt;0&lt;/code&gt;.  (default to 0)
+    # @option opts [Array<String>] :sort Sort the list results. Defaults to search relevance. Values in the form of &lt;code&gt;fieldname:(asc|desc)&lt;/code&gt;. 
+    # @option opts [String] :profile Pre-built standard selections of fields to return for ease of displaying lists or items. 
+    # @option opts [String] :preset Pre-built standard configurations of queries, filters and sorts for common use cases. 
+    # @return [Country]
+    def get_countries(opts = {})
+      data, _status_code, _headers = get_countries_with_http_info(opts)
+      data
+    end
+
+    # List or search countries covered by ReliefWeb. 
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :query_value Specify the terms of your fuzzy search. The default is no query. 
+    # @option opts [String] :query_operator Specify the operator by which your search query words will be combined. 
+    # @option opts [Array<String>] :query_fields Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation. 
+    # @option opts [String] :filter_field Field to filter by. Every condition must contain either a &lt;code&gt;field&lt;/code&gt; or &lt;code&gt;conditions&lt;/code&gt; property. 
+    # @option opts [Array<String>] :filter_value Value for the field being filtered. Leave blank to require existence of the field, must be present for &lt;code&gt;range&lt;/code&gt; and &lt;code&gt;value&lt;/code&gt; conditions. 
+    # @option opts [String] :filter_operator Operator by which filters will be combined. 
+    # @option opts [BOOLEAN] :filter_negate Reverse the filter to include those items that do not match. 
+    # @option opts [Array<String>] :filter_conditions This property is used to combine conditions with a logical connector (the &lt;code&gt;operator&lt;/code&gt; property). Every condition must contain one of the &lt;code&gt;field&lt;/code&gt; or &lt;code&gt;conditions&lt;/code&gt; properties. 
+    # @option opts [String] :facets_field Field to facet by. May include dates, references or the status field. 
+    # @option opts [String] :facets_name Identifier for resulting facet data. Useful when faceting multiple ways on the same field. 
+    # @option opts [Integer] :facets_limit Limit the number of facets returned for non-date based facets. 
+    # @option opts [String] :facets_sort The sort order of non-date facets. Sorting may be by &lt;code&gt;value&lt;/code&gt; or &lt;code&gt;count&lt;/code&gt; of terms, and ascending or descending. &lt;code&gt;count&lt;/code&gt; defaults to &lt;code&gt;desc&lt;/code&gt;, &lt;code&gt;value&lt;/code&gt; defaults to &lt;code&gt;asc&lt;/code&gt;. 
+    # @option opts [Array<String>] :facets_filter Apply all the same capabilities of the filter parameter to the specific results of this facet request. 
+    # @option opts [String] :facets_interval Round date information to the nearest interval unit. Apply all the same capabilities of the filter parameter to the specific results of this facet request. 
+    # @option opts [Array<String>] :fields_include Specify which fields to include for each item. Defaults to an item label. 
+    # @option opts [Array<String>] :fields_exclude Specify sub-fields to exclude from overall results. For example, if you include &lt;code&gt;date&lt;/code&gt; you may exclude &lt;code&gt;date.changed&lt;/code&gt;. 
+    # @option opts [Integer] :limit The maximum number of items to return for a list query. The default is &lt;code&gt;10&lt;/code&gt; and the maximum &lt;code&gt;1000&lt;/code&gt;. 
+    # @option opts [Integer] :offset The offset from which to return the items in a list query. Allows paging through all results. The default is &lt;code&gt;0&lt;/code&gt;. 
+    # @option opts [Array<String>] :sort Sort the list results. Defaults to search relevance. Values in the form of &lt;code&gt;fieldname:(asc|desc)&lt;/code&gt;. 
+    # @option opts [String] :profile Pre-built standard selections of fields to return for ease of displaying lists or items. 
+    # @option opts [String] :preset Pre-built standard configurations of queries, filters and sorts for common use cases. 
+    # @return [Array<(Country, Fixnum, Hash)>] Country data, response status code and response headers
+    def get_countries_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CountriesApi.get_countries ...'
+      end
+      if @api_client.config.client_side_validation && opts[:'query_operator'] && !['AND', 'OR'].include?(opts[:'query_operator'])
+        fail ArgumentError, 'invalid value for "query_operator", must be one of AND, OR'
+      end
+      if @api_client.config.client_side_validation && opts[:'filter_operator'] && !['AND', 'OR'].include?(opts[:'filter_operator'])
+        fail ArgumentError, 'invalid value for "filter_operator", must be one of AND, OR'
+      end
+      if @api_client.config.client_side_validation && opts[:'facets_interval'] && !['year', 'month', 'week', 'day'].include?(opts[:'facets_interval'])
+        fail ArgumentError, 'invalid value for "facets_interval", must be one of year, month, week, day'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CountriesApi.get_countries, must be smaller than or equal to 1000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CountriesApi.get_countries, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling CountriesApi.get_countries, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && opts[:'profile'] && !['full', 'list', 'minimal'].include?(opts[:'profile'])
+        fail ArgumentError, 'invalid value for "profile", must be one of full, list, minimal'
+      end
+      if @api_client.config.client_side_validation && opts[:'preset'] && !['analysis', 'latest', 'minimal'].include?(opts[:'preset'])
+        fail ArgumentError, 'invalid value for "preset", must be one of analysis, latest, minimal'
+      end
+      # resource path
+      local_var_path = '/countries'
+
+      # query parameters
+      query_params = {}
+      query_params[:'query[value]'] = opts[:'query_value'] if !opts[:'query_value'].nil?
+      query_params[:'query[operator]'] = opts[:'query_operator'] if !opts[:'query_operator'].nil?
+      query_params[:'query[fields][]'] = @api_client.build_collection_param(opts[:'query_fields'], :csv) if !opts[:'query_fields'].nil?
+      query_params[:'filter[field]'] = opts[:'filter_field'] if !opts[:'filter_field'].nil?
+      query_params[:'filter[value][]'] = @api_client.build_collection_param(opts[:'filter_value'], :csv) if !opts[:'filter_value'].nil?
+      query_params[:'filter[operator]'] = opts[:'filter_operator'] if !opts[:'filter_operator'].nil?
+      query_params[:'filter[negate]'] = opts[:'filter_negate'] if !opts[:'filter_negate'].nil?
+      query_params[:'filter[conditions][]'] = @api_client.build_collection_param(opts[:'filter_conditions'], :csv) if !opts[:'filter_conditions'].nil?
+      query_params[:'facets[field]'] = opts[:'facets_field'] if !opts[:'facets_field'].nil?
+      query_params[:'facets[name]'] = opts[:'facets_name'] if !opts[:'facets_name'].nil?
+      query_params[:'facets[limit]'] = opts[:'facets_limit'] if !opts[:'facets_limit'].nil?
+      query_params[:'facets[sort]'] = opts[:'facets_sort'] if !opts[:'facets_sort'].nil?
+      query_params[:'facets[filter][]'] = @api_client.build_collection_param(opts[:'facets_filter'], :csv) if !opts[:'facets_filter'].nil?
+      query_params[:'facets[interval]'] = opts[:'facets_interval'] if !opts[:'facets_interval'].nil?
+      query_params[:'fields[include][]'] = @api_client.build_collection_param(opts[:'fields_include'], :csv) if !opts[:'fields_include'].nil?
+      query_params[:'fields[exclude][]'] = @api_client.build_collection_param(opts[:'fields_exclude'], :csv) if !opts[:'fields_exclude'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'sort[]'] = @api_client.build_collection_param(opts[:'sort'], :csv) if !opts[:'sort'].nil?
+      query_params[:'profile'] = opts[:'profile'] if !opts[:'profile'].nil?
+      query_params[:'preset'] = opts[:'preset'] if !opts[:'preset'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain; charset=utf-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Country')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CountriesApi#get_countries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Find country by its unique ID
+    # Individual countries 
+    # @param country_id The identifier of the country
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :profile Pre-built standard selections of fields to return for ease of displaying lists or items. 
+    # @option opts [Array<String>] :fields_include Specify which fields to include for each item. Defaults to an item label. 
+    # @option opts [Array<String>] :fields_exclude Specify sub-fields to exclude from overall results. For example, if you include &lt;code&gt;date&lt;/code&gt; you may exclude &lt;code&gt;date.changed&lt;/code&gt;. 
+    # @return [Country]
+    def get_country_by_id(country_id, opts = {})
+      data, _status_code, _headers = get_country_by_id_with_http_info(country_id, opts)
+      data
+    end
+
+    # Find country by its unique ID
+    # Individual countries 
+    # @param country_id The identifier of the country
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :profile Pre-built standard selections of fields to return for ease of displaying lists or items. 
+    # @option opts [Array<String>] :fields_include Specify which fields to include for each item. Defaults to an item label. 
+    # @option opts [Array<String>] :fields_exclude Specify sub-fields to exclude from overall results. For example, if you include &lt;code&gt;date&lt;/code&gt; you may exclude &lt;code&gt;date.changed&lt;/code&gt;. 
+    # @return [Array<(Country, Fixnum, Hash)>] Country data, response status code and response headers
+    def get_country_by_id_with_http_info(country_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CountriesApi.get_country_by_id ...'
+      end
+      # verify the required parameter 'country_id' is set
+      if @api_client.config.client_side_validation && country_id.nil?
+        fail ArgumentError, "Missing the required parameter 'country_id' when calling CountriesApi.get_country_by_id"
+      end
+      if @api_client.config.client_side_validation && opts[:'profile'] && !['full', 'list', 'minimal'].include?(opts[:'profile'])
+        fail ArgumentError, 'invalid value for "profile", must be one of full, list, minimal'
+      end
+      # resource path
+      local_var_path = '/countries/{countryId}'.sub('{' + 'countryId' + '}', country_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'profile'] = opts[:'profile'] if !opts[:'profile'].nil?
+      query_params[:'fields[include][]'] = @api_client.build_collection_param(opts[:'fields_include'], :csv) if !opts[:'fields_include'].nil?
+      query_params[:'fields[exclude][]'] = @api_client.build_collection_param(opts[:'fields_exclude'], :csv) if !opts[:'fields_exclude'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain; charset=utf-8', 'application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Country')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CountriesApi#get_country_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # List or search countries covered by ReliefWeb. 
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [PostParams] :fields Returned fields
+    # @return [Country]
+    def search_countries(opts = {})
+      data, _status_code, _headers = search_countries_with_http_info(opts)
+      data
+    end
+
+    # List or search countries covered by ReliefWeb. 
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [PostParams] :fields Returned fields
+    # @return [Array<(Country, Fixnum, Hash)>] Country data, response status code and response headers
+    def search_countries_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CountriesApi.search_countries ...'
+      end
+      # resource path
+      local_var_path = '/countries'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'fields'])
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Country')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CountriesApi#search_countries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/reliefweb-api/api/disasters_api.rb

@@ -0,0 +1,277 @@
+=begin
+#The ReliefWeb API
+
+#Interactive API documentation for the data API of Reliefweb.int. ReliefWeb is a leading source of information on global crises and disasters.<br><br> Our continuous coverage and archive going back to the 1970s makes ReliefWeb an unparalleled resource for both current and historical data on humanitarian response.<br><br> The vast majority of content on ReliefWeb has been contributed by humanitarian partners. We owe it to the community to make data more accessible and reusable, so that developers can build tools that increase exposure for valuable content and facilitate analysis for better decisions.
+
+OpenAPI spec version: v1
+Contact: api@reliefweb.int
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'uri'
+
+module ReliefWebAPI
+  class DisastersApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Find disaster by its unique ID
+    # Individual disasters 
+    # @param disaster_id The identifier of the disaster
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :profile Pre-built standard selections of fields to return for ease of displaying lists or items. 
+    # @option opts [Array<String>] :fields_include Specify which fields to include for each item. Defaults to an item label. 
+    # @option opts [Array<String>] :fields_exclude Specify sub-fields to exclude from overall results. For example, if you include &lt;code&gt;date&lt;/code&gt; you may exclude &lt;code&gt;date.changed&lt;/code&gt;. 
+    # @return [Disaster]
+    def get_disaster_by_id(disaster_id, opts = {})
+      data, _status_code, _headers = get_disaster_by_id_with_http_info(disaster_id, opts)
+      data
+    end
+
+    # Find disaster by its unique ID
+    # Individual disasters 
+    # @param disaster_id The identifier of the disaster
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :profile Pre-built standard selections of fields to return for ease of displaying lists or items. 
+    # @option opts [Array<String>] :fields_include Specify which fields to include for each item. Defaults to an item label. 
+    # @option opts [Array<String>] :fields_exclude Specify sub-fields to exclude from overall results. For example, if you include &lt;code&gt;date&lt;/code&gt; you may exclude &lt;code&gt;date.changed&lt;/code&gt;. 
+    # @return [Array<(Disaster, Fixnum, Hash)>] Disaster data, response status code and response headers
+    def get_disaster_by_id_with_http_info(disaster_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DisastersApi.get_disaster_by_id ...'
+      end
+      # verify the required parameter 'disaster_id' is set
+      if @api_client.config.client_side_validation && disaster_id.nil?
+        fail ArgumentError, "Missing the required parameter 'disaster_id' when calling DisastersApi.get_disaster_by_id"
+      end
+      if @api_client.config.client_side_validation && opts[:'profile'] && !['full', 'list', 'minimal'].include?(opts[:'profile'])
+        fail ArgumentError, 'invalid value for "profile", must be one of full, list, minimal'
+      end
+      # resource path
+      local_var_path = '/disasters/{disasterId}'.sub('{' + 'disasterId' + '}', disaster_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'profile'] = opts[:'profile'] if !opts[:'profile'].nil?
+      query_params[:'fields[include][]'] = @api_client.build_collection_param(opts[:'fields_include'], :csv) if !opts[:'fields_include'].nil?
+      query_params[:'fields[exclude][]'] = @api_client.build_collection_param(opts[:'fields_exclude'], :csv) if !opts[:'fields_exclude'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain; charset=utf-8', 'application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Disaster')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DisastersApi#get_disaster_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # List or search disasters covered by ReliefWeb. 
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :query_value Specify the terms of your fuzzy search. The default is no query. 
+    # @option opts [String] :query_operator Specify the operator by which your search query words will be combined. 
+    # @option opts [Array<String>] :query_fields Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation. 
+    # @option opts [String] :filter_field Field to filter by. Every condition must contain either a &lt;code&gt;field&lt;/code&gt; or &lt;code&gt;conditions&lt;/code&gt; property. 
+    # @option opts [Array<String>] :filter_value Value for the field being filtered. Leave blank to require existence of the field, must be present for &lt;code&gt;range&lt;/code&gt; and &lt;code&gt;value&lt;/code&gt; conditions. 
+    # @option opts [String] :filter_operator Operator by which filters will be combined. 
+    # @option opts [BOOLEAN] :filter_negate Reverse the filter to include those items that do not match. 
+    # @option opts [Array<String>] :filter_conditions This property is used to combine conditions with a logical connector (the &lt;code&gt;operator&lt;/code&gt; property). Every condition must contain one of the &lt;code&gt;field&lt;/code&gt; or &lt;code&gt;conditions&lt;/code&gt; properties. 
+    # @option opts [String] :facets_field Field to facet by. May include dates, references or the status field. 
+    # @option opts [String] :facets_name Identifier for resulting facet data. Useful when faceting multiple ways on the same field. 
+    # @option opts [Integer] :facets_limit Limit the number of facets returned for non-date based facets. 
+    # @option opts [String] :facets_sort The sort order of non-date facets. Sorting may be by &lt;code&gt;value&lt;/code&gt; or &lt;code&gt;count&lt;/code&gt; of terms, and ascending or descending. &lt;code&gt;count&lt;/code&gt; defaults to &lt;code&gt;desc&lt;/code&gt;, &lt;code&gt;value&lt;/code&gt; defaults to &lt;code&gt;asc&lt;/code&gt;. 
+    # @option opts [Array<String>] :facets_filter Apply all the same capabilities of the filter parameter to the specific results of this facet request. 
+    # @option opts [String] :facets_interval Round date information to the nearest interval unit. Apply all the same capabilities of the filter parameter to the specific results of this facet request. 
+    # @option opts [Array<String>] :fields_include Specify which fields to include for each item. Defaults to an item label. 
+    # @option opts [Array<String>] :fields_exclude Specify sub-fields to exclude from overall results. For example, if you include &lt;code&gt;date&lt;/code&gt; you may exclude &lt;code&gt;date.changed&lt;/code&gt;. 
+    # @option opts [Integer] :limit The maximum number of items to return for a list query. The default is &lt;code&gt;10&lt;/code&gt; and the maximum &lt;code&gt;1000&lt;/code&gt;.  (default to 10)
+    # @option opts [Integer] :offset The offset from which to return the items in a list query. Allows paging through all results. The default is &lt;code&gt;0&lt;/code&gt;.  (default to 0)
+    # @option opts [Array<String>] :sort Sort the list results. Defaults to search relevance. Values in the form of &lt;code&gt;fieldname:(asc|desc)&lt;/code&gt;. 
+    # @option opts [String] :profile Pre-built standard selections of fields to return for ease of displaying lists or items. 
+    # @option opts [String] :preset Pre-built standard configurations of queries, filters and sorts for common use cases. 
+    # @return [Disaster]
+    def get_disasters(opts = {})
+      data, _status_code, _headers = get_disasters_with_http_info(opts)
+      data
+    end
+
+    # List or search disasters covered by ReliefWeb. 
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :query_value Specify the terms of your fuzzy search. The default is no query. 
+    # @option opts [String] :query_operator Specify the operator by which your search query words will be combined. 
+    # @option opts [Array<String>] :query_fields Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation. 
+    # @option opts [String] :filter_field Field to filter by. Every condition must contain either a &lt;code&gt;field&lt;/code&gt; or &lt;code&gt;conditions&lt;/code&gt; property. 
+    # @option opts [Array<String>] :filter_value Value for the field being filtered. Leave blank to require existence of the field, must be present for &lt;code&gt;range&lt;/code&gt; and &lt;code&gt;value&lt;/code&gt; conditions. 
+    # @option opts [String] :filter_operator Operator by which filters will be combined. 
+    # @option opts [BOOLEAN] :filter_negate Reverse the filter to include those items that do not match. 
+    # @option opts [Array<String>] :filter_conditions This property is used to combine conditions with a logical connector (the &lt;code&gt;operator&lt;/code&gt; property). Every condition must contain one of the &lt;code&gt;field&lt;/code&gt; or &lt;code&gt;conditions&lt;/code&gt; properties. 
+    # @option opts [String] :facets_field Field to facet by. May include dates, references or the status field. 
+    # @option opts [String] :facets_name Identifier for resulting facet data. Useful when faceting multiple ways on the same field. 
+    # @option opts [Integer] :facets_limit Limit the number of facets returned for non-date based facets. 
+    # @option opts [String] :facets_sort The sort order of non-date facets. Sorting may be by &lt;code&gt;value&lt;/code&gt; or &lt;code&gt;count&lt;/code&gt; of terms, and ascending or descending. &lt;code&gt;count&lt;/code&gt; defaults to &lt;code&gt;desc&lt;/code&gt;, &lt;code&gt;value&lt;/code&gt; defaults to &lt;code&gt;asc&lt;/code&gt;. 
+    # @option opts [Array<String>] :facets_filter Apply all the same capabilities of the filter parameter to the specific results of this facet request. 
+    # @option opts [String] :facets_interval Round date information to the nearest interval unit. Apply all the same capabilities of the filter parameter to the specific results of this facet request. 
+    # @option opts [Array<String>] :fields_include Specify which fields to include for each item. Defaults to an item label. 
+    # @option opts [Array<String>] :fields_exclude Specify sub-fields to exclude from overall results. For example, if you include &lt;code&gt;date&lt;/code&gt; you may exclude &lt;code&gt;date.changed&lt;/code&gt;. 
+    # @option opts [Integer] :limit The maximum number of items to return for a list query. The default is &lt;code&gt;10&lt;/code&gt; and the maximum &lt;code&gt;1000&lt;/code&gt;. 
+    # @option opts [Integer] :offset The offset from which to return the items in a list query. Allows paging through all results. The default is &lt;code&gt;0&lt;/code&gt;. 
+    # @option opts [Array<String>] :sort Sort the list results. Defaults to search relevance. Values in the form of &lt;code&gt;fieldname:(asc|desc)&lt;/code&gt;. 
+    # @option opts [String] :profile Pre-built standard selections of fields to return for ease of displaying lists or items. 
+    # @option opts [String] :preset Pre-built standard configurations of queries, filters and sorts for common use cases. 
+    # @return [Array<(Disaster, Fixnum, Hash)>] Disaster data, response status code and response headers
+    def get_disasters_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DisastersApi.get_disasters ...'
+      end
+      if @api_client.config.client_side_validation && opts[:'query_operator'] && !['AND', 'OR'].include?(opts[:'query_operator'])
+        fail ArgumentError, 'invalid value for "query_operator", must be one of AND, OR'
+      end
+      if @api_client.config.client_side_validation && opts[:'filter_operator'] && !['AND', 'OR'].include?(opts[:'filter_operator'])
+        fail ArgumentError, 'invalid value for "filter_operator", must be one of AND, OR'
+      end
+      if @api_client.config.client_side_validation && opts[:'facets_interval'] && !['year', 'month', 'week', 'day'].include?(opts[:'facets_interval'])
+        fail ArgumentError, 'invalid value for "facets_interval", must be one of year, month, week, day'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DisastersApi.get_disasters, must be smaller than or equal to 1000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DisastersApi.get_disasters, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling DisastersApi.get_disasters, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && opts[:'profile'] && !['full', 'list', 'minimal'].include?(opts[:'profile'])
+        fail ArgumentError, 'invalid value for "profile", must be one of full, list, minimal'
+      end
+      if @api_client.config.client_side_validation && opts[:'preset'] && !['analysis', 'latest', 'minimal'].include?(opts[:'preset'])
+        fail ArgumentError, 'invalid value for "preset", must be one of analysis, latest, minimal'
+      end
+      # resource path
+      local_var_path = '/disasters'
+
+      # query parameters
+      query_params = {}
+      query_params[:'query[value]'] = opts[:'query_value'] if !opts[:'query_value'].nil?
+      query_params[:'query[operator]'] = opts[:'query_operator'] if !opts[:'query_operator'].nil?
+      query_params[:'query[fields][]'] = @api_client.build_collection_param(opts[:'query_fields'], :csv) if !opts[:'query_fields'].nil?
+      query_params[:'filter[field]'] = opts[:'filter_field'] if !opts[:'filter_field'].nil?
+      query_params[:'filter[value][]'] = @api_client.build_collection_param(opts[:'filter_value'], :csv) if !opts[:'filter_value'].nil?
+      query_params[:'filter[operator]'] = opts[:'filter_operator'] if !opts[:'filter_operator'].nil?
+      query_params[:'filter[negate]'] = opts[:'filter_negate'] if !opts[:'filter_negate'].nil?
+      query_params[:'filter[conditions][]'] = @api_client.build_collection_param(opts[:'filter_conditions'], :csv) if !opts[:'filter_conditions'].nil?
+      query_params[:'facets[field]'] = opts[:'facets_field'] if !opts[:'facets_field'].nil?
+      query_params[:'facets[name]'] = opts[:'facets_name'] if !opts[:'facets_name'].nil?
+      query_params[:'facets[limit]'] = opts[:'facets_limit'] if !opts[:'facets_limit'].nil?
+      query_params[:'facets[sort]'] = opts[:'facets_sort'] if !opts[:'facets_sort'].nil?
+      query_params[:'facets[filter][]'] = @api_client.build_collection_param(opts[:'facets_filter'], :csv) if !opts[:'facets_filter'].nil?
+      query_params[:'facets[interval]'] = opts[:'facets_interval'] if !opts[:'facets_interval'].nil?
+      query_params[:'fields[include][]'] = @api_client.build_collection_param(opts[:'fields_include'], :csv) if !opts[:'fields_include'].nil?
+      query_params[:'fields[exclude][]'] = @api_client.build_collection_param(opts[:'fields_exclude'], :csv) if !opts[:'fields_exclude'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'sort[]'] = @api_client.build_collection_param(opts[:'sort'], :csv) if !opts[:'sort'].nil?
+      query_params[:'profile'] = opts[:'profile'] if !opts[:'profile'].nil?
+      query_params[:'preset'] = opts[:'preset'] if !opts[:'preset'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain; charset=utf-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Disaster')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DisastersApi#get_disasters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # List or search disasters covered by ReliefWeb. 
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [PostParams] :fields Returned fields
+    # @return [Disaster]
+    def search_disasters(opts = {})
+      data, _status_code, _headers = search_disasters_with_http_info(opts)
+      data
+    end
+
+    # List or search disasters covered by ReliefWeb. 
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [PostParams] :fields Returned fields
+    # @return [Array<(Disaster, Fixnum, Hash)>] Disaster data, response status code and response headers
+    def search_disasters_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DisastersApi.search_disasters ...'
+      end
+      # resource path
+      local_var_path = '/disasters'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'fields'])
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Disaster')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DisastersApi#search_disasters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end