Class: Algolia::IngestionClient

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/api/ingestion_client.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = nil) ⇒ IngestionClient

Returns a new instance of IngestionClient.



7
8
9
10
11
12
13
 
# File 'lib/algolia/api/ingestion_client.rb', line 7

def initialize(config = nil)
  raise '`config` is missing.' if config.nil?
  raise '`app_id` is missing.' if config.app_id.nil? || config.app_id == ''
  raise '`api_key` is missing.' if config.api_key.nil? || config.api_key == ''

  @api_client = Algolia::ApiClient.new(config)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/algolia/api/ingestion_client.rb', line 5

def api_client
  @api_client
end

Class Method Details

.create(app_id, api_key, region = nil, opts = {}) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/algolia/api/ingestion_client.rb', line 15

def self.create(app_id, api_key, region = nil, opts = {})
  hosts = []
  regions = ['eu', 'us']

  if region.is_a?(Hash) && (opts.nil? || opts.empty?)
    opts = region
    region = nil
  end

  raise "`region` is required and must be one of the following: #{regions.join(', ')}" if region.nil? || !region.is_a?(String) || !regions.include?(region)

  hosts << Transport::StatefulHost.new('data.{region}.algolia.com'.sub!('{region}', region), accept: CallType::READ | CallType::WRITE)

  config = Algolia::Configuration.new(app_id, api_key, hosts, 'Ingestion', opts)
  create_with_config(config)
end

.create_with_config(config) ⇒ Object 



32
33
34
 
# File 'lib/algolia/api/ingestion_client.rb', line 32

def self.create_with_config(config)
  new(config)
end

Instance Method Details

#create_authentication(authentication_create, request_options = {}) ⇒ AuthenticationCreateResponse

Creates a new authentication resource.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • authentication_create (AuthenticationCreate) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (AuthenticationCreateResponse) 


79
80
81
82
 
# File 'lib/algolia/api/ingestion_client.rb', line 79

