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



38
39
40
 
# File 'lib/algolia/api/ingestion_client.rb', line 38

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

Instance Method Details

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

Creates a new authentication resource.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • authentication_create (AuthenticationCreate) —

    (required)

  • request_options: —

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

Returns:

  • (AuthenticationCreateResponse) 


85
86
87
88
89
90
91
 
# File 'lib/algolia/api/ingestion_client.rb', line 85

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:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/algolia/api/ingestion_client.rb', line 51

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) 


136
137
138
139
140
141
142
 
# File 'lib/algolia/api/ingestion_client.rb', line 136

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:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/algolia/api/ingestion_client.rb', line 102

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) 


187
188
189
190
 
# File 'lib/algolia/api/ingestion_client.rb', line 187

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:



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/algolia/api/ingestion_client.rb', line 153

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) 


227
228
229
230
 
# File 'lib/algolia/api/ingestion_client.rb', line 227

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) 


267
268
269
270
 
# File 'lib/algolia/api/ingestion_client.rb', line 267

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:



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/algolia/api/ingestion_client.rb', line 237

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:



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/algolia/api/ingestion_client.rb', line 197

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) 


307
308
309
310
311
312
313
 
# File 'lib/algolia/api/ingestion_client.rb', line 307

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:



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/algolia/api/ingestion_client.rb', line 277

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 &quot;/1&quot; must be specified. (required)

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

    Query parameters to apply to the current query.

  • request_options: —

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

Returns:

  • (Object) 


353
354
355
356
 
# File 'lib/algolia/api/ingestion_client.rb', line 353

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

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

Returns the response.

Parameters:

  • path (String) —

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

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

    Query parameters to apply to the current query.

  • request_options: —

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

Returns:



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/algolia/api/ingestion_client.rb', line 321

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

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

  post_body = request_options[:debug_body]

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

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

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

Parameters:

  • path (String) —

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

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

    Query parameters to apply to the current query.

  • request_options: —

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

Returns:

  • (Object) 


396
397
398
399
 
# File 'lib/algolia/api/ingestion_client.rb', line 396

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

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

Returns the response.

Parameters:

  • path (String) —

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

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

    Query parameters to apply to the current query.

  • request_options: —

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

Returns:



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/algolia/api/ingestion_client.rb', line 364

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

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

  post_body = request_options[:debug_body]

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

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

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

Parameters:

  • path (String) —

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

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

    Query parameters to apply to the current query.

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

    Parameters to send with the custom request.

  • request_options: —

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

Returns:

  • (Object) 


441
442
443
444
 
# File 'lib/algolia/api/ingestion_client.rb', line 441

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

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

Returns the response.

Parameters:

  • path (String) —

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

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

    Query parameters to apply to the current query.

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

    Parameters to send with the custom request.

  • request_options: —

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

Returns:



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

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

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

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

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

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

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

Parameters:

  • path (String) —

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

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

    Query parameters to apply to the current query.

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

    Parameters to send with the custom request.

  • request_options: —

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

Returns:

  • (Object) 


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

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

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

Returns the response.

Parameters:

  • path (String) —

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

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

    Query parameters to apply to the current query.

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

    Parameters to send with the custom request.

  • request_options: —

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

Returns:



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

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) 


537
538
539
540
 
# File 'lib/algolia/api/ingestion_client.rb', line 537

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

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

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

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • authentication_id (String) —

    Unique identifier of an authentication resource. (required)

  • request_options: —

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

Returns:



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

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) 


588
589
590
591
 
# File 'lib/algolia/api/ingestion_client.rb', line 588

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

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

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

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • destination_id (String) —

    Unique identifier of a destination. (required)

  • request_options: —

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

Returns:



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/algolia/api/ingestion_client.rb', line 551

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) 


636
637
638
639
 
# File 'lib/algolia/api/ingestion_client.rb', line 636

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

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

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

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • request_options: —

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

Returns:



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/algolia/api/ingestion_client.rb', line 602

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) 


676
677
678
679
 
# File 'lib/algolia/api/ingestion_client.rb', line 676

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) 


