Class: ReliefWebAPI::DisastersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/reliefweb-api/api/disasters_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DisastersApi

Returns a new instance of DisastersApi.



19
20
21
 
# File 'lib/reliefweb-api/api/disasters_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/reliefweb-api/api/disasters_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_disaster_by_id(disaster_id, opts = {}) ⇒ Disaster

Find disaster by its unique ID Individual disasters

Parameters:

  • disaster_id —

    The identifier of the disaster

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :profile (String) —

    Pre-built standard selections of fields to return for ease of displaying lists or items.

  • :fields_include (Array<String>) —

    Specify which fields to include for each item. Defaults to an item label.

  • :fields_exclude (Array<String>) —

    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;.

Returns:



30
31
32
33
 
# File 'lib/reliefweb-api/api/disasters_api.rb', line 30

def get_disaster_by_id(disaster_id, opts = {})
  data, _status_code, _headers = get_disaster_by_id_with_http_info(disaster_id, opts)
  data
end

#get_disaster_by_id_with_http_info(disaster_id, opts = {}) ⇒ Array<(Disaster, Fixnum, Hash)>

Find disaster by its unique ID Individual disasters

Parameters:

  • disaster_id —

    The identifier of the disaster

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :profile (String) —

    Pre-built standard selections of fields to return for ease of displaying lists or items.

  • :fields_include (Array<String>) —

    Specify which fields to include for each item. Defaults to an item label.

  • :fields_exclude (Array<String>) —

    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;.

Returns:

  • (Array<(Disaster, Fixnum, Hash)>) —

    Disaster data, response status code and response headers



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/reliefweb-api/api/disasters_api.rb', line 43

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

#get_disasters(opts = {}) ⇒ Disaster

List or search disasters covered by ReliefWeb.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :query_value (String) —

    Specify the terms of your fuzzy search. The default is no query.

  • :query_operator (String) —

    Specify the operator by which your search query words will be combined.

  • :query_fields (Array<String>) —

    Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation.

  • :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.

  • :filter_value (Array<String>) —

    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.

  • :filter_operator (String) —

    Operator by which filters will be combined.

  • :filter_negate (BOOLEAN) —

    Reverse the filter to include those items that do not match.

  • :filter_conditions (Array<String>) —

    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.

  • :facets_field (String) —

    Field to facet by. May include dates, references or the status field.

  • :facets_name (String) —

    Identifier for resulting facet data. Useful when faceting multiple ways on the same field.

  • :facets_limit (Integer) —

    Limit the number of facets returned for non-date based facets.

  • :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;.

  • :facets_filter (Array<String>) —

    Apply all the same capabilities of the filter parameter to the specific results of this facet request.

  • :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.

  • :fields_include (Array<String>) —

    Specify which fields to include for each item. Defaults to an item label.

  • :fields_exclude (Array<String>) —

    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;.

  • :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;. (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;. (default to 0)

  • :sort (Array<String>) —

    Sort the list results. Defaults to search relevance. Values in the form of &lt;code&gt;fieldname:(asc|desc)&lt;/code&gt;.

  • :profile (String) —

    Pre-built standard selections of fields to return for ease of displaying lists or items.

  • :preset (String) —

    Pre-built standard configurations of queries, filters and sorts for common use cases.

Returns:



113
114
115
116
 
# File 'lib/reliefweb-api/api/disasters_api.rb', line 113

def get_disasters(opts = {})
  data, _status_code, _headers = get_disasters_with_http_info(opts)
  data
end

#get_disasters_with_http_info(opts = {}) ⇒ Array<(Disaster, Fixnum, Hash)>

List or search disasters covered by ReliefWeb.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :query_value (String) —

    Specify the terms of your fuzzy search. The default is no query.

  • :query_operator (String) —

    Specify the operator by which your search query words will be combined.

  • :query_fields (Array<String>) —

    Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation.

  • :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.

  • :filter_value (Array<String>) —

    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.

  • :filter_operator (String) —

    Operator by which filters will be combined.

  • :filter_negate (BOOLEAN) —

    Reverse the filter to include those items that do not match.

  • :filter_conditions (Array<String>) —

    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.

  • :facets_field (String) —

    Field to facet by. May include dates, references or the status field.

  • :facets_name (String) —

    Identifier for resulting facet data. Useful when faceting multiple ways on the same field.

  • :facets_limit (Integer) —

    Limit the number of facets returned for non-date based facets.

  • :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;.

  • :facets_filter (Array<String>) —

    Apply all the same capabilities of the filter parameter to the specific results of this facet request.

  • :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.

  • :fields_include (Array<String>) —

    Specify which fields to include for each item. Defaults to an item label.

  • :fields_exclude (Array<String>) —

    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;.

  • :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;.

  • :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;.

  • :sort (Array<String>) —

    Sort the list results. Defaults to search relevance. Values in the form of &lt;code&gt;fieldname:(asc|desc)&lt;/code&gt;.

  • :profile (String) —

    Pre-built standard selections of fields to return for ease of displaying lists or items.

  • :preset (String) —

    Pre-built standard configurations of queries, filters and sorts for common use cases.

Returns:

  • (Array<(Disaster, Fixnum, Hash)>) —

    Disaster data, response status code and response headers



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/reliefweb-api/api/disasters_api.rb', line 143

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

#search_disasters(opts = {}) ⇒ Disaster

List or search disasters covered by ReliefWeb.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



231
232
233
234
 
# File 'lib/reliefweb-api/api/disasters_api.rb', line 231

def search_disasters(opts = {})
  data, _status_code, _headers = search_disasters_with_http_info(opts)
  data
end

#search_disasters_with_http_info(opts = {}) ⇒ Array<(Disaster, Fixnum, Hash)>

List or search disasters covered by ReliefWeb.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Disaster, Fixnum, Hash)>) —

    Disaster data, response status code and response headers



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/reliefweb-api/api/disasters_api.rb', line 241

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