def create_authentication(authentication_create, request_options = {})
  response = create_authentication_with_http_info(authentication_create, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::AuthenticationCreateResponse')
end

#create_authentication_with_http_info(authentication_create, request_options = {}) ⇒ Http::Response

Creates a new authentication resource.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • authentication_create (AuthenticationCreate) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/algolia/api/ingestion_client.rb', line 45

def create_authentication_with_http_info(authentication_create, request_options = {})
  # verify the required parameter 'authentication_create' is set
  if @api_client.config.client_side_validation && authentication_create.nil?
    raise ArgumentError, "Parameter `authentication_create` is required when calling `create_authentication`."
  end

  path = '/1/authentications'
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(authentication_create)

  new_options = request_options.merge(
    :operation => :'IngestionClient.create_authentication',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#create_destination(destination_create, request_options = {}) ⇒ DestinationCreateResponse

Creates a new destination.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • destination_create (DestinationCreate) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (DestinationCreateResponse) 


127
128
129
130
 
# File 'lib/algolia/api/ingestion_client.rb', line 127

def create_destination(destination_create, request_options = {})
  response = create_destination_with_http_info(destination_create, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DestinationCreateResponse')
end

#create_destination_with_http_info(destination_create, request_options = {}) ⇒ Http::Response

Creates a new destination.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • destination_create (DestinationCreate) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/algolia/api/ingestion_client.rb', line 93

def create_destination_with_http_info(destination_create, request_options = {})
  # verify the required parameter 'destination_create' is set
  if @api_client.config.client_side_validation && destination_create.nil?
    raise ArgumentError, "Parameter `destination_create` is required when calling `create_destination`."
  end

  path = '/1/destinations'
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(destination_create)

  new_options = request_options.merge(
    :operation => :'IngestionClient.create_destination',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#create_source(source_create, request_options = {}) ⇒ SourceCreateResponse

Creates a new source.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_create (SourceCreate) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (SourceCreateResponse) 


175
176
177
178
 
# File 'lib/algolia/api/ingestion_client.rb', line 175

def create_source(source_create, request_options = {})
  response = create_source_with_http_info(source_create, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::SourceCreateResponse')
end

#create_source_with_http_info(source_create, request_options = {}) ⇒ Http::Response

Creates a new source.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_create (SourceCreate) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/algolia/api/ingestion_client.rb', line 141

def create_source_with_http_info(source_create, request_options = {})
  # verify the required parameter 'source_create' is set
  if @api_client.config.client_side_validation && source_create.nil?
    raise ArgumentError, "Parameter `source_create` is required when calling `create_source`."
  end

  path = '/1/sources'
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(source_create)

  new_options = request_options.merge(
    :operation => :'IngestionClient.create_source',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#create_task(task_create, request_options = {}) ⇒ TaskCreateResponse

Parameters:

  • task_create (TaskCreate) —

    Request body for creating a task. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (TaskCreateResponse) 


215
216
217
218
 
# File 'lib/algolia/api/ingestion_client.rb', line 215

def create_task(task_create, request_options = {})
  response = create_task_with_http_info(task_create, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskCreateResponse')
end

#create_task_with_http_info(task_create, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • task_create (TaskCreate) —

    Request body for creating a task. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/algolia/api/ingestion_client.rb', line 185

def create_task_with_http_info(task_create, request_options = {})
  # verify the required parameter 'task_create' is set
  if @api_client.config.client_side_validation && task_create.nil?
    raise ArgumentError, "Parameter `task_create` is required when calling `create_task`."
  end

  path = '/1/tasks'
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(task_create)

  new_options = request_options.merge(
    :operation => :'IngestionClient.create_task',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#custom_delete(path, parameters = nil, request_options = {}) ⇒ Object

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Object) 


258
259
260
261
 
# File 'lib/algolia/api/ingestion_client.rb', line 258

def custom_delete(path, parameters = nil, request_options = {})
  response = custom_delete_with_http_info(path, parameters, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
end

#custom_delete_with_http_info(path, parameters = nil, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/algolia/api/ingestion_client.rb', line 226

def custom_delete_with_http_info(path, parameters = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
  end

  path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.custom_delete',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#custom_get(path, parameters = nil, request_options = {}) ⇒ Object

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Object) 


301
302
303
304
 
# File 'lib/algolia/api/ingestion_client.rb', line 301

def custom_get(path, parameters = nil, request_options = {})
  response = custom_get_with_http_info(path, parameters, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
end

#custom_get_with_http_info(path, parameters = nil, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/algolia/api/ingestion_client.rb', line 269

def custom_get_with_http_info(path, parameters = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
  end

  path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.custom_get',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#custom_post(path, parameters = nil, body = nil, request_options = {}) ⇒ Object

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • body (Object) (defaults to: nil) —

    Parameters to send with the custom request.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Object) 


346
347
348
349
 
# File 'lib/algolia/api/ingestion_client.rb', line 346

def custom_post(path, parameters = nil, body = nil, request_options = {})
  response = custom_post_with_http_info(path, parameters, body, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
end

#custom_post_with_http_info(path, parameters = nil, body = nil, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • body (Object) (defaults to: nil) —

    Parameters to send with the custom request.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/algolia/api/ingestion_client.rb', line 313

def custom_post_with_http_info(path, parameters = nil, body = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
  end

  path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)

  new_options = request_options.merge(
    :operation => :'IngestionClient.custom_post',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#custom_put(path, parameters = nil, body = nil, request_options = {}) ⇒ Object

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • body (Object) (defaults to: nil) —

    Parameters to send with the custom request.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Object) 


391
392
393
394
 
# File 'lib/algolia/api/ingestion_client.rb', line 391

def custom_put(path, parameters = nil, body = nil, request_options = {})
  response = custom_put_with_http_info(path, parameters, body, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Object')
end

#custom_put_with_http_info(path, parameters = nil, body = nil, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • path (String) —

    Path of the endpoint, anything after &quot;/1&quot; must be specified. (required)

  • parameters (Hash<String, Object>) (defaults to: nil) —

    Query parameters to apply to the current query.

  • body (Object) (defaults to: nil) —

    Parameters to send with the custom request.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/algolia/api/ingestion_client.rb', line 358

def custom_put_with_http_info(path, parameters = nil, body = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
  end

  path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)

  new_options = request_options.merge(
    :operation => :'IngestionClient.custom_put',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PUT, path, new_options)
end

#delete_authentication(authentication_id, request_options = {}) ⇒ DeleteResponse

Deletes an authentication resource. You can’t delete authentication resources that are used by a source or a destination.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • authentication_id (String) —

    Unique identifier of an authentication resource. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (DeleteResponse) 


439
440
441
442
 
# File 'lib/algolia/api/ingestion_client.rb', line 439

def delete_authentication(authentication_id, request_options = {})
  response = delete_authentication_with_http_info(authentication_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
end

#delete_authentication_with_http_info(authentication_id, request_options = {}) ⇒ Http::Response

Deletes an authentication resource. You can&#39;t delete authentication resources that are used by a source or a destination.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • authentication_id (String) —

    Unique identifier of an authentication resource. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/algolia/api/ingestion_client.rb', line 405

def delete_authentication_with_http_info(authentication_id, request_options = {})
  # verify the required parameter 'authentication_id' is set
  if @api_client.config.client_side_validation && authentication_id.nil?
    raise ArgumentError, "Parameter `authentication_id` is required when calling `delete_authentication`."
  end

  path = '/1/authentications/{authenticationID}'.sub('{' + 'authenticationID' + '}', Transport.encode_uri(authentication_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.delete_authentication',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#delete_destination(destination_id, request_options = {}) ⇒ DeleteResponse

Deletes a destination by its ID. You can’t delete destinations that are referenced in tasks.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • destination_id (String) —

    Unique identifier of a destination. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (DeleteResponse) 


487
488
489
490
 
# File 'lib/algolia/api/ingestion_client.rb', line 487

def delete_destination(destination_id, request_options = {})
  response = delete_destination_with_http_info(destination_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
end

#delete_destination_with_http_info(destination_id, request_options = {}) ⇒ Http::Response

Deletes a destination by its ID. You can&#39;t delete destinations that are referenced in tasks.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • destination_id (String) —

    Unique identifier of a destination. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/algolia/api/ingestion_client.rb', line 453

def delete_destination_with_http_info(destination_id, request_options = {})
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    raise ArgumentError, "Parameter `destination_id` is required when calling `delete_destination`."
  end

  path = '/1/destinations/{destinationID}'.sub('{' + 'destinationID' + '}', Transport.encode_uri(destination_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.delete_destination',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#delete_source(source_id, request_options = {}) ⇒ DeleteResponse

Deletes a source by its ID. You can’t delete sources that are referenced in tasks.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (DeleteResponse) 


535
536
537
538
 
# File 'lib/algolia/api/ingestion_client.rb', line 535

def delete_source(source_id, request_options = {})
  response = delete_source_with_http_info(source_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
end

#delete_source_with_http_info(source_id, request_options = {}) ⇒ Http::Response

Deletes a source by its ID. You can&#39;t delete sources that are referenced in tasks.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/algolia/api/ingestion_client.rb', line 501

def delete_source_with_http_info(source_id, request_options = {})
  # verify the required parameter 'source_id' is set
  if @api_client.config.client_side_validation && source_id.nil?
    raise ArgumentError, "Parameter `source_id` is required when calling `delete_source`."
  end

  path = '/1/sources/{sourceID}'.sub('{' + 'sourceID' + '}', Transport.encode_uri(source_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.delete_source',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#delete_task(task_id, request_options = {}) ⇒ DeleteResponse

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (DeleteResponse) 


575
576
577
578
 
# File 'lib/algolia/api/ingestion_client.rb', line 575

def delete_task(task_id, request_options = {})
  response = delete_task_with_http_info(task_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DeleteResponse')
end

#delete_task_with_http_info(task_id, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/algolia/api/ingestion_client.rb', line 545

def delete_task_with_http_info(task_id, request_options = {})
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    raise ArgumentError, "Parameter `task_id` is required when calling `delete_task`."
  end

  path = '/1/tasks/{taskID}'.sub('{' + 'taskID' + '}', Transport.encode_uri(task_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.delete_task',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#disable_task(task_id, request_options = {}) ⇒ TaskUpdateResponse

Disables a task.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (TaskUpdateResponse) 


623
624
625
626
 
# File 'lib/algolia/api/ingestion_client.rb', line 623

def disable_task(task_id, request_options = {})
  response = disable_task_with_http_info(task_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskUpdateResponse')
end

#disable_task_with_http_info(task_id, request_options = {}) ⇒ Http::Response

Disables a task.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/algolia/api/ingestion_client.rb', line 589

def disable_task_with_http_info(task_id, request_options = {})
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    raise ArgumentError, "Parameter `task_id` is required when calling `disable_task`."
  end

  path = '/1/tasks/{taskID}/disable'.sub('{' + 'taskID' + '}', Transport.encode_uri(task_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.disable_task',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PUT, path, new_options)
end

#enable_task(task_id, request_options = {}) ⇒ TaskUpdateResponse

Enables a task.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (TaskUpdateResponse) 


671
672
673
674
 
# File 'lib/algolia/api/ingestion_client.rb', line 671

def enable_task(task_id, request_options = {})
  response = enable_task_with_http_info(task_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskUpdateResponse')
end

#enable_task_with_http_info(task_id, request_options = {}) ⇒ Http::Response

Enables a task.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/algolia/api/ingestion_client.rb', line 637

def enable_task_with_http_info(task_id, request_options = {})
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    raise ArgumentError, "Parameter `task_id` is required when calling `enable_task`."
  end

  path = '/1/tasks/{taskID}/enable'.sub('{' + 'taskID' + '}', Transport.encode_uri(task_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.enable_task',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PUT, path, new_options)
end

#get_authentication(authentication_id, request_options = {}) ⇒ Authentication

Retrieves an authentication resource by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • authentication_id (String) —

    Unique identifier of an authentication resource. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Authentication) 


719
720
721
722
 
# File 'lib/algolia/api/ingestion_client.rb', line 719

def get_authentication(authentication_id, request_options = {})
  response = get_authentication_with_http_info(authentication_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Authentication')
end

#get_authentication_with_http_info(authentication_id, request_options = {}) ⇒ Http::Response

Retrieves an authentication resource by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • authentication_id (String) —

    Unique identifier of an authentication resource. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/algolia/api/ingestion_client.rb', line 685

def get_authentication_with_http_info(authentication_id, request_options = {})
  # verify the required parameter 'authentication_id' is set
  if @api_client.config.client_side_validation && authentication_id.nil?
    raise ArgumentError, "Parameter `authentication_id` is required when calling `get_authentication`."
  end

  path = '/1/authentications/{authenticationID}'.sub('{' + 'authenticationID' + '}', Transport.encode_uri(authentication_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.get_authentication',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_authentications(items_per_page = nil, page = nil, type = nil, platform = nil, sort = nil, order = nil, request_options = {}) ⇒ ListAuthenticationsResponse

Retrieves a list of all authentication resources.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • items_per_page (Integer) (defaults to: nil) —

    Number of items per page. (default to 10)

  • page (Integer) (defaults to: nil) —

    Page number of the paginated API response.

  • type (Array<AuthenticationType>) (defaults to: nil) —

    Type of authentication resource to retrieve.

  • platform (Array<PlatformWithNone>) (defaults to: nil) —

    Ecommerce platform for which to retrieve authentication resources.

  • sort (AuthenticationSortKeys) (defaults to: nil) —

    Property by which to sort the list of authentication resources. (default to ‘createdAt’)

  • order (OrderKeys) (defaults to: nil) —

    Sort order of the response, ascending or descending. (default to ‘desc’)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (ListAuthenticationsResponse) 


790
791
792
793
 
# File 'lib/algolia/api/ingestion_client.rb', line 790

def get_authentications(items_per_page = nil, page = nil, type = nil, platform = nil, sort = nil, order = nil, request_options = {})
  response = get_authentications_with_http_info(items_per_page, page, type, platform, sort, order, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListAuthenticationsResponse')
end

#get_authentications_with_http_info(items_per_page = nil, page = nil, type = nil, platform = nil, sort = nil, order = nil, request_options = {}) ⇒ Http::Response

Retrieves a list of all authentication resources.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • items_per_page (Integer) (defaults to: nil) —

    Number of items per page. (default to 10)

  • page (Integer) (defaults to: nil) —

    Page number of the paginated API response.

  • type (Array<AuthenticationType>) (defaults to: nil) —

    Type of authentication resource to retrieve.

  • platform (Array<PlatformWithNone>) (defaults to: nil) —

    Ecommerce platform for which to retrieve authentication resources.

  • sort (AuthenticationSortKeys) (defaults to: nil) —

    Property by which to sort the list of authentication resources. (default to ‘createdAt’)

  • order (OrderKeys) (defaults to: nil) —

    Sort order of the response, ascending or descending. (default to ‘desc’)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/algolia/api/ingestion_client.rb', line 738

def get_authentications_with_http_info(items_per_page = nil, page = nil, type = nil, platform = nil, sort = nil, order = nil, request_options = {})
  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
    raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_authentications, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
    raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_authentications, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !page.nil? && page < 1
    raise ArgumentError, 'invalid value for ""page"" when calling IngestionClient.get_authentications, must be greater than or equal to 1.'
  end

  path = '/1/authentications'
  query_params = {}
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
  query_params[:page] = page unless page.nil?
  query_params[:type] = @api_client.build_collection_param(type, :csv) unless type.nil?
  query_params[:platform] = @api_client.build_collection_param(platform, :csv) unless platform.nil?
  query_params[:sort] = sort unless sort.nil?
  query_params[:order] = order unless order.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.get_authentications',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_destination(destination_id, request_options = {}) ⇒ Destination

Retrieves a destination by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • destination_id (String) —

    Unique identifier of a destination. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Destination) 


838
839
840
841
 
# File 'lib/algolia/api/ingestion_client.rb', line 838

def get_destination(destination_id, request_options = {})
  response = get_destination_with_http_info(destination_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Destination')
end

#get_destination_with_http_info(destination_id, request_options = {}) ⇒ Http::Response

Retrieves a destination by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • destination_id (String) —

    Unique identifier of a destination. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'lib/algolia/api/ingestion_client.rb', line 804

def get_destination_with_http_info(destination_id, request_options = {})
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    raise ArgumentError, "Parameter `destination_id` is required when calling `get_destination`."
  end

  path = '/1/destinations/{destinationID}'.sub('{' + 'destinationID' + '}', Transport.encode_uri(destination_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.get_destination',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_destinations(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {}) ⇒ ListDestinationsResponse

Retrieves a list of destinations.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • items_per_page (Integer) (defaults to: nil) —

    Number of items per page. (default to 10)

  • page (Integer) (defaults to: nil) —

    Page number of the paginated API response.

  • type (Array<DestinationType>) (defaults to: nil) —

    Destination type.

  • authentication_id (Array<String>) (defaults to: nil) —

    Authentication ID used by destinations.

  • sort (DestinationSortKeys) (defaults to: nil) —

    Property by which to sort the destinations. (default to ‘createdAt’)

  • order (OrderKeys) (defaults to: nil) —

    Sort order of the response, ascending or descending. (default to ‘desc’)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (ListDestinationsResponse) 


909
910
911
912
 
# File 'lib/algolia/api/ingestion_client.rb', line 909

def get_destinations(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {})
  response = get_destinations_with_http_info(items_per_page, page, type, authentication_id, sort, order, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListDestinationsResponse')
end

#get_destinations_with_http_info(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {}) ⇒ Http::Response

Retrieves a list of destinations.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • items_per_page (Integer) (defaults to: nil) —

    Number of items per page. (default to 10)

  • page (Integer) (defaults to: nil) —

    Page number of the paginated API response.

  • type (Array<DestinationType>) (defaults to: nil) —

    Destination type.

  • authentication_id (Array<String>) (defaults to: nil) —

    Authentication ID used by destinations.

  • sort (DestinationSortKeys) (defaults to: nil) —

    Property by which to sort the destinations. (default to ‘createdAt’)

  • order (OrderKeys) (defaults to: nil) —

    Sort order of the response, ascending or descending. (default to ‘desc’)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
 
# File 'lib/algolia/api/ingestion_client.rb', line 857

def get_destinations_with_http_info(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {})
  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
    raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_destinations, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
    raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_destinations, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !page.nil? && page < 1
    raise ArgumentError, 'invalid value for ""page"" when calling IngestionClient.get_destinations, must be greater than or equal to 1.'
  end

  path = '/1/destinations'
  query_params = {}
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
  query_params[:page] = page unless page.nil?
  query_params[:type] = @api_client.build_collection_param(type, :csv) unless type.nil?
  query_params[:authenticationID] = @api_client.build_collection_param(authentication_id, :csv) unless authentication_id.nil?
  query_params[:sort] = sort unless sort.nil?
  query_params[:order] = order unless order.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.get_destinations',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_docker_source_streams(source_id, request_options = {}) ⇒ DockerSourceStreams

Retrieves a stream listing for a source. Listing streams only works with sources with ‘type: docker` and `imageType: singer`.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (DockerSourceStreams) 


957
958
959
960
 
# File 'lib/algolia/api/ingestion_client.rb', line 957

def get_docker_source_streams(source_id, request_options = {})
  response = get_docker_source_streams_with_http_info(source_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DockerSourceStreams')
end

#get_docker_source_streams_with_http_info(source_id, request_options = {}) ⇒ Http::Response

Retrieves a stream listing for a source. Listing streams only works with sources with &#x60;type: docker&#x60; and &#x60;imageType: singer&#x60;.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
 
# File 'lib/algolia/api/ingestion_client.rb', line 923

def get_docker_source_streams_with_http_info(source_id, request_options = {})
  # verify the required parameter 'source_id' is set
  if @api_client.config.client_side_validation && source_id.nil?
    raise ArgumentError, "Parameter `source_id` is required when calling `get_docker_source_streams`."
  end

  path = '/1/sources/{sourceID}/discover'.sub('{' + 'sourceID' + '}', Transport.encode_uri(source_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.get_docker_source_streams',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_event(run_id, event_id, request_options = {}) ⇒ Event

Retrieves a single task run event by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • run_id (String) —

    Unique identifier of a task run. (required)

  • event_id (String) —

    Unique identifier of an event. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Event) 


1011
1012
1013
1014
 
# File 'lib/algolia/api/ingestion_client.rb', line 1011

def get_event(run_id, event_id, request_options = {})
  response = get_event_with_http_info(run_id, event_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Event')
end

#get_event_with_http_info(run_id, event_id, request_options = {}) ⇒ Http::Response

Retrieves a single task run event by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • run_id (String) —

    Unique identifier of a task run. (required)

  • event_id (String) —

    Unique identifier of an event. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
 
# File 'lib/algolia/api/ingestion_client.rb', line 972

def get_event_with_http_info(run_id, event_id, request_options = {})
  # verify the required parameter 'run_id' is set
  if @api_client.config.client_side_validation && run_id.nil?
    raise ArgumentError, "Parameter `run_id` is required when calling `get_event`."
  end
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    raise ArgumentError, "Parameter `event_id` is required when calling `get_event`."
  end

  path = '/1/runs/{runID}/events/{eventID}'.sub('{' + 'runID' + '}', Transport.encode_uri(run_id.to_s)).sub('{' + 'eventID' + '}', Transport.encode_uri(event_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.get_event',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_events(run_id, items_per_page = nil, page = nil, status = nil, type = nil, sort = nil, order = nil, start_date = nil, end_date = nil, request_options = {}) ⇒ ListEventsResponse

Retrieves a list of events for a task run, identified by it’s ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • run_id (String) —

    Unique identifier of a task run. (required)

  • items_per_page (Integer) (defaults to: nil) —

    Number of items per page. (default to 10)

  • page (Integer) (defaults to: nil) —

    Page number of the paginated API response.

  • status (Array<EventStatus>) (defaults to: nil) —

    Event status for filtering the list of task runs.

  • type (Array<EventType>) (defaults to: nil) —

    Event type for filtering the list of task runs.

  • sort (EventSortKeys) (defaults to: nil) —

    Property by which to sort the list of task run events.

  • order (OrderKeys) (defaults to: nil) —

    Sort order of the response, ascending or descending. (default to ‘desc’)

  • start_date (String) (defaults to: nil) —

    Date and time in RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.

  • end_date (String) (defaults to: nil) —

    Date and time in RFC3339 format for the latest events to retrieve. By default, the current time is used.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (ListEventsResponse) 


1095
1096
1097
1098
 
# File 'lib/algolia/api/ingestion_client.rb', line 1095

def get_events(run_id, items_per_page = nil, page = nil, status = nil, type = nil, sort = nil, order = nil, start_date = nil, end_date = nil, request_options = {})
  response = get_events_with_http_info(run_id, items_per_page, page, status, type, sort, order, start_date, end_date, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListEventsResponse')
end

#get_events_with_http_info(run_id, items_per_page = nil, page = nil, status = nil, type = nil, sort = nil, order = nil, start_date = nil, end_date = nil, request_options = {}) ⇒ Http::Response

Retrieves a list of events for a task run, identified by it&#39;s ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • run_id (String) —

    Unique identifier of a task run. (required)

  • items_per_page (Integer) (defaults to: nil) —

    Number of items per page. (default to 10)

  • page (Integer) (defaults to: nil) —

    Page number of the paginated API response.

  • status (Array<EventStatus>) (defaults to: nil) —

    Event status for filtering the list of task runs.

  • type (Array<EventType>) (defaults to: nil) —

    Event type for filtering the list of task runs.

  • sort (EventSortKeys) (defaults to: nil) —

    Property by which to sort the list of task run events.

  • order (OrderKeys) (defaults to: nil) —

    Sort order of the response, ascending or descending. (default to ‘desc’)

  • start_date (String) (defaults to: nil) —

    Date and time in RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.

  • end_date (String) (defaults to: nil) —

    Date and time in RFC3339 format for the latest events to retrieve. By default, the current time is used.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
 
# File 'lib/algolia/api/ingestion_client.rb', line 1033

def get_events_with_http_info(run_id, items_per_page = nil, page = nil, status = nil, type = nil, sort = nil, order = nil, start_date = nil, end_date = nil,
                              request_options = {})
  # verify the required parameter 'run_id' is set
  if @api_client.config.client_side_validation && run_id.nil?
    raise ArgumentError, "Parameter `run_id` is required when calling `get_events`."
  end
  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
    raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_events, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
    raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_events, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !page.nil? && page < 1
    raise ArgumentError, 'invalid value for ""page"" when calling IngestionClient.get_events, must be greater than or equal to 1.'
  end

  path = '/1/runs/{runID}/events'.sub('{' + 'runID' + '}', Transport.encode_uri(run_id.to_s))
  query_params = {}
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
  query_params[:page] = page unless page.nil?
  query_params[:status] = @api_client.build_collection_param(status, :multi) unless status.nil?
  query_params[:type] = @api_client.build_collection_param(type, :multi) unless type.nil?
  query_params[:sort] = sort unless sort.nil?
  query_params[:order] = order unless order.nil?
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.get_events',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_run(run_id, request_options = {}) ⇒ Run

Retrieve a single task run by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • run_id (String) —

    Unique identifier of a task run. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Run) 


1143
1144
1145
1146
 
# File 'lib/algolia/api/ingestion_client.rb', line 1143

def get_run(run_id, request_options = {})
  response = get_run_with_http_info(run_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Run')
end

#get_run_with_http_info(run_id, request_options = {}) ⇒ Http::Response

Retrieve a single task run by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • run_id (String) —

    Unique identifier of a task run. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'lib/algolia/api/ingestion_client.rb', line 1109

def get_run_with_http_info(run_id, request_options = {})
  # verify the required parameter 'run_id' is set
  if @api_client.config.client_side_validation && run_id.nil?
    raise ArgumentError, "Parameter `run_id` is required when calling `get_run`."
  end

  path = '/1/runs/{runID}'.sub('{' + 'runID' + '}', Transport.encode_uri(run_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.get_run',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_runs(items_per_page = nil, page = nil, status = nil, task_id = nil, sort = nil, order = nil, start_date = nil, end_date = nil, request_options = {}) ⇒ RunListResponse

Retrieve a list of task runs.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • items_per_page (Integer) (defaults to: nil) —

    Number of items per page. (default to 10)

  • page (Integer) (defaults to: nil) —

    Page number of the paginated API response.

  • status (Array<RunStatus>) (defaults to: nil) —

    Run status for filtering the list of task runs.

  • task_id (String) (defaults to: nil) —

    Task ID for filtering the list of task runs.

  • sort (RunSortKeys) (defaults to: nil) —

    Property by which to sort the list of task runs. (default to ‘createdAt’)

  • order (OrderKeys) (defaults to: nil) —

    Sort order of the response, ascending or descending. (default to ‘desc’)

  • start_date (String) (defaults to: nil) —

    Date in RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.

  • end_date (String) (defaults to: nil) —

    Date in RFC3339 format for the latest run to retrieve. By default, the current day is used.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (RunListResponse) 


1220
1221
1222
1223
 
# File 'lib/algolia/api/ingestion_client.rb', line 1220

def get_runs(items_per_page = nil, page = nil, status = nil, task_id = nil, sort = nil, order = nil, start_date = nil, end_date = nil, request_options = {})
  response = get_runs_with_http_info(items_per_page, page, status, task_id, sort, order, start_date, end_date, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::RunListResponse')
end

#get_runs_with_http_info(items_per_page = nil, page = nil, status = nil, task_id = nil, sort = nil, order = nil, start_date = nil, end_date = nil, request_options = {}) ⇒ Http::Response

Retrieve a list of task runs.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • items_per_page (Integer) (defaults to: nil) —

    Number of items per page. (default to 10)

  • page (Integer) (defaults to: nil) —

    Page number of the paginated API response.

  • status (Array<RunStatus>) (defaults to: nil) —

    Run status for filtering the list of task runs.

  • task_id (String) (defaults to: nil) —

    Task ID for filtering the list of task runs.

  • sort (RunSortKeys) (defaults to: nil) —

    Property by which to sort the list of task runs. (default to ‘createdAt’)

  • order (OrderKeys) (defaults to: nil) —

    Sort order of the response, ascending or descending. (default to ‘desc’)

  • start_date (String) (defaults to: nil) —

    Date in RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.

  • end_date (String) (defaults to: nil) —

    Date in RFC3339 format for the latest run to retrieve. By default, the current day is used.

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'lib/algolia/api/ingestion_client.rb', line 1164

def get_runs_with_http_info(items_per_page = nil, page = nil, status = nil, task_id = nil, sort = nil, order = nil, start_date = nil, end_date = nil, request_options = {})
  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
    raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_runs, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
    raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_runs, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !page.nil? && page < 1
    raise ArgumentError, 'invalid value for ""page"" when calling IngestionClient.get_runs, must be greater than or equal to 1.'
  end

  path = '/1/runs'
  query_params = {}
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
  query_params[:page] = page unless page.nil?
  query_params[:status] = @api_client.build_collection_param(status, :multi) unless status.nil?
  query_params[:taskID] = task_id unless task_id.nil?
  query_params[:sort] = sort unless sort.nil?
  query_params[:order] = order unless order.nil?
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.get_runs',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_source(source_id, request_options = {}) ⇒ Source

Retrieve a source by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Source) 


1268
1269
1270
1271
 
# File 'lib/algolia/api/ingestion_client.rb', line 1268

def get_source(source_id, request_options = {})
  response = get_source_with_http_info(source_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Source')
end

#get_source_with_http_info(source_id, request_options = {}) ⇒ Http::Response

Retrieve a source by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
 
# File 'lib/algolia/api/ingestion_client.rb', line 1234

def get_source_with_http_info(source_id, request_options = {})
  # verify the required parameter 'source_id' is set
  if @api_client.config.client_side_validation && source_id.nil?
    raise ArgumentError, "Parameter `source_id` is required when calling `get_source`."
  end

  path = '/1/sources/{sourceID}'.sub('{' + 'sourceID' + '}', Transport.encode_uri(source_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.get_source',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_sources(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {}) ⇒ ListSourcesResponse

Retrieves a list of sources.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • items_per_page (Integer) (defaults to: nil) —

    Number of items per page. (default to 10)

  • page (Integer) (defaults to: nil) —

    Page number of the paginated API response.

  • type (Array<SourceType>) (defaults to: nil) —

    Source type. Some sources require authentication.

  • authentication_id (Array<String>) (defaults to: nil) —

    Authentication IDs of the sources to retrieve. &#39;none&#39; returns sources that doesn&#39;t have an authentication resource.

  • sort (SourceSortKeys) (defaults to: nil) —

    Property by which to sort the list of sources. (default to ‘createdAt’)

  • order (OrderKeys) (defaults to: nil) —

    Sort order of the response, ascending or descending. (default to ‘desc’)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (ListSourcesResponse) 


1339
1340
1341
1342
 
# File 'lib/algolia/api/ingestion_client.rb', line 1339

def get_sources(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {})
  response = get_sources_with_http_info(items_per_page, page, type, authentication_id, sort, order, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListSourcesResponse')
end

#get_sources_with_http_info(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {}) ⇒ Http::Response

Retrieves a list of sources.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • items_per_page (Integer) (defaults to: nil) —

    Number of items per page. (default to 10)

  • page (Integer) (defaults to: nil) —

    Page number of the paginated API response.

  • type (Array<SourceType>) (defaults to: nil) —

    Source type. Some sources require authentication.

  • authentication_id (Array<String>) (defaults to: nil) —

    Authentication IDs of the sources to retrieve. &#39;none&#39; returns sources that doesn&#39;t have an authentication resource.

  • sort (SourceSortKeys) (defaults to: nil) —

    Property by which to sort the list of sources. (default to ‘createdAt’)

  • order (OrderKeys) (defaults to: nil) —

    Sort order of the response, ascending or descending. (default to ‘desc’)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'lib/algolia/api/ingestion_client.rb', line 1287

def get_sources_with_http_info(items_per_page = nil, page = nil, type = nil, authentication_id = nil, sort = nil, order = nil, request_options = {})
  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
    raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_sources, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
    raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_sources, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !page.nil? && page < 1
    raise ArgumentError, 'invalid value for ""page"" when calling IngestionClient.get_sources, must be greater than or equal to 1.'
  end

  path = '/1/sources'
  query_params = {}
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
  query_params[:page] = page unless page.nil?
  query_params[:type] = @api_client.build_collection_param(type, :csv) unless type.nil?
  query_params[:authenticationID] = @api_client.build_collection_param(authentication_id, :csv) unless authentication_id.nil?
  query_params[:sort] = sort unless sort.nil?
  query_params[:order] = order unless order.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.get_sources',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_task(task_id, request_options = {}) ⇒ Task

Retrieves a task by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Task) 


1387
1388
1389
1390
 
# File 'lib/algolia/api/ingestion_client.rb', line 1387

def get_task(task_id, request_options = {})
  response = get_task_with_http_info(task_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::Task')
end

#get_task_with_http_info(task_id, request_options = {}) ⇒ Http::Response

Retrieves a task by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
 
# File 'lib/algolia/api/ingestion_client.rb', line 1353

def get_task_with_http_info(task_id, request_options = {})
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    raise ArgumentError, "Parameter `task_id` is required when calling `get_task`."
  end

  path = '/1/tasks/{taskID}'.sub('{' + 'taskID' + '}', Transport.encode_uri(task_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.get_task',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_tasks(items_per_page = nil, page = nil, action = nil, enabled = nil, source_id = nil, destination_id = nil, trigger_type = nil, sort = nil, order = nil, request_options = {}) ⇒ ListTasksResponse

Retrieves a list of tasks.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • items_per_page (Integer) (defaults to: nil) —

    Number of items per page. (default to 10)

  • page (Integer) (defaults to: nil) —

    Page number of the paginated API response.

  • action (Array<ActionType>) (defaults to: nil) —

    Actions for filtering the list of tasks.

  • enabled (Boolean) (defaults to: nil) —

    Whether to filter the list of tasks by the &#x60;enabled&#x60; status.

  • source_id (Array<String>) (defaults to: nil) —

    Source IDs for filtering the list of tasks.

  • destination_id (Array<String>) (defaults to: nil) —

    Destination IDs for filtering the list of tasks.

  • trigger_type (Array<TriggerType>) (defaults to: nil) —

    Type of task trigger for filtering the list of tasks.

  • sort (TaskSortKeys) (defaults to: nil) —

    Property by which to sort the list of tasks. (default to ‘createdAt’)

  • order (OrderKeys) (defaults to: nil) —

    Sort order of the response, ascending or descending. (default to ‘desc’)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (ListTasksResponse) 


1468
1469
1470
1471
1472
 
# File 'lib/algolia/api/ingestion_client.rb', line 1468

def get_tasks(items_per_page = nil, page = nil, action = nil, enabled = nil, source_id = nil, destination_id = nil, trigger_type = nil, sort = nil, order = nil,
              request_options = {})
  response = get_tasks_with_http_info(items_per_page, page, action, enabled, source_id, destination_id, trigger_type, sort, order, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::ListTasksResponse')
end

#get_tasks_with_http_info(items_per_page = nil, page = nil, action = nil, enabled = nil, source_id = nil, destination_id = nil, trigger_type = nil, sort = nil, order = nil, request_options = {}) ⇒ Http::Response

Retrieves a list of tasks.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • items_per_page (Integer) (defaults to: nil) —

    Number of items per page. (default to 10)

  • page (Integer) (defaults to: nil) —

    Page number of the paginated API response.

  • action (Array<ActionType>) (defaults to: nil) —

    Actions for filtering the list of tasks.

  • enabled (Boolean) (defaults to: nil) —

    Whether to filter the list of tasks by the &#x60;enabled&#x60; status.

  • source_id (Array<String>) (defaults to: nil) —

    Source IDs for filtering the list of tasks.

  • destination_id (Array<String>) (defaults to: nil) —

    Destination IDs for filtering the list of tasks.

  • trigger_type (Array<TriggerType>) (defaults to: nil) —

    Type of task trigger for filtering the list of tasks.

  • sort (TaskSortKeys) (defaults to: nil) —

    Property by which to sort the list of tasks. (default to ‘createdAt’)

  • order (OrderKeys) (defaults to: nil) —

    Sort order of the response, ascending or descending. (default to ‘desc’)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
 
# File 'lib/algolia/api/ingestion_client.rb', line 1409

def get_tasks_with_http_info(items_per_page = nil, page = nil, action = nil, enabled = nil, source_id = nil, destination_id = nil, trigger_type = nil, sort = nil, order = nil,
                             request_options = {})
  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
    raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_tasks, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
    raise ArgumentError, 'invalid value for ""items_per_page"" when calling IngestionClient.get_tasks, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !page.nil? && page < 1
    raise ArgumentError, 'invalid value for ""page"" when calling IngestionClient.get_tasks, must be greater than or equal to 1.'
  end

  path = '/1/tasks'
  query_params = {}
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
  query_params[:page] = page unless page.nil?
  query_params[:action] = @api_client.build_collection_param(action, :csv) unless action.nil?
  query_params[:enabled] = enabled unless enabled.nil?
  query_params[:sourceID] = @api_client.build_collection_param(source_id, :csv) unless source_id.nil?
  query_params[:destinationID] = @api_client.build_collection_param(destination_id, :csv) unless destination_id.nil?
  query_params[:triggerType] = @api_client.build_collection_param(trigger_type, :csv) unless trigger_type.nil?
  query_params[:sort] = sort unless sort.nil?
  query_params[:order] = order unless order.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.get_tasks',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#run_task(task_id, request_options = {}) ⇒ RunResponse

Runs a task. You can check the status of task runs with the observability endpoints.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (RunResponse) 


1517
1518
1519
1520
 
# File 'lib/algolia/api/ingestion_client.rb', line 1517

def run_task(task_id, request_options = {})
  response = run_task_with_http_info(task_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::RunResponse')
end

#run_task_with_http_info(task_id, request_options = {}) ⇒ Http::Response

Runs a task. You can check the status of task runs with the observability endpoints.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
 
# File 'lib/algolia/api/ingestion_client.rb', line 1483

def run_task_with_http_info(task_id, request_options = {})
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    raise ArgumentError, "Parameter `task_id` is required when calling `run_task`."
  end

  path = '/1/tasks/{taskID}/run'.sub('{' + 'taskID' + '}', Transport.encode_uri(task_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.run_task',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#search_authentications(authentication_search, request_options = {}) ⇒ Array<Authentication>

Searches for authentication resources.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • authentication_search (AuthenticationSearch) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Array<Authentication>) 


1565
1566
1567
1568
 
# File 'lib/algolia/api/ingestion_client.rb', line 1565

def search_authentications(authentication_search, request_options = {})
  response = search_authentications_with_http_info(authentication_search, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Authentication>')
end

#search_authentications_with_http_info(authentication_search, request_options = {}) ⇒ Http::Response

Searches for authentication resources.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • authentication_search (AuthenticationSearch) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
 
# File 'lib/algolia/api/ingestion_client.rb', line 1531

def search_authentications_with_http_info(authentication_search, request_options = {})
  # verify the required parameter 'authentication_search' is set
  if @api_client.config.client_side_validation && authentication_search.nil?
    raise ArgumentError, "Parameter `authentication_search` is required when calling `search_authentications`."
  end

  path = '/1/authentications/search'
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(authentication_search)

  new_options = request_options.merge(
    :operation => :'IngestionClient.search_authentications',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#search_destinations(destination_search, request_options = {}) ⇒ Array<Destination>

Searches for destinations.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • destination_search (DestinationSearch) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Array<Destination>) 


1613
1614
1615
1616
 
# File 'lib/algolia/api/ingestion_client.rb', line 1613

def search_destinations(destination_search, request_options = {})
  response = search_destinations_with_http_info(destination_search, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Destination>')
end

#search_destinations_with_http_info(destination_search, request_options = {}) ⇒ Http::Response

Searches for destinations.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • destination_search (DestinationSearch) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
 
# File 'lib/algolia/api/ingestion_client.rb', line 1579

def search_destinations_with_http_info(destination_search, request_options = {})
  # verify the required parameter 'destination_search' is set
  if @api_client.config.client_side_validation && destination_search.nil?
    raise ArgumentError, "Parameter `destination_search` is required when calling `search_destinations`."
  end

  path = '/1/destinations/search'
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(destination_search)

  new_options = request_options.merge(
    :operation => :'IngestionClient.search_destinations',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#search_sources(source_search, request_options = {}) ⇒ Array<Source>

Searches for sources.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_search (SourceSearch) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Array<Source>) 


1661
1662
1663
1664
 
# File 'lib/algolia/api/ingestion_client.rb', line 1661

def search_sources(source_search, request_options = {})
  response = search_sources_with_http_info(source_search, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Source>')
end

#search_sources_with_http_info(source_search, request_options = {}) ⇒ Http::Response

Searches for sources.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_search (SourceSearch) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
 
# File 'lib/algolia/api/ingestion_client.rb', line 1627

def search_sources_with_http_info(source_search, request_options = {})
  # verify the required parameter 'source_search' is set
  if @api_client.config.client_side_validation && source_search.nil?
    raise ArgumentError, "Parameter `source_search` is required when calling `search_sources`."
  end

  path = '/1/sources/search'
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(source_search)

  new_options = request_options.merge(
    :operation => :'IngestionClient.search_sources',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#search_tasks(task_search, request_options = {}) ⇒ Array<Task>

Searches for tasks.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • task_search (TaskSearch) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (Array<Task>) 


1709
1710
1711
1712
 
# File 'lib/algolia/api/ingestion_client.rb', line 1709

def search_tasks(task_search, request_options = {})
  response = search_tasks_with_http_info(task_search, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Array<Ingestion::Task>')
end

#search_tasks_with_http_info(task_search, request_options = {}) ⇒ Http::Response

Searches for tasks.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • task_search (TaskSearch) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
 
# File 'lib/algolia/api/ingestion_client.rb', line 1675

def search_tasks_with_http_info(task_search, request_options = {})
  # verify the required parameter 'task_search' is set
  if @api_client.config.client_side_validation && task_search.nil?
    raise ArgumentError, "Parameter `task_search` is required when calling `search_tasks`."
  end

  path = '/1/tasks/search'
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(task_search)

  new_options = request_options.merge(
    :operation => :'IngestionClient.search_tasks',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#trigger_docker_source_discover(source_id, request_options = {}) ⇒ DockerSourceDiscover

Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with ‘type: docker` and `imageType: singer`.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (DockerSourceDiscover) 


1757
1758
1759
1760
 
# File 'lib/algolia/api/ingestion_client.rb', line 1757

def trigger_docker_source_discover(source_id, request_options = {})
  response = trigger_docker_source_discover_with_http_info(source_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DockerSourceDiscover')
end

#trigger_docker_source_discover_with_http_info(source_id, request_options = {}) ⇒ Http::Response

Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with &#x60;type: docker&#x60; and &#x60;imageType: singer&#x60;.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
 
# File 'lib/algolia/api/ingestion_client.rb', line 1723

def trigger_docker_source_discover_with_http_info(source_id, request_options = {})
  # verify the required parameter 'source_id' is set
  if @api_client.config.client_side_validation && source_id.nil?
    raise ArgumentError, "Parameter `source_id` is required when calling `trigger_docker_source_discover`."
  end

  path = '/1/sources/{sourceID}/discover'.sub('{' + 'sourceID' + '}', Transport.encode_uri(source_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :'IngestionClient.trigger_docker_source_discover',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#update_authentication(authentication_id, authentication_update, request_options = {}) ⇒ AuthenticationUpdateResponse

Updates an authentication resource.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • authentication_id (String) —

    Unique identifier of an authentication resource. (required)

  • authentication_update (AuthenticationUpdate) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (AuthenticationUpdateResponse) 


1811
1812
1813
1814
 
# File 'lib/algolia/api/ingestion_client.rb', line 1811

def update_authentication(authentication_id, authentication_update, request_options = {})
  response = update_authentication_with_http_info(authentication_id, authentication_update, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::AuthenticationUpdateResponse')
end

#update_authentication_with_http_info(authentication_id, authentication_update, request_options = {}) ⇒ Http::Response

Updates an authentication resource.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • authentication_id (String) —

    Unique identifier of an authentication resource. (required)

  • authentication_update (AuthenticationUpdate) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
 
# File 'lib/algolia/api/ingestion_client.rb', line 1772

def update_authentication_with_http_info(authentication_id, authentication_update, request_options = {})
  # verify the required parameter 'authentication_id' is set
  if @api_client.config.client_side_validation && authentication_id.nil?
    raise ArgumentError, "Parameter `authentication_id` is required when calling `update_authentication`."
  end
  # verify the required parameter 'authentication_update' is set
  if @api_client.config.client_side_validation && authentication_update.nil?
    raise ArgumentError, "Parameter `authentication_update` is required when calling `update_authentication`."
  end

  path = '/1/authentications/{authenticationID}'.sub('{' + 'authenticationID' + '}', Transport.encode_uri(authentication_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(authentication_update)

  new_options = request_options.merge(
    :operation => :'IngestionClient.update_authentication',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PATCH, path, new_options)
end

#update_destination(destination_id, destination_update, request_options = {}) ⇒ DestinationUpdateResponse

Updates the destination by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • destination_id (String) —

    Unique identifier of a destination. (required)

  • destination_update (DestinationUpdate) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (DestinationUpdateResponse) 


1865
1866
1867
1868
 
# File 'lib/algolia/api/ingestion_client.rb', line 1865

def update_destination(destination_id, destination_update, request_options = {})
  response = update_destination_with_http_info(destination_id, destination_update, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::DestinationUpdateResponse')
end

#update_destination_with_http_info(destination_id, destination_update, request_options = {}) ⇒ Http::Response

Updates the destination by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • destination_id (String) —

    Unique identifier of a destination. (required)

  • destination_update (DestinationUpdate) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
 
# File 'lib/algolia/api/ingestion_client.rb', line 1826

def update_destination_with_http_info(destination_id, destination_update, request_options = {})
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    raise ArgumentError, "Parameter `destination_id` is required when calling `update_destination`."
  end
  # verify the required parameter 'destination_update' is set
  if @api_client.config.client_side_validation && destination_update.nil?
    raise ArgumentError, "Parameter `destination_update` is required when calling `update_destination`."
  end

  path = '/1/destinations/{destinationID}'.sub('{' + 'destinationID' + '}', Transport.encode_uri(destination_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(destination_update)

  new_options = request_options.merge(
    :operation => :'IngestionClient.update_destination',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PATCH, path, new_options)
end

#update_source(source_id, source_update, request_options = {}) ⇒ SourceUpdateResponse

Updates a source by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • source_update (SourceUpdate) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (SourceUpdateResponse) 


1919
1920
1921
1922
 
# File 'lib/algolia/api/ingestion_client.rb', line 1919

def update_source(source_id, source_update, request_options = {})
  response = update_source_with_http_info(source_id, source_update, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::SourceUpdateResponse')
end

#update_source_with_http_info(source_id, source_update, request_options = {}) ⇒ Http::Response

Updates a source by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • source_update (SourceUpdate) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
 
# File 'lib/algolia/api/ingestion_client.rb', line 1880

def update_source_with_http_info(source_id, source_update, request_options = {})
  # verify the required parameter 'source_id' is set
  if @api_client.config.client_side_validation && source_id.nil?
    raise ArgumentError, "Parameter `source_id` is required when calling `update_source`."
  end
  # verify the required parameter 'source_update' is set
  if @api_client.config.client_side_validation && source_update.nil?
    raise ArgumentError, "Parameter `source_update` is required when calling `update_source`."
  end

  path = '/1/sources/{sourceID}'.sub('{' + 'sourceID' + '}', Transport.encode_uri(source_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(source_update)

  new_options = request_options.merge(
    :operation => :'IngestionClient.update_source',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PATCH, path, new_options)
end

#update_task(task_id, task_update, request_options = {}) ⇒ TaskUpdateResponse

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • task_update (TaskUpdate) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

  • (TaskUpdateResponse) 


1965
1966
1967
1968
 
# File 'lib/algolia/api/ingestion_client.rb', line 1965

def update_task(task_id, task_update, request_options = {})
  response = update_task_with_http_info(task_id, task_update, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || 'Ingestion::TaskUpdateResponse')
end

#update_task_with_http_info(task_id, task_update, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • task_update (TaskUpdate) —

    (required)

  • request_options: —

    The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:



1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
 
# File 'lib/algolia/api/ingestion_client.rb', line 1930

def update_task_with_http_info(task_id, task_update, request_options = {})
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    raise ArgumentError, "Parameter `task_id` is required when calling `update_task`."
  end
  # verify the required parameter 'task_update' is set
  if @api_client.config.client_side_validation && task_update.nil?
    raise ArgumentError, "Parameter `task_update` is required when calling `update_task`."
  end

  path = '/1/tasks/{taskID}'.sub('{' + 'taskID' + '}', Transport.encode_uri(task_id.to_s))
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(task_update)

  new_options = request_options.merge(
    :operation => :'IngestionClient.update_task',
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PATCH, path, new_options)
end