716
717
718
719
 
# File 'lib/algolia/api/ingestion_client.rb', line 716

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:



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

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:



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/algolia/api/ingestion_client.rb', line 646

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) 


759
760
761
762
 
# File 'lib/algolia/api/ingestion_client.rb', line 759

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:



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/algolia/api/ingestion_client.rb', line 726

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) 


807
808
809
810
 
# File 'lib/algolia/api/ingestion_client.rb', line 807

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) 


855
856
857
858
 
# File 'lib/algolia/api/ingestion_client.rb', line 855

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 &#x60;disableTask&#x60; 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:



821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
 
# File 'lib/algolia/api/ingestion_client.rb', line 821

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:



773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/algolia/api/ingestion_client.rb', line 773

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) 


903
904
905
906
 
# File 'lib/algolia/api/ingestion_client.rb', line 903

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) 


951
952
953
954
 
# File 'lib/algolia/api/ingestion_client.rb', line 951

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 &#x60;enableTask&#x60; 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:



917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
 
# File 'lib/algolia/api/ingestion_client.rb', line 917

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:



869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/algolia/api/ingestion_client.rb', line 869

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

#generate_transformation_code(generate_transformation_code_payload, request_options = {}) ⇒ GenerateTransformationCodeResponse

Generates code for the selected model based on the given prompt.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • generate_transformation_code_payload (GenerateTransformationCodePayload) —

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

  • (GenerateTransformationCodeResponse) 


1002
1003
1004
1005
1006
1007
1008
 
# File 'lib/algolia/api/ingestion_client.rb', line 1002

def generate_transformation_code(generate_transformation_code_payload, request_options = {})
  response = generate_transformation_code_with_http_info(generate_transformation_code_payload, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Ingestion::GenerateTransformationCodeResponse"
  )
end

#generate_transformation_code_with_http_info(generate_transformation_code_payload, request_options = {}) ⇒ Http::Response

Generates code for the selected model based on the given prompt.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • generate_transformation_code_payload (GenerateTransformationCodePayload) —

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



965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
 
# File 'lib/algolia/api/ingestion_client.rb', line 965

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

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

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

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


1056
1057
1058
1059
 
# File 'lib/algolia/api/ingestion_client.rb', line 1056

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:



1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
 
# File 'lib/algolia/api/ingestion_client.rb', line 1019

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) 


1107
1108
1109
1110
 
# File 'lib/algolia/api/ingestion_client.rb', line 1107

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:



1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
 
# File 'lib/algolia/api/ingestion_client.rb', line 1070

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) 


1164
1165
1166
1167
 
# File 'lib/algolia/api/ingestion_client.rb', line 1164

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:



1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
 
# File 'lib/algolia/api/ingestion_client.rb', line 1122

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) 


1212
1213
1214
1215
 
# File 'lib/algolia/api/ingestion_client.rb', line 1212

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:



1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'lib/algolia/api/ingestion_client.rb', line 1178

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) 


1260
1261
1262
1263
 
# File 'lib/algolia/api/ingestion_client.rb', line 1260

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:



1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'lib/algolia/api/ingestion_client.rb', line 1226

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) 


1308
1309
1310
1311
 
# File 'lib/algolia/api/ingestion_client.rb', line 1308

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) 


1356
1357
1358
1359
 
# File 'lib/algolia/api/ingestion_client.rb', line 1356

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 &#x60;getTask&#x60; 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:



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'lib/algolia/api/ingestion_client.rb', line 1322

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:



1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/algolia/api/ingestion_client.rb', line 1274

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) 


1407
1408
1409
1410
 
# File 'lib/algolia/api/ingestion_client.rb', line 1407

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:



1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
 
# File 'lib/algolia/api/ingestion_client.rb', line 1370

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 authentication resources.

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

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

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

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

  • request_options: —

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

Returns:

  • (ListAuthenticationsResponse) 


1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
 
# File 'lib/algolia/api/ingestion_client.rb', line 1495

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 authentication resources.

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

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

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

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

  • request_options: —

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

Returns:



1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'lib/algolia/api/ingestion_client.rb', line 1426

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

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

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

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

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"IngestionClient.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, sort = nil, order = nil, request_options = {}) ⇒ ListDestinationsResponse

Retrieves a list of destinations.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

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

    Number of items per page. (default to 10)

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

    Page number of the paginated API response.

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

    Destination type.

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

    Authentication ID used by destinations.

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

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

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

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

  • request_options: —

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

Returns:

  • (ListDestinationsResponse) 


1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
 
# File 'lib/algolia/api/ingestion_client.rb', line 1597

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

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

Retrieves a list of destinations.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

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

    Number of items per page. (default to 10)

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

    Page number of the paginated API response.

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

    Destination type.

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

    Authentication ID used by destinations.

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

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

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

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

  • request_options: —

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

Returns:



1525
1526
1527
1528
1529
1530
1531
1532
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
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
 
# File 'lib/algolia/api/ingestion_client.rb', line 1525

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

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

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

  path = "/1/destinations"
  query_params = {}
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
  query_params[:page] = page unless page.nil?
  query_params[:type] = @api_client.build_collection_param(type, :csv) unless type.nil?
  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_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 it’s ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • run_id (String) —

    Unique identifier of a task run. (required)

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

    Number of items per page. (default to 10)

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

    Page number of the paginated API response.

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

    Event status for filtering the list of task runs.

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

    Event type for filtering the list of task runs.

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

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

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

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

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

    Date and time in 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) 


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

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 it&#39;s ID.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • run_id (String) —

    Unique identifier of a task run. (required)

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

    Number of items per page. (default to 10)

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

    Page number of the paginated API response.

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

    Event status for filtering the list of task runs.

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

    Event type for filtering the list of task runs.

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

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

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

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

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

    Date and time in 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:



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
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/algolia/api/ingestion_client.rb', line 1638

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

  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
    raise(
      ArgumentError,
      "invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_events, must be smaller than or equal to 100."
    )
  end

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

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

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

  post_body = request_options[:debug_body]

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


1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
 
# File 'lib/algolia/api/ingestion_client.rb', line 1842

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:



1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
 
# File 'lib/algolia/api/ingestion_client.rb', line 1764

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 = {}
)
  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
    raise(
      ArgumentError,
      "invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_runs, must be smaller than or equal to 100."
    )
  end

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

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

  path = "/1/runs"
  query_params = {}
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
  query_params[:page] = page unless page.nil?
  query_params[:status] = @api_client.build_collection_param(status, :multi) unless status.nil?
  query_params[: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. &#39;none&#39; returns sources that doesn&#39;t have an authentication resource.

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

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

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

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

  • request_options: —

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

Returns:

  • (ListSourcesResponse) 


1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
 
# File 'lib/algolia/api/ingestion_client.rb', line 1955

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. &#39;none&#39; returns sources that doesn&#39;t have an authentication resource.

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

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

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

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

  • request_options: —

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

Returns:



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
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
 
# File 'lib/algolia/api/ingestion_client.rb', line 1883

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

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

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

  path = "/1/sources"
  query_params = {}
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
  query_params[:page] = page unless page.nil?
  query_params[:type] = @api_client.build_collection_param(type, :csv) unless type.nil?
  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, destination_id = nil, trigger_type = nil, sort = nil, order = nil, request_options = {}) ⇒ ListTasksResponse

Retrieves a list of tasks.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

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

    Number of items per page. (default to 10)

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

    Page number of the paginated API response.

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

    Actions for filtering the list of tasks.

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

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

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

    Source IDs for filtering the list of tasks.

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

    Destination IDs for filtering the list of tasks.

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

    Type of task trigger for filtering the list of tasks.

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

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

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

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

  • request_options: —

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

Returns:

  • (ListTasksResponse) 


2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
 
# File 'lib/algolia/api/ingestion_client.rb', line 2074

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

#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 &#x60;enabled&#x60; status.

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

    Source IDs for filtering the list of tasks.

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

    Destination IDs for filtering the list of tasks.

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

    Type of task trigger for filtering the list of tasks.

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

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

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

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

  • request_options: —

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

