reliefweb-api 1.0.0

data/docs/DisastersApi.md

@@ -0,0 +1,202 @@
+# ReliefWebAPI::DisastersApi
+
+All URIs are relative to *http://api.reliefweb.int/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_disaster_by_id**](DisastersApi.md#get_disaster_by_id) | **GET** /disasters/{disasterId} | Find disaster by its unique ID
+[**get_disasters**](DisastersApi.md#get_disasters) | **GET** /disasters | List or search disasters covered by ReliefWeb. 
+[**search_disasters**](DisastersApi.md#search_disasters) | **POST** /disasters | List or search disasters covered by ReliefWeb. 
+
+
+# **get_disaster_by_id**
+> Disaster get_disaster_by_id(disaster_id, opts)
+
+Find disaster by its unique ID
+
+Individual disasters 
+
+### Example
+```ruby
+# load the gem
+require 'reliefweb-api'
+
+api_instance = ReliefWebAPI::DisastersApi.new
+
+disaster_id = 'disaster_id_example' # String | The identifier of the disaster
+
+opts = { 
+  profile: 'profile_example', # String | Pre-built standard selections of fields to return for ease of displaying lists or items. 
+  fields_include: ['fields_include_example'], # Array<String> | Specify which fields to include for each item. Defaults to an item label. 
+  fields_exclude: ['fields_exclude_example'] # Array<String> | Specify sub-fields to exclude from overall results. For example, if you include <code>date</code> you may exclude <code>date.changed</code>. 
+}
+
+begin
+  #Find disaster by its unique ID
+  result = api_instance.get_disaster_by_id(disaster_id, opts)
+  p result
+rescue ReliefWebAPI::ApiError => e
+  puts "Exception when calling DisastersApi->get_disaster_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **disaster_id** | **String**| The identifier of the disaster | 
+ **profile** | **String**| Pre-built standard selections of fields to return for ease of displaying lists or items.  | [optional] 
+ **fields_include** | [**Array&lt;String&gt;**](String.md)| Specify which fields to include for each item. Defaults to an item label.  | [optional] 
+ **fields_exclude** | [**Array&lt;String&gt;**](String.md)| 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;.  | [optional] 
+
+### Return type
+
+[**Disaster**](Disaster.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain; charset=utf-8, application/json
+ - **Accept**: application/json
+
+
+
+# **get_disasters**
+> Disaster get_disasters(opts)
+
+List or search disasters covered by ReliefWeb. 
+
+
+
+### Example
+```ruby
+# load the gem
+require 'reliefweb-api'
+
+api_instance = ReliefWebAPI::DisastersApi.new
+
+opts = { 
+  query_value: 'query_value_example', # String | Specify the terms of your fuzzy search. The default is no query. 
+  query_operator: 'query_operator_example', # String | Specify the operator by which your search query words will be combined. 
+  query_fields: ['query_fields_example'], # Array<String> | Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation. 
+  filter_field: 'filter_field_example', # String | Field to filter by. Every condition must contain either a <code>field</code> or <code>conditions</code> property. 
+  filter_value: ['filter_value_example'], # Array<String> | Value for the field being filtered. Leave blank to require existence of the field, must be present for <code>range</code> and <code>value</code> conditions. 
+  filter_operator: 'filter_operator_example', # String | Operator by which filters will be combined. 
+  filter_negate: true, # BOOLEAN | Reverse the filter to include those items that do not match. 
+  filter_conditions: ['filter_conditions_example'], # Array<String> | This property is used to combine conditions with a logical connector (the <code>operator</code> property). Every condition must contain one of the <code>field</code> or <code>conditions</code> properties. 
+  facets_field: 'facets_field_example', # String | Field to facet by. May include dates, references or the status field. 
+  facets_name: 'facets_name_example', # String | Identifier for resulting facet data. Useful when faceting multiple ways on the same field. 
+  facets_limit: 56, # Integer | Limit the number of facets returned for non-date based facets. 
+  facets_sort: 'facets_sort_example', # String | The sort order of non-date facets. Sorting may be by <code>value</code> or <code>count</code> of terms, and ascending or descending. <code>count</code> defaults to <code>desc</code>, <code>value</code> defaults to <code>asc</code>. 
+  facets_filter: ['facets_filter_example'], # Array<String> | Apply all the same capabilities of the filter parameter to the specific results of this facet request. 
+  facets_interval: 'facets_interval_example', # String | 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. 
+  fields_include: ['fields_include_example'], # Array<String> | Specify which fields to include for each item. Defaults to an item label. 
+  fields_exclude: ['fields_exclude_example'] # Array<String> | Specify sub-fields to exclude from overall results. For example, if you include <code>date</code> you may exclude <code>date.changed</code>. 
+  limit: 10, # Integer | The maximum number of items to return for a list query. The default is <code>10</code> and the maximum <code>1000</code>. 
+  offset: 0, # Integer | The offset from which to return the items in a list query. Allows paging through all results. The default is <code>0</code>. 
+  sort: ['sort_example'], # Array<String> | Sort the list results. Defaults to search relevance. Values in the form of <code>fieldname:(asc|desc)</code>. 
+  profile: 'profile_example', # String | Pre-built standard selections of fields to return for ease of displaying lists or items. 
+  preset: 'preset_example' # String | Pre-built standard configurations of queries, filters and sorts for common use cases. 
+}
+
+begin
+  #List or search disasters covered by ReliefWeb. 
+  result = api_instance.get_disasters(opts)
+  p result
+rescue ReliefWebAPI::ApiError => e
+  puts "Exception when calling DisastersApi->get_disasters: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query_value** | **String**| Specify the terms of your fuzzy search. The default is no query.  | [optional] 
+ **query_operator** | **String**| Specify the operator by which your search query words will be combined.  | [optional] 
+ **query_fields** | [**Array&lt;String&gt;**](String.md)| Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation.  | [optional] 
+ **filter_field** | **String**| 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.  | [optional] 
+ **filter_value** | [**Array&lt;String&gt;**](String.md)| 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.  | [optional] 
+ **filter_operator** | **String**| Operator by which filters will be combined.  | [optional] 
+ **filter_negate** | **BOOLEAN**| Reverse the filter to include those items that do not match.  | [optional] 
+ **filter_conditions** | [**Array&lt;String&gt;**](String.md)| 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.  | [optional] 
+ **facets_field** | **String**| Field to facet by. May include dates, references or the status field.  | [optional] 
+ **facets_name** | **String**| Identifier for resulting facet data. Useful when faceting multiple ways on the same field.  | [optional] 
+ **facets_limit** | **Integer**| Limit the number of facets returned for non-date based facets.  | [optional] 
+ **facets_sort** | **String**| 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;.  | [optional] 
+ **facets_filter** | [**Array&lt;String&gt;**](String.md)| Apply all the same capabilities of the filter parameter to the specific results of this facet request.  | [optional] 
+ **facets_interval** | **String**| 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.  | [optional] 
+ **fields_include** | [**Array&lt;String&gt;**](String.md)| Specify which fields to include for each item. Defaults to an item label.  | [optional] 
+ **fields_exclude** | [**Array&lt;String&gt;**](String.md)| 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;.  | [optional] 
+ **limit** | **Integer**| 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;.  | [optional] [default to 10]
+ **offset** | **Integer**| 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;.  | [optional] [default to 0]
+ **sort** | [**Array&lt;String&gt;**](String.md)| Sort the list results. Defaults to search relevance. Values in the form of &lt;code&gt;fieldname:(asc|desc)&lt;/code&gt;.  | [optional] 
+ **profile** | **String**| Pre-built standard selections of fields to return for ease of displaying lists or items.  | [optional] 
+ **preset** | **String**| Pre-built standard configurations of queries, filters and sorts for common use cases.  | [optional] 
+
+### Return type
+
+[**Disaster**](Disaster.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **search_disasters**
+> Disaster search_disasters(opts)
+
+List or search disasters covered by ReliefWeb. 
+
+
+
+### Example
+```ruby
+# load the gem
+require 'reliefweb-api'
+
+api_instance = ReliefWebAPI::DisastersApi.new
+
+opts = { 
+  fields: ReliefWebAPI::PostParams.new # PostParams | Returned fields
+}
+
+begin
+  #List or search disasters covered by ReliefWeb. 
+  result = api_instance.search_disasters(opts)
+  p result
+rescue ReliefWebAPI::ApiError => e
+  puts "Exception when calling DisastersApi->search_disasters: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **fields** | [**PostParams**](PostParams.md)| Returned fields | [optional] 
+
+### Return type
+
+[**Disaster**](Disaster.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/DiscoveryApi.md

@@ -0,0 +1,88 @@
+# ReliefWebAPI::DiscoveryApi
+
+All URIs are relative to *http://api.reliefweb.int/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**discovery_resources**](DiscoveryApi.md#discovery_resources) | **GET** / | 
+[**discovery_versions**](DiscoveryApi.md#discovery_versions) | **GET** /../ | 
+
+
+# **discovery_resources**
+> discovery_resources
+
+
+
+Review list of main entrypoints and top-level resources.
+
+### Example
+```ruby
+# load the gem
+require 'reliefweb-api'
+
+api_instance = ReliefWebAPI::DiscoveryApi.new
+
+begin
+  api_instance.discovery_resources
+rescue ReliefWebAPI::ApiError => e
+  puts "Exception when calling DiscoveryApi->discovery_resources: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **discovery_versions**
+> discovery_versions
+
+
+
+Review location and status of all versions.
+
+### Example
+```ruby
+# load the gem
+require 'reliefweb-api'
+
+api_instance = ReliefWebAPI::DiscoveryApi.new
+
+begin
+  api_instance.discovery_versions
+rescue ReliefWebAPI::ApiError => e
+  puts "Exception when calling DiscoveryApi->discovery_versions: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+

data/docs/Error.md

@@ -0,0 +1,9 @@
+# ReliefWebAPI::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **Integer** |  | [optional] 
+**error** | [**ErrorDefinition**](ErrorDefinition.md) |  | [optional] 
+
+

data/docs/ErrorDefinition.md

@@ -0,0 +1,7 @@
+# ReliefWebAPI::ErrorDefinition
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FacetsFieldPost.md

@@ -0,0 +1,7 @@
+# ReliefWebAPI::FacetsFieldPost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FacetsFilterPost.md

@@ -0,0 +1,7 @@
+# ReliefWebAPI::FacetsFilterPost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FacetsIntervalPost.md

@@ -0,0 +1,7 @@
+# ReliefWebAPI::FacetsIntervalPost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FacetsLimitPost.md

@@ -0,0 +1,7 @@
+# ReliefWebAPI::FacetsLimitPost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FacetsNamePost.md

@@ -0,0 +1,7 @@
+# ReliefWebAPI::FacetsNamePost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FacetsSortPost.md

@@ -0,0 +1,7 @@
+# ReliefWebAPI::FacetsSortPost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FieldsExcludePost.md

@@ -0,0 +1,7 @@
+# ReliefWebAPI::FieldsExcludePost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FieldsIncludePost.md

@@ -0,0 +1,7 @@
+# ReliefWebAPI::FieldsIncludePost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/File.md

@@ -0,0 +1,12 @@
+# ReliefWebAPI::File
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** |  | [optional] 
+**filename** | **String** |  | [optional] 
+**id** | **Integer** |  | [optional] 
+**mimetype** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

data/docs/FilterConditionsPost.md

@@ -0,0 +1,7 @@
+# ReliefWebAPI::FilterConditionsPost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FilterFieldPost.md

@@ -0,0 +1,7 @@
+# ReliefWebAPI::FilterFieldPost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FilterNegatePost.md

@@ -0,0 +1,7 @@
+# ReliefWebAPI::FilterNegatePost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FilterOperatorPost.md

@@ -0,0 +1,7 @@
+# ReliefWebAPI::FilterOperatorPost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FilterValuePost.md

@@ -0,0 +1,7 @@
+# ReliefWebAPI::FilterValuePost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/Job.md

@@ -0,0 +1,23 @@
+# ReliefWebAPI::Job
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | [**Array<Category>**](Category.md) |  | [optional] 
+**city** | [**Array<Location>**](Location.md) |  | [optional] 
+**country** | [**Array<Country>**](Country.md) |  | [optional] 
+**date** | **Date** |  | [optional] 
+**description** | **String** |  | [optional] 
+**description_html** | **String** |  | [optional] 
+**experience** | [**Array<Category>**](Category.md) |  | [optional] 
+**file** | **Array<File>** |  | [optional] 
+**how_to_apply_html** | **String** |  | [optional] 
+**how_to_apply** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**language** | [**Language**](Language.md) |  | [optional] 
+**link** | **String** |  | [optional] 
+**theme** | [**Array<Category>**](Category.md) |  | [optional] 
+**title** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+
+