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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# 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

  if opts.nil? || opts[:connect_timeout].nil?
    opts[:connect_timeout] = 25000
  end

  if opts.nil? || opts[:read_timeout].nil?
    opts[:read_timeout] = 25000
  end

  if opts.nil? || opts[:write_timeout].nil?
    opts[:write_timeout] = 25000
  end

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

  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 



50
51
52
 
# File 'lib/algolia/api/ingestion_client.rb', line 50

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

Instance Method Details

#add_user_agent_segment(segment, version = nil) ⇒ Object 



64
65
66
67
68
 
# File 'lib/algolia/api/ingestion_client.rb', line 64

def add_user_agent_segment(segment, version = nil)
  @api_client.config.add_user_agent_segment(segment, version)

  self
end

#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) 


113
114
115
116
117
118
119
 
# File 'lib/algolia/api/ingestion_client.rb', line 113

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:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/algolia/api/ingestion_client.rb', line 79

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) 


164
165
166
167
168
169
170
 
# File 'lib/algolia/api/ingestion_client.rb', line 164

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:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/algolia/api/ingestion_client.rb', line 130

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) 


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

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:



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

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) 


255
256
257
258
 
# File 'lib/algolia/api/ingestion_client.rb', line 255

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_v1(task_create, request_options = {}) ⇒ TaskCreateResponse

Parameters:

  • task_create (TaskCreateV1) —

    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) 


295
296
297
298
 
# File 'lib/algolia/api/ingestion_client.rb', line 295