Returns:

  • (ListTasksResponseV1) 


2199
2200
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 2199

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 &#x60;getTasks&#x60; 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 &#x60;enabled&#x60; status.

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

    Source IDs for filtering the list of tasks.

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

    Destination IDs for filtering the list of tasks.

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

    Type of task trigger for filtering the list of tasks.

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

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

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

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

  • request_options: —

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

Returns:



2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
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
2174
2175
2176
2177
2178
2179
2180
 
# File 'lib/algolia/api/ingestion_client.rb', line 2118

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 = {}
)
  if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
    raise(
      ArgumentError,
      "invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_tasks_v1, must be smaller than or equal to 100."
    )
  end

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

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

  path = "/1/tasks"
  query_params = {}
  query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
  query_params[:page] = page unless page.nil?
  query_params[:action] = @api_client.build_collection_param(action, :csv) unless action.nil?
  query_params[:enabled] = enabled unless enabled.nil?
  query_params[:sourceID] = @api_client.build_collection_param(source_id, :csv) unless source_id.nil?
  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, destination_id = nil, trigger_type = nil, sort = nil, order = nil, request_options = {}) ⇒ Http::Response

Retrieves a list of tasks.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

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

    Number of items per page. (default to 10)

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

    Page number of the paginated API response.

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

    Actions for filtering the list of tasks.

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

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

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

    Source IDs for filtering the list of tasks.

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

    Destination IDs for filtering the list of tasks.

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

    Type of task trigger for filtering the list of tasks.

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

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

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

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

  • request_options: —

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

Returns:



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
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/algolia/api/ingestion_client.rb', line 1993

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

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

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

  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?
  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",
    :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_transformation_models(request_options = {}) ⇒ TransformationModels

Retrieves a list of existing LLM transformation helpers.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

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

  • (TransformationModels) 


2262
2263
2264
2265
 
# File 'lib/algolia/api/ingestion_client.rb', line 2262

def list_transformation_models(request_options = {})
  response = list_transformation_models_with_http_info(request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::TransformationModels")
end

#list_transformation_models_with_http_info(request_options = {}) ⇒ Http::Response

Retrieves a list of existing LLM transformation helpers.

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

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



2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
 
# File 'lib/algolia/api/ingestion_client.rb', line 2234

def list_transformation_models_with_http_info(request_options = {})
  path = "/1/transformations/models"
  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.list_transformation_models",
    :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 (SortKeys) (defaults to: nil) —

    Property by which to sort the list. (default to ‘desc’)

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


2342
2343
2344
2345
2346
2347
2348
 
# File 'lib/algolia/api/ingestion_client.rb', line 2342

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 (SortKeys) (defaults to: nil) —

    Property by which to sort the list. (default to ‘desc’)

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



2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
 
# File 'lib/algolia/api/ingestion_client.rb', line 2279

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

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

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

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

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 &#x60;batch&#x60; request that will be pushed in the Connectors pipeline. (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) 


2399
2400
2401
2402
 
# File 'lib/algolia/api/ingestion_client.rb', line 2399

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

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

Push a &#x60;batch&#x60; 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 &#x60;batch&#x60; request that will be pushed in the Connectors pipeline. (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:



2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
 
# File 'lib/algolia/api/ingestion_client.rb', line 2360

def push_task_with_http_info(task_id, push_task_payload, 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 = 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(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) 


2449
2450
2451
2452
 
# File 'lib/algolia/api/ingestion_client.rb', line 2449

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:



2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
 
# File 'lib/algolia/api/ingestion_client.rb', line 2414

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) 


2497
2498
2499
2500
 
# File 'lib/algolia/api/ingestion_client.rb', line 2497

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) 


2545
2546
2547
2548
 
# File 'lib/algolia/api/ingestion_client.rb', line 2545

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 &#x60;runTask&#x60; 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:



2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
 
# File 'lib/algolia/api/ingestion_client.rb', line 2511

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:



2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
 
# File 'lib/algolia/api/ingestion_client.rb', line 2463

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


2593
2594
2595
2596
 
# File 'lib/algolia/api/ingestion_client.rb', line 2593

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:



2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
 
# File 'lib/algolia/api/ingestion_client.rb', line 2559

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


2641
2642
2643
2644
 
# File 'lib/algolia/api/ingestion_client.rb', line 2641

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:



2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
 
# File 'lib/algolia/api/ingestion_client.rb', line 2607

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


2689
2690
2691
2692
 
# File 'lib/algolia/api/ingestion_client.rb', line 2689

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:



2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
 
# File 'lib/algolia/api/ingestion_client.rb', line 2655

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


2737
2738
2739
2740
 
# File 'lib/algolia/api/ingestion_client.rb', line 2737

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


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

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 &#x60;searchTasks&#x60; 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:



2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
 
# File 'lib/algolia/api/ingestion_client.rb', line 2751

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:



2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
 
# File 'lib/algolia/api/ingestion_client.rb', line 2703

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


2833
2834
2835
2836
 
# File 'lib/algolia/api/ingestion_client.rb', line 2833

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:



2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
 
# File 'lib/algolia/api/ingestion_client.rb', line 2799

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

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

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

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • request_options: —

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

Returns:

  • (SourceWatchResponse) 


2881
2882
2883
2884
 
# File 'lib/algolia/api/ingestion_client.rb', line 2881

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::SourceWatchResponse")
end

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

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

Required API Key ACLs:

- addObject
- deleteIndex
- editSettings

Parameters:

  • source_id (String) —

    Unique identifier of a source. (required)

  • request_options: —

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

Returns:



2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
 
# File 'lib/algolia/api/ingestion_client.rb', line 2847

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

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

  post_body = request_options[:debug_body]

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

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

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


2929
2930
2931
2932
2933
2934
2935
 
# File 'lib/algolia/api/ingestion_client.rb', line 2929

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) 


2995
2996
2997
2998
2999
3000
3001
 
# File 'lib/algolia/api/ingestion_client.rb', line 2995

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:



2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
 
# File 'lib/algolia/api/ingestion_client.rb', line 2947

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:



2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
 
# File 'lib/algolia/api/ingestion_client.rb', line 2895

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) 


3055
3056
3057
3058
3059
3060
3061
 
# File 'lib/algolia/api/ingestion_client.rb', line 3055

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:



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

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) 


3115
3116
3117
3118
3119
3120
3121
 
# File 'lib/algolia/api/ingestion_client.rb', line 3115

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:



3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
 
# File 'lib/algolia/api/ingestion_client.rb', line 3073

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) 


3172
3173
3174
3175
 
# File 'lib/algolia/api/ingestion_client.rb', line 3172

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:



3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
 
# File 'lib/algolia/api/ingestion_client.rb', line 3133

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) 


3218
3219
3220
3221
 
# File 'lib/algolia/api/ingestion_client.rb', line 3218

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) 


3264
3265
3266
3267
 
# File 'lib/algolia/api/ingestion_client.rb', line 3264

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:



3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
 
# File 'lib/algolia/api/ingestion_client.rb', line 3229

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:



3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
 
# File 'lib/algolia/api/ingestion_client.rb', line 3183

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) 


3313
3314
3315
3316
3317
3318
3319
 
# File 'lib/algolia/api/ingestion_client.rb', line 3313

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:



3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
 
# File 'lib/algolia/api/ingestion_client.rb', line 3275

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 = {}) ⇒ SourceWatchResponse

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:

  • (SourceWatchResponse) 


3359
3360
3361
3362
 
# File 'lib/algolia/api/ingestion_client.rb', line 3359

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::SourceWatchResponse")
end

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

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:

  • (SourceWatchResponse) 


3413
3414
3415
3416
 
# File 'lib/algolia/api/ingestion_client.rb', line 3413

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::SourceWatchResponse")
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:



3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
 
# File 'lib/algolia/api/ingestion_client.rb', line 3374

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?

  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:



3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
 
# File 'lib/algolia/api/ingestion_client.rb', line 3330

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?

  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