def create_task_v1(task_create, request_options = {})
  response = create_task_v1_with_http_info(task_create, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::TaskCreateResponse")
end

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

Returns the response.

Parameters:

  • task_create (TaskCreateV1) —

    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:



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/algolia/api/ingestion_client.rb', line 265

def create_task_v1_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_v1`."
  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_v1",
    :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_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:



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

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 = "/2/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

#create_transformation(transformation_create, request_options = {}) ⇒ TransformationCreateResponse

Parameters:

  • transformation_create (TransformationCreate) —

    Request body for creating a transformation. (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:

  • (TransformationCreateResponse) 


335
336
337
338
339
340
341
 
# File 'lib/algolia/api/ingestion_client.rb', line 335

def create_transformation(transformation_create, request_options = {})
  response = create_transformation_with_http_info(transformation_create, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Ingestion::TransformationCreateResponse"
  )
end

#create_transformation_with_http_info(transformation_create, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • transformation_create (TransformationCreate) —

    Request body for creating a transformation. (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:



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/algolia/api/ingestion_client.rb', line 305

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

  path = "/1/transformations"
  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(transformation_create)

  new_options = request_options.merge(
    :operation => :"IngestionClient.create_transformation",
    :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 "/1" 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) 


381
382
383
384
 
# File 'lib/algolia/api/ingestion_client.rb', line 381

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 "/1" 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:



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/algolia/api/ingestion_client.rb', line 349

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 "/1" 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) 


424
425
426
427
 
# File 'lib/algolia/api/ingestion_client.rb', line 424

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 "/1" 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:



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/algolia/api/ingestion_client.rb', line 392

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 "/1" 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) 


469
470
471
472
 
# File 'lib/algolia/api/ingestion_client.rb', line 469

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 "/1" 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:



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/algolia/api/ingestion_client.rb', line 436

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 "/1" 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) 


514
515
516
517
 
# File 'lib/algolia/api/ingestion_client.rb', line 514

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 "/1" 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:



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/algolia/api/ingestion_client.rb', line 481

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) 


565
566
567
568
 
# File 'lib/algolia/api/ingestion_client.rb', line 565

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’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:



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/algolia/api/ingestion_client.rb', line 528

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) 


616
617
618
619
 
# File 'lib/algolia/api/ingestion_client.rb', line 616

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’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:



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/algolia/api/ingestion_client.rb', line 579

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) 


664
665
666
667
 
# File 'lib/algolia/api/ingestion_client.rb', line 664

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’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:



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/algolia/api/ingestion_client.rb', line 630

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) 


704
705
706
707
 
# File 'lib/algolia/api/ingestion_client.rb', line 704

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_v1(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) 


744
745
746
747
 
# File 'lib/algolia/api/ingestion_client.rb', line 744

def delete_task_v1(task_id, request_options = {})
  response = delete_task_v1_with_http_info(task_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::DeleteResponse")
end

#delete_task_v1_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:



714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/algolia/api/ingestion_client.rb', line 714

def delete_task_v1_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_v1`."
  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_v1",
    :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_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:



674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/algolia/api/ingestion_client.rb', line 674

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 = "/2/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

#delete_transformation(transformation_id, request_options = {}) ⇒ DeleteResponse

Parameters:

  • transformation_id (String) —

    Unique identifier of a transformation. (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) 


787
788
789
790
 
# File 'lib/algolia/api/ingestion_client.rb', line 787

def delete_transformation(transformation_id, request_options = {})
  response = delete_transformation_with_http_info(transformation_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::DeleteResponse")
end

#delete_transformation_with_http_info(transformation_id, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • transformation_id (String) —

    Unique identifier of a transformation. (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:



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/algolia/api/ingestion_client.rb', line 754

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

  path = "/1/transformations/{transformationID}".sub(
    "{" + "transformationID" + "}",
    Transport.encode_uri(transformation_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_transformation",
    :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) 


835
836
837
838
 
# File 'lib/algolia/api/ingestion_client.rb', line 835

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_v1(task_id, request_options = {}) ⇒ TaskUpdateResponse

Disables a task using the v1 endpoint, please use ‘disableTask` instead.

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) 


883
884
885
886
 
# File 'lib/algolia/api/ingestion_client.rb', line 883

def disable_task_v1(task_id, request_options = {})
  response = disable_task_v1_with_http_info(task_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::TaskUpdateResponse")
end

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

Disables a task using the v1 endpoint, please use ‘disableTask` instead.

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:



849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'lib/algolia/api/ingestion_client.rb', line 849

def disable_task_v1_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_v1`."
  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_v1",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PUT, path, new_options)
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:



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

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 = "/2/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) 


931
932
933
934
 
# File 'lib/algolia/api/ingestion_client.rb', line 931

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_v1(task_id, request_options = {}) ⇒ TaskUpdateResponse

Enables a task using the v1 endpoint, please use ‘enableTask` instead.

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) 


979
980
981
982
 
# File 'lib/algolia/api/ingestion_client.rb', line 979

def enable_task_v1(task_id, request_options = {})
  response = enable_task_v1_with_http_info(task_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::TaskUpdateResponse")
end

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

Enables a task using the v1 endpoint, please use ‘enableTask` instead.

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:



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'lib/algolia/api/ingestion_client.rb', line 945

def enable_task_v1_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_v1`."
  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_v1",
    :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_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:



897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/algolia/api/ingestion_client.rb', line 897

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 = "/2/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) 


1030
1031
1032
1033
 
# File 'lib/algolia/api/ingestion_client.rb', line 1030

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:



993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/algolia/api/ingestion_client.rb', line 993

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_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) 


1081
1082
1083
1084
 
# File 'lib/algolia/api/ingestion_client.rb', line 1081

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:



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
 
# File 'lib/algolia/api/ingestion_client.rb', line 1044

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_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) 


1138
1139
1140
1141
 
# File 'lib/algolia/api/ingestion_client.rb', line 1138

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:



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'lib/algolia/api/ingestion_client.rb', line 1096

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_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) 


1186
1187
1188
1189
 
# File 'lib/algolia/api/ingestion_client.rb', line 1186

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:



1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
 
# File 'lib/algolia/api/ingestion_client.rb', line 1152

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_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) 


1234
1235
1236
1237
 
# File 'lib/algolia/api/ingestion_client.rb', line 1234

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:



1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
 
# File 'lib/algolia/api/ingestion_client.rb', line 1200

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_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) 


1282
1283
1284
1285
 
# File 'lib/algolia/api/ingestion_client.rb', line 1282

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_v1(task_id, request_options = {}) ⇒ TaskV1

Retrieves a task by its ID using the v1 endpoint, please use ‘getTask` instead.

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:

  • (TaskV1) 


1330
1331
1332
1333
 
# File 'lib/algolia/api/ingestion_client.rb', line 1330

def get_task_v1(task_id, request_options = {})
  response = get_task_v1_with_http_info(task_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::TaskV1")
end

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

Retrieves a task by its ID using the v1 endpoint, please use ‘getTask` instead.

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:



1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'lib/algolia/api/ingestion_client.rb', line 1296

def get_task_v1_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_v1`."
  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_v1",
    :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_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:



1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
 
# File 'lib/algolia/api/ingestion_client.rb', line 1248

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 = "/2/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_transformation(transformation_id, request_options = {}) ⇒ Transformation

Retrieves a transformation by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • transformation_id (String) —

    Unique identifier of a transformation. (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:

  • (Transformation) 


1381
1382
1383
1384
 
# File 'lib/algolia/api/ingestion_client.rb', line 1381

def get_transformation(transformation_id, request_options = {})
  response = get_transformation_with_http_info(transformation_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::Transformation")
end

#get_transformation_with_http_info(transformation_id, request_options = {}) ⇒ Http::Response

Retrieves a transformation by its ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • transformation_id (String) —

    Unique identifier of a transformation. (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:



1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'lib/algolia/api/ingestion_client.rb', line 1344

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

  path = "/1/transformations/{transformationID}".sub(
    "{" + "transformationID" + "}",
    Transport.encode_uri(transformation_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_transformation",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

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

#list_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 authentications.

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

    Property by which to sort the list of authentications. (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) 


1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'lib/algolia/api/ingestion_client.rb', line 1448

def list_authentications(
  items_per_page = nil,
  page = nil,
  type = nil,
  platform = nil,
  sort = nil,
  order = nil,
  request_options = {}
)
  response = list_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

#list_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 authentications.

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

    Property by which to sort the list of authentications. (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:



1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
 
# File 'lib/algolia/api/ingestion_client.rb', line 1400

def list_authentications_with_http_info(
  items_per_page = nil,
  page = nil,
  type = nil,
  platform = nil,
  sort = nil,
  order = nil,
  request_options = {}
)
  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.list_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

#list_destinations(items_per_page = nil, page = nil, type = nil, authentication_id = nil, transformation_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.

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

    Get the list of destinations used by a transformation.

  • 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) 


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

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

#list_destinations_with_http_info(items_per_page = nil, page = nil, type = nil, authentication_id = nil, transformation_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.

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

    Get the list of destinations used by a transformation.

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



1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'lib/algolia/api/ingestion_client.rb', line 1479

def list_destinations_with_http_info(
  items_per_page = nil,
  page = nil,
  type = nil,
  authentication_id = nil,
  transformation_id = nil,
  sort = nil,
  order = nil,
  request_options = {}
)
  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?
  unless authentication_id.nil?
    query_params[:authenticationID] = @api_client.build_collection_param(authentication_id, :csv)
  end

  query_params[:transformationID] = transformation_id unless transformation_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.list_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

#list_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 its 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 RFC 3339 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 RFC 3339 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) 


1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
 
# File 'lib/algolia/api/ingestion_client.rb', line 1637

def list_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 = list_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

#list_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 its 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 RFC 3339 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 RFC 3339 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:



1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
 
# File 'lib/algolia/api/ingestion_client.rb', line 1576

def list_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 `list_events`."
  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.list_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

#list_runs(items_per_page = nil, page = nil, status = nil, type = 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.

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

    Run type 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 RFC 3339 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 RFC 3339 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) 


1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
 
# File 'lib/algolia/api/ingestion_client.rb', line 1738

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

#list_runs_with_http_info(items_per_page = nil, page = nil, status = nil, type = 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.

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

    Run type 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 RFC 3339 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 RFC 3339 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:



1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
 
# File 'lib/algolia/api/ingestion_client.rb', line 1681

def list_runs_with_http_info(
  items_per_page = nil,
  page = nil,
  status = nil,
  type = nil,
  task_id = nil,
  sort = nil,
  order = nil,
  start_date = nil,
  end_date = nil,
  request_options = {}
)
  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[:type] = @api_client.build_collection_param(type, :multi) unless type.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.list_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

#list_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. ‘none’ returns sources that doesn’t have an authentication.

  • 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) 


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

def list_sources(
  items_per_page = nil,
  page = nil,
  type = nil,
  authentication_id = nil,
  sort = nil,
  order = nil,
  request_options = {}
)
  response = list_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

#list_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. ‘none’ returns sources that doesn’t have an authentication.

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



1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
 
# File 'lib/algolia/api/ingestion_client.rb', line 1779

def list_sources_with_http_info(
  items_per_page = nil,
  page = nil,
  type = nil,
  authentication_id = nil,
  sort = nil,
  order = nil,
  request_options = {}
)
  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?
  unless authentication_id.nil?
    query_params[:authenticationID] = @api_client.build_collection_param(authentication_id, :csv)
  end

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

#list_tasks(items_per_page = nil, page = nil, action = nil, enabled = nil, source_id = nil, source_type = nil, destination_id = nil, trigger_type = nil, with_email_notifications = 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 ‘enabled` status.

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

    Source IDs for filtering the list of tasks.

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

    Filters the tasks with the specified source type.

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

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

    If specified, the response only includes tasks with notifications.email.enabled set to this value.

  • 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) 


1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
 
# File 'lib/algolia/api/ingestion_client.rb', line 1936

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

#list_tasks_v1(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 = {}) ⇒ ListTasksResponseV1

Retrieves a list of tasks using the v1 endpoint, please use ‘getTasks` instead.

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 ‘enabled` 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:

  • (ListTasksResponseV1) 


2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
 
# File 'lib/algolia/api/ingestion_client.rb', line 2044

def list_tasks_v1(
  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 = list_tasks_v1_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::ListTasksResponseV1")
end

#list_tasks_v1_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 using the v1 endpoint, please use ‘getTasks` instead.

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 ‘enabled` 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:



1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 
# File 'lib/algolia/api/ingestion_client.rb', line 1984

def list_tasks_v1_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 = {}
)
  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?
  unless destination_id.nil?
    query_params[:destinationID] = @api_client.build_collection_param(destination_id, :csv)
  end

  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.list_tasks_v1",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

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

#list_tasks_with_http_info(items_per_page = nil, page = nil, action = nil, enabled = nil, source_id = nil, source_type = nil, destination_id = nil, trigger_type = nil, with_email_notifications = 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 ‘enabled` status.

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

    Source IDs for filtering the list of tasks.

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

    Filters the tasks with the specified source type.

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

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

    If specified, the response only includes tasks with notifications.email.enabled set to this value.

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



1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
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
1908
1909
1910
1911
1912
1913
1914
1915
 
# File 'lib/algolia/api/ingestion_client.rb', line 1870

def list_tasks_with_http_info(
  items_per_page = nil,
  page = nil,
  action = nil,
  enabled = nil,
  source_id = nil,
  source_type = nil,
  destination_id = nil,
  trigger_type = nil,
  with_email_notifications = nil,
  sort = nil,
  order = nil,
  request_options = {}
)
  path = "/2/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[:sourceType] = @api_client.build_collection_param(source_type, :csv) unless source_type.nil?
  unless destination_id.nil?
    query_params[:destinationID] = @api_client.build_collection_param(destination_id, :csv)
  end

  query_params[:triggerType] = @api_client.build_collection_param(trigger_type, :csv) unless trigger_type.nil?
  query_params[:withEmailNotifications] = with_email_notifications unless with_email_notifications.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.list_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

#list_transformations(items_per_page = nil, page = nil, sort = nil, order = nil, request_options = {}) ⇒ ListTransformationsResponse

Retrieves a list of transformations.

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.

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

    Property by which to sort the list of transformations. (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:

  • (ListTransformationsResponse) 


2125
2126
2127
2128
2129
2130
2131
 
# File 'lib/algolia/api/ingestion_client.rb', line 2125

def list_transformations(items_per_page = nil, page = nil, sort = nil, order = nil, request_options = {})
  response = list_transformations_with_http_info(items_per_page, page, sort, order, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Ingestion::ListTransformationsResponse"
  )
end

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

Retrieves a list of transformations.

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.

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

    Property by which to sort the list of transformations. (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:



2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
 
# File 'lib/algolia/api/ingestion_client.rb', line 2083

def list_transformations_with_http_info(
  items_per_page = nil,
  page = nil,
  sort = nil,
  order = nil,
  request_options = {}
)
  path = "/1/transformations"
  query_params = {}
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
  query_params[:page] = page unless page.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.list_transformations",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

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

#push_task(task_id, push_task_payload, watch = nil, request_options = {}) ⇒ WatchResponse

Push a ‘batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • push_task_payload (PushTaskPayload) —

    Request body of a Search API ‘batch` request that will be pushed in the Connectors pipeline. (required)

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

    When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.

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

  • (WatchResponse) 


2186
2187
2188
2189
 
# File 'lib/algolia/api/ingestion_client.rb', line 2186

def push_task(task_id, push_task_payload, watch = nil, request_options = {})
  response = push_task_with_http_info(task_id, push_task_payload, watch, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::WatchResponse")
end

#push_task_with_http_info(task_id, push_task_payload, watch = nil, request_options = {}) ⇒ Http::Response

Push a ‘batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • push_task_payload (PushTaskPayload) —

    Request body of a Search API ‘batch` request that will be pushed in the Connectors pipeline. (required)

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

    When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.

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



2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
 
# File 'lib/algolia/api/ingestion_client.rb', line 2144

def push_task_with_http_info(task_id, push_task_payload, watch = nil, 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 `push_task`."
  end
  # verify the required parameter 'push_task_payload' is set
  if @api_client.config.client_side_validation && push_task_payload.nil?
    raise ArgumentError, "Parameter `push_task_payload` is required when calling `push_task`."
  end

  path = "/2/tasks/{taskID}/push".sub("{" + "taskID" + "}", Transport.encode_uri(task_id.to_s))
  query_params = {}
  query_params[:watch] = watch unless watch.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?
  request_options[:timeout] ||= 180000

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

  new_options = request_options.merge(
    :operation => :"IngestionClient.push_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

#run_source(source_id, run_source_payload = nil, request_options = {}) ⇒ RunSourceResponse

Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • run_source_payload (RunSourcePayload) (defaults to: nil)
  • 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:

  • (RunSourceResponse) 


2236
2237
2238
2239
 
# File 'lib/algolia/api/ingestion_client.rb', line 2236

def run_source(source_id, run_source_payload = nil, request_options = {})
  response = run_source_with_http_info(source_id, run_source_payload, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::RunSourceResponse")
end

#run_source_with_http_info(source_id, run_source_payload = nil, request_options = {}) ⇒ Http::Response

Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • run_source_payload (RunSourcePayload) (defaults to: nil)
  • 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:



2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
 
# File 'lib/algolia/api/ingestion_client.rb', line 2201

def run_source_with_http_info(source_id, run_source_payload = nil, 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 `run_source`."
  end

  path = "/1/sources/{sourceID}/run".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(run_source_payload)

  new_options = request_options.merge(
    :operation => :"IngestionClient.run_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

#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) 


2284
2285
2286
2287
 
# File 'lib/algolia/api/ingestion_client.rb', line 2284

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_v1(task_id, request_options = {}) ⇒ RunResponse

Runs a task using the v1 endpoint, please use ‘runTask` instead. 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) 


2332
2333
2334
2335
 
# File 'lib/algolia/api/ingestion_client.rb', line 2332

def run_task_v1(task_id, request_options = {})
  response = run_task_v1_with_http_info(task_id, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::RunResponse")
end

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

Runs a task using the v1 endpoint, please use ‘runTask` instead. 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:



2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
 
# File 'lib/algolia/api/ingestion_client.rb', line 2298

def run_task_v1_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_v1`."
  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_v1",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
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:



2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
 
# File 'lib/algolia/api/ingestion_client.rb', line 2250

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 = "/2/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>) 


2380
2381
2382
2383
 
# File 'lib/algolia/api/ingestion_client.rb', line 2380

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:



2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
 
# File 'lib/algolia/api/ingestion_client.rb', line 2346

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>) 


2428
2429
2430
2431
 
# File 'lib/algolia/api/ingestion_client.rb', line 2428

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:



2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/algolia/api/ingestion_client.rb', line 2394

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>) 


2476
2477
2478
2479
 
# File 'lib/algolia/api/ingestion_client.rb', line 2476

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:



2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
 
# File 'lib/algolia/api/ingestion_client.rb', line 2442

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>) 


2524
2525
2526
2527
 
# File 'lib/algolia/api/ingestion_client.rb', line 2524

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_v1(task_search, request_options = {}) ⇒ Array<TaskV1>

Searches for tasks using the v1 endpoint, please use ‘searchTasks` instead.

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<TaskV1>) 


2572
2573
2574
2575
 
# File 'lib/algolia/api/ingestion_client.rb', line 2572

def search_tasks_v1(task_search, request_options = {})
  response = search_tasks_v1_with_http_info(task_search, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Array<Ingestion::TaskV1>")
end

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

Searches for tasks using the v1 endpoint, please use ‘searchTasks` instead.

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:



2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
 
# File 'lib/algolia/api/ingestion_client.rb', line 2538

def search_tasks_v1_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_v1`."
  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_v1",
    :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_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:



2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
 
# File 'lib/algolia/api/ingestion_client.rb', line 2490

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 = "/2/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

#search_transformations(transformation_search, request_options = {}) ⇒ Array<Transformation>

Searches for transformations.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • transformation_search (TransformationSearch) —

    (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<Transformation>) 


2620
2621
2622
2623
 
# File 'lib/algolia/api/ingestion_client.rb', line 2620

def search_transformations(transformation_search, request_options = {})
  response = search_transformations_with_http_info(transformation_search, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Array<Ingestion::Transformation>")
end

#search_transformations_with_http_info(transformation_search, request_options = {}) ⇒ Http::Response

Searches for transformations.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • transformation_search (TransformationSearch) —

    (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:



2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
 
# File 'lib/algolia/api/ingestion_client.rb', line 2586

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

  path = "/1/transformations/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(transformation_search)

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

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

#set_client_api_key(api_key) ⇒ void

This method returns an undefined value.

Helper method to switch the API key used to authenticate the requests.

Parameters:

  • api_key (String) —

    the new API key to use.



58
59
60
61
62
 
# File 'lib/algolia/api/ingestion_client.rb', line 58

def set_client_api_key(api_key)
  @api_client.set_client_api_key(api_key)

  self
end

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

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

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:

  • (WatchResponse) 


2669
2670
2671
2672
 
# File 'lib/algolia/api/ingestion_client.rb', line 2669

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::WatchResponse")
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 ‘type: docker` and `imageType: airbyte`.

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:



2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/algolia/api/ingestion_client.rb', line 2634

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?
  request_options[:timeout] ||= 180000

  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

#try_transformation(transformation_try, request_options = {}) ⇒ TransformationTryResponse

Try a transformation before creating it.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • transformation_try (TransformationTry) —

    (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:

  • (TransformationTryResponse) 


2717
2718
2719
2720
2721
2722
2723
 
# File 'lib/algolia/api/ingestion_client.rb', line 2717

def try_transformation(transformation_try, request_options = {})
  response = try_transformation_with_http_info(transformation_try, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Ingestion::TransformationTryResponse"
  )
end

#try_transformation_before_update(transformation_id, transformation_try, request_options = {}) ⇒ TransformationTryResponse

Try a transformation before updating it.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • transformation_id (String) —

    Unique identifier of a transformation. (required)

  • transformation_try (TransformationTry) —

    (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:

  • (TransformationTryResponse) 


2783
2784
2785
2786
2787
2788
2789
 
# File 'lib/algolia/api/ingestion_client.rb', line 2783

def try_transformation_before_update(transformation_id, transformation_try, request_options = {})
  response = try_transformation_before_update_with_http_info(transformation_id, transformation_try, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Ingestion::TransformationTryResponse"
  )
end

#try_transformation_before_update_with_http_info(transformation_id, transformation_try, request_options = {}) ⇒ Http::Response

Try a transformation before updating it.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • transformation_id (String) —

    Unique identifier of a transformation. (required)

  • transformation_try (TransformationTry) —

    (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:



2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'lib/algolia/api/ingestion_client.rb', line 2735

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

  path = "/1/transformations/{transformationID}/try".sub(
    "{" + "transformationID" + "}",
    Transport.encode_uri(transformation_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(transformation_try)

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

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

#try_transformation_with_http_info(transformation_try, request_options = {}) ⇒ Http::Response

Try a transformation before creating it.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • transformation_try (TransformationTry) —

    (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:



2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
 
# File 'lib/algolia/api/ingestion_client.rb', line 2683

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

  path = "/1/transformations/try"
  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(transformation_try)

  new_options = request_options.merge(
    :operation => :"IngestionClient.try_transformation",
    :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) 


2843
2844
2845
2846
2847
2848
2849
 
# File 'lib/algolia/api/ingestion_client.rb', line 2843

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:



2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
 
# File 'lib/algolia/api/ingestion_client.rb', line 2801

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) 


2903
2904
2905
2906
2907
2908
2909
 
# File 'lib/algolia/api/ingestion_client.rb', line 2903

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:



2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
 
# File 'lib/algolia/api/ingestion_client.rb', line 2861

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) 


2960
2961
2962
2963
 
# File 'lib/algolia/api/ingestion_client.rb', line 2960

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:



2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
 
# File 'lib/algolia/api/ingestion_client.rb', line 2921

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) 


3006
3007
3008
3009
 
# File 'lib/algolia/api/ingestion_client.rb', line 3006

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_v1(task_id, task_update, request_options = {}) ⇒ TaskUpdateResponse

Parameters:

  • task_id (String) —

    Unique identifier of a task. (required)

  • task_update (TaskUpdateV1) —

    (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) 


3052
3053
3054
3055
 
# File 'lib/algolia/api/ingestion_client.rb', line 3052

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

#update_task_v1_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 (TaskUpdateV1) —

    (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:



3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
 
# File 'lib/algolia/api/ingestion_client.rb', line 3017

def update_task_v1_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_v1`."
  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_v1`."
  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_v1",
    :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_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:



2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
 
# File 'lib/algolia/api/ingestion_client.rb', line 2971

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 = "/2/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

#update_transformation(transformation_id, transformation_create, request_options = {}) ⇒ TransformationUpdateResponse

Parameters:

  • transformation_id (String) —

    Unique identifier of a transformation. (required)

  • transformation_create (TransformationCreate) —

    (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:

  • (TransformationUpdateResponse) 


3101
3102
3103
3104
3105
3106
3107
 
# File 'lib/algolia/api/ingestion_client.rb', line 3101

def update_transformation(transformation_id, transformation_create, request_options = {})
  response = update_transformation_with_http_info(transformation_id, transformation_create, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Ingestion::TransformationUpdateResponse"
  )
end

#update_transformation_with_http_info(transformation_id, transformation_create, request_options = {}) ⇒ Http::Response

Returns the response.

Parameters:

  • transformation_id (String) —

    Unique identifier of a transformation. (required)

  • transformation_create (TransformationCreate) —

    (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:



3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
 
# File 'lib/algolia/api/ingestion_client.rb', line 3063

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

  path = "/1/transformations/{transformationID}".sub(
    "{" + "transformationID" + "}",
    Transport.encode_uri(transformation_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(transformation_create)

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

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

#validate_source(source_create = nil, request_options = {}) ⇒ WatchResponse

Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_create (SourceCreate) (defaults to: nil)
  • 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:

  • (WatchResponse) 


3148
3149
3150
3151
 
# File 'lib/algolia/api/ingestion_client.rb', line 3148

def validate_source(source_create = nil, request_options = {})
  response = validate_source_with_http_info(source_create, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::WatchResponse")
end

#validate_source_before_update(source_id, source_update, request_options = {}) ⇒ WatchResponse

Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.

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:

  • (WatchResponse) 


3203
3204
3205
3206
 
# File 'lib/algolia/api/ingestion_client.rb', line 3203

def validate_source_before_update(source_id, source_update, request_options = {})
  response = validate_source_before_update_with_http_info(source_id, source_update, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::WatchResponse")
end

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

Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.

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:



3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
 
# File 'lib/algolia/api/ingestion_client.rb', line 3163

def validate_source_before_update_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 `validate_source_before_update`."
  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 `validate_source_before_update`."
  end

  path = "/1/sources/{sourceID}/validate".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?
  request_options[:timeout] ||= 180000

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

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

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

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

Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_create (SourceCreate) (defaults to: nil)
  • 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:



3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
 
# File 'lib/algolia/api/ingestion_client.rb', line 3118

def validate_source_with_http_info(source_create = nil, request_options = {})
  path = "/1/sources/validate"
  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?
  request_options[:timeout] ||= 180000

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

  new_options = request_options.merge(
    :operation => :"IngestionClient.validate_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