@algolia/ingestion 1.55.1 → 1.56.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/browser.d.ts +954 -7
- package/dist/builds/browser.js +2241 -208
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +5 -5
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +9 -9
- package/dist/builds/fetch.js +2241 -208
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +2241 -208
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +2241 -208
- package/dist/builds/node.js.map +1 -1
- package/dist/builds/worker.js +2241 -208
- package/dist/builds/worker.js.map +1 -1
- package/dist/fetch.d.ts +954 -7
- package/dist/node.d.cts +954 -7
- package/dist/node.d.ts +954 -7
- package/dist/src/ingestionClient.cjs +2241 -208
- package/dist/src/ingestionClient.cjs.map +1 -1
- package/dist/src/ingestionClient.js +2241 -208
- package/dist/src/ingestionClient.js.map +1 -1
- package/dist/worker.d.ts +954 -7
- package/package.json +9 -9
package/dist/builds/worker.js
CHANGED
|
@@ -10,7 +10,7 @@ import {
|
|
|
10
10
|
getAlgoliaAgent,
|
|
11
11
|
validateRequired
|
|
12
12
|
} from "@algolia/client-common";
|
|
13
|
-
var apiClientVersion = "1.
|
|
13
|
+
var apiClientVersion = "1.56.0";
|
|
14
14
|
var REGIONS = ["eu", "us"];
|
|
15
15
|
function getDefaultHosts(region) {
|
|
16
16
|
const url = "data.{region}.algolia.com".replace("{region}", region);
|
|
@@ -119,10 +119,41 @@ function createIngestionClient({
|
|
|
119
119
|
referenceIndexName,
|
|
120
120
|
maxRetries = 100
|
|
121
121
|
}, requestOptions) {
|
|
122
|
+
if (batchSize < 1) {
|
|
123
|
+
throw new Error("`batchSize` must be at least 1.");
|
|
124
|
+
}
|
|
122
125
|
let records = [];
|
|
123
126
|
let offset = 0;
|
|
124
127
|
const responses = [];
|
|
125
128
|
const waitBatchSize = Math.floor(batchSize / 10) || batchSize;
|
|
129
|
+
const waitForBatch = async (start, end) => {
|
|
130
|
+
for (const resp of responses.slice(start, end)) {
|
|
131
|
+
if (!resp.eventID) {
|
|
132
|
+
throw new Error("received unexpected response from the push endpoint, eventID must not be undefined");
|
|
133
|
+
}
|
|
134
|
+
let retryCount = 0;
|
|
135
|
+
await createIterablePromise({
|
|
136
|
+
func: async () => {
|
|
137
|
+
if (resp.eventID === void 0 || !resp.eventID) {
|
|
138
|
+
throw new Error("received unexpected response from the push endpoint, eventID must not be undefined");
|
|
139
|
+
}
|
|
140
|
+
return this.getEvent({ runID: resp.runID, eventID: resp.eventID }).catch((error) => {
|
|
141
|
+
if (error.status === 404) {
|
|
142
|
+
return void 0;
|
|
143
|
+
}
|
|
144
|
+
throw error;
|
|
145
|
+
});
|
|
146
|
+
},
|
|
147
|
+
validate: (response) => response !== void 0,
|
|
148
|
+
aggregator: () => retryCount += 1,
|
|
149
|
+
error: {
|
|
150
|
+
validate: () => retryCount >= maxRetries,
|
|
151
|
+
message: () => `Stopped waiting for the task after ${maxRetries} retries. This does not mean the operation failed; it may still complete. If you need to keep polling, retry with a higher maxRetries.`
|
|
152
|
+
},
|
|
153
|
+
timeout: () => Math.min(retryCount * 1500, 5e3)
|
|
154
|
+
});
|
|
155
|
+
}
|
|
156
|
+
};
|
|
126
157
|
const objectEntries = objects.entries();
|
|
127
158
|
for (const [i, obj] of objectEntries) {
|
|
128
159
|
records.push(obj);
|
|
@@ -132,36 +163,14 @@ function createIngestionClient({
|
|
|
132
163
|
);
|
|
133
164
|
records = [];
|
|
134
165
|
}
|
|
135
|
-
if (waitForTasks && responses.length
|
|
136
|
-
|
|
137
|
-
if (!resp.eventID) {
|
|
138
|
-
throw new Error("received unexpected response from the push endpoint, eventID must not be undefined");
|
|
139
|
-
}
|
|
140
|
-
let retryCount = 0;
|
|
141
|
-
await createIterablePromise({
|
|
142
|
-
func: async () => {
|
|
143
|
-
if (resp.eventID === void 0 || !resp.eventID) {
|
|
144
|
-
throw new Error("received unexpected response from the push endpoint, eventID must not be undefined");
|
|
145
|
-
}
|
|
146
|
-
return this.getEvent({ runID: resp.runID, eventID: resp.eventID }).catch((error) => {
|
|
147
|
-
if (error.status === 404) {
|
|
148
|
-
return void 0;
|
|
149
|
-
}
|
|
150
|
-
throw error;
|
|
151
|
-
});
|
|
152
|
-
},
|
|
153
|
-
validate: (response) => response !== void 0,
|
|
154
|
-
aggregator: () => retryCount += 1,
|
|
155
|
-
error: {
|
|
156
|
-
validate: () => retryCount >= maxRetries,
|
|
157
|
-
message: () => `Stopped waiting for the task after ${maxRetries} retries. This does not mean the operation failed; it may still complete. If you need to keep polling, retry with a higher maxRetries.`
|
|
158
|
-
},
|
|
159
|
-
timeout: () => Math.min(retryCount * 1500, 5e3)
|
|
160
|
-
});
|
|
161
|
-
}
|
|
166
|
+
if (waitForTasks && responses.length - offset >= waitBatchSize) {
|
|
167
|
+
await waitForBatch(offset, offset + waitBatchSize);
|
|
162
168
|
offset += waitBatchSize;
|
|
163
169
|
}
|
|
164
170
|
}
|
|
171
|
+
if (waitForTasks) {
|
|
172
|
+
await waitForBatch(offset, responses.length);
|
|
173
|
+
}
|
|
165
174
|
return responses;
|
|
166
175
|
},
|
|
167
176
|
/**
|
|
@@ -191,6 +200,36 @@ function createIngestionClient({
|
|
|
191
200
|
};
|
|
192
201
|
return transporter.request(request, requestOptions);
|
|
193
202
|
},
|
|
203
|
+
/**
|
|
204
|
+
* Creates a new authentication resource.
|
|
205
|
+
*
|
|
206
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
207
|
+
*
|
|
208
|
+
* Required API Key ACLs:
|
|
209
|
+
* - addObject
|
|
210
|
+
* - deleteIndex
|
|
211
|
+
* - editSettings
|
|
212
|
+
* @param authenticationCreate -
|
|
213
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
214
|
+
* @see createAuthentication for the plain version.
|
|
215
|
+
*/
|
|
216
|
+
createAuthenticationWithHTTPInfo(authenticationCreate, requestOptions) {
|
|
217
|
+
validateRequired("authenticationCreate", "createAuthenticationWithHTTPInfo", authenticationCreate);
|
|
218
|
+
validateRequired("authenticationCreate.type", "createAuthenticationWithHTTPInfo", authenticationCreate.type);
|
|
219
|
+
validateRequired("authenticationCreate.name", "createAuthenticationWithHTTPInfo", authenticationCreate.name);
|
|
220
|
+
validateRequired("authenticationCreate.input", "createAuthenticationWithHTTPInfo", authenticationCreate.input);
|
|
221
|
+
const requestPath = "/1/authentications";
|
|
222
|
+
const headers = {};
|
|
223
|
+
const queryParameters = {};
|
|
224
|
+
const request = {
|
|
225
|
+
method: "POST",
|
|
226
|
+
path: requestPath,
|
|
227
|
+
queryParameters,
|
|
228
|
+
headers,
|
|
229
|
+
data: authenticationCreate
|
|
230
|
+
};
|
|
231
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
232
|
+
},
|
|
194
233
|
/**
|
|
195
234
|
* Creates a new destination.
|
|
196
235
|
*
|
|
@@ -218,6 +257,36 @@ function createIngestionClient({
|
|
|
218
257
|
};
|
|
219
258
|
return transporter.request(request, requestOptions);
|
|
220
259
|
},
|
|
260
|
+
/**
|
|
261
|
+
* Creates a new destination.
|
|
262
|
+
*
|
|
263
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
264
|
+
*
|
|
265
|
+
* Required API Key ACLs:
|
|
266
|
+
* - addObject
|
|
267
|
+
* - deleteIndex
|
|
268
|
+
* - editSettings
|
|
269
|
+
* @param destinationCreate -
|
|
270
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
271
|
+
* @see createDestination for the plain version.
|
|
272
|
+
*/
|
|
273
|
+
createDestinationWithHTTPInfo(destinationCreate, requestOptions) {
|
|
274
|
+
validateRequired("destinationCreate", "createDestinationWithHTTPInfo", destinationCreate);
|
|
275
|
+
validateRequired("destinationCreate.type", "createDestinationWithHTTPInfo", destinationCreate.type);
|
|
276
|
+
validateRequired("destinationCreate.name", "createDestinationWithHTTPInfo", destinationCreate.name);
|
|
277
|
+
validateRequired("destinationCreate.input", "createDestinationWithHTTPInfo", destinationCreate.input);
|
|
278
|
+
const requestPath = "/1/destinations";
|
|
279
|
+
const headers = {};
|
|
280
|
+
const queryParameters = {};
|
|
281
|
+
const request = {
|
|
282
|
+
method: "POST",
|
|
283
|
+
path: requestPath,
|
|
284
|
+
queryParameters,
|
|
285
|
+
headers,
|
|
286
|
+
data: destinationCreate
|
|
287
|
+
};
|
|
288
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
289
|
+
},
|
|
221
290
|
/**
|
|
222
291
|
* Creates a new source.
|
|
223
292
|
*
|
|
@@ -244,6 +313,35 @@ function createIngestionClient({
|
|
|
244
313
|
};
|
|
245
314
|
return transporter.request(request, requestOptions);
|
|
246
315
|
},
|
|
316
|
+
/**
|
|
317
|
+
* Creates a new source.
|
|
318
|
+
*
|
|
319
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
320
|
+
*
|
|
321
|
+
* Required API Key ACLs:
|
|
322
|
+
* - addObject
|
|
323
|
+
* - deleteIndex
|
|
324
|
+
* - editSettings
|
|
325
|
+
* @param sourceCreate -
|
|
326
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
327
|
+
* @see createSource for the plain version.
|
|
328
|
+
*/
|
|
329
|
+
createSourceWithHTTPInfo(sourceCreate, requestOptions) {
|
|
330
|
+
validateRequired("sourceCreate", "createSourceWithHTTPInfo", sourceCreate);
|
|
331
|
+
validateRequired("sourceCreate.type", "createSourceWithHTTPInfo", sourceCreate.type);
|
|
332
|
+
validateRequired("sourceCreate.name", "createSourceWithHTTPInfo", sourceCreate.name);
|
|
333
|
+
const requestPath = "/1/sources";
|
|
334
|
+
const headers = {};
|
|
335
|
+
const queryParameters = {};
|
|
336
|
+
const request = {
|
|
337
|
+
method: "POST",
|
|
338
|
+
path: requestPath,
|
|
339
|
+
queryParameters,
|
|
340
|
+
headers,
|
|
341
|
+
data: sourceCreate
|
|
342
|
+
};
|
|
343
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
344
|
+
},
|
|
247
345
|
/**
|
|
248
346
|
* Creates a new task.
|
|
249
347
|
*
|
|
@@ -271,6 +369,36 @@ function createIngestionClient({
|
|
|
271
369
|
};
|
|
272
370
|
return transporter.request(request, requestOptions);
|
|
273
371
|
},
|
|
372
|
+
/**
|
|
373
|
+
* Creates a new task.
|
|
374
|
+
*
|
|
375
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
376
|
+
*
|
|
377
|
+
* Required API Key ACLs:
|
|
378
|
+
* - addObject
|
|
379
|
+
* - deleteIndex
|
|
380
|
+
* - editSettings
|
|
381
|
+
* @param taskCreate - Request body for creating a task.
|
|
382
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
383
|
+
* @see createTask for the plain version.
|
|
384
|
+
*/
|
|
385
|
+
createTaskWithHTTPInfo(taskCreate, requestOptions) {
|
|
386
|
+
validateRequired("taskCreate", "createTaskWithHTTPInfo", taskCreate);
|
|
387
|
+
validateRequired("taskCreate.sourceID", "createTaskWithHTTPInfo", taskCreate.sourceID);
|
|
388
|
+
validateRequired("taskCreate.destinationID", "createTaskWithHTTPInfo", taskCreate.destinationID);
|
|
389
|
+
validateRequired("taskCreate.action", "createTaskWithHTTPInfo", taskCreate.action);
|
|
390
|
+
const requestPath = "/2/tasks";
|
|
391
|
+
const headers = {};
|
|
392
|
+
const queryParameters = {};
|
|
393
|
+
const request = {
|
|
394
|
+
method: "POST",
|
|
395
|
+
path: requestPath,
|
|
396
|
+
queryParameters,
|
|
397
|
+
headers,
|
|
398
|
+
data: taskCreate
|
|
399
|
+
};
|
|
400
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
401
|
+
},
|
|
274
402
|
/**
|
|
275
403
|
* Creates a new task using the v1 endpoint. Use `createTask` instead.
|
|
276
404
|
*
|
|
@@ -301,6 +429,39 @@ function createIngestionClient({
|
|
|
301
429
|
};
|
|
302
430
|
return transporter.request(request, requestOptions);
|
|
303
431
|
},
|
|
432
|
+
/**
|
|
433
|
+
* Creates a new task using the v1 endpoint. Use `createTask` instead.
|
|
434
|
+
*
|
|
435
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
436
|
+
*
|
|
437
|
+
* Required API Key ACLs:
|
|
438
|
+
* - addObject
|
|
439
|
+
* - deleteIndex
|
|
440
|
+
* - editSettings
|
|
441
|
+
*
|
|
442
|
+
* @deprecated
|
|
443
|
+
* @param taskCreate - Request body for creating a task.
|
|
444
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
445
|
+
* @see createTaskV1 for the plain version.
|
|
446
|
+
*/
|
|
447
|
+
createTaskV1WithHTTPInfo(taskCreate, requestOptions) {
|
|
448
|
+
validateRequired("taskCreate", "createTaskV1WithHTTPInfo", taskCreate);
|
|
449
|
+
validateRequired("taskCreate.sourceID", "createTaskV1WithHTTPInfo", taskCreate.sourceID);
|
|
450
|
+
validateRequired("taskCreate.destinationID", "createTaskV1WithHTTPInfo", taskCreate.destinationID);
|
|
451
|
+
validateRequired("taskCreate.trigger", "createTaskV1WithHTTPInfo", taskCreate.trigger);
|
|
452
|
+
validateRequired("taskCreate.action", "createTaskV1WithHTTPInfo", taskCreate.action);
|
|
453
|
+
const requestPath = "/1/tasks";
|
|
454
|
+
const headers = {};
|
|
455
|
+
const queryParameters = {};
|
|
456
|
+
const request = {
|
|
457
|
+
method: "POST",
|
|
458
|
+
path: requestPath,
|
|
459
|
+
queryParameters,
|
|
460
|
+
headers,
|
|
461
|
+
data: taskCreate
|
|
462
|
+
};
|
|
463
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
464
|
+
},
|
|
304
465
|
/**
|
|
305
466
|
* Creates a new transformation.
|
|
306
467
|
*
|
|
@@ -326,6 +487,34 @@ function createIngestionClient({
|
|
|
326
487
|
};
|
|
327
488
|
return transporter.request(request, requestOptions);
|
|
328
489
|
},
|
|
490
|
+
/**
|
|
491
|
+
* Creates a new transformation.
|
|
492
|
+
*
|
|
493
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
494
|
+
*
|
|
495
|
+
* Required API Key ACLs:
|
|
496
|
+
* - addObject
|
|
497
|
+
* - deleteIndex
|
|
498
|
+
* - editSettings
|
|
499
|
+
* @param transformationCreate - Request body for creating a transformation.
|
|
500
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
501
|
+
* @see createTransformation for the plain version.
|
|
502
|
+
*/
|
|
503
|
+
createTransformationWithHTTPInfo(transformationCreate, requestOptions) {
|
|
504
|
+
validateRequired("transformationCreate", "createTransformationWithHTTPInfo", transformationCreate);
|
|
505
|
+
validateRequired("transformationCreate.name", "createTransformationWithHTTPInfo", transformationCreate.name);
|
|
506
|
+
const requestPath = "/1/transformations";
|
|
507
|
+
const headers = {};
|
|
508
|
+
const queryParameters = {};
|
|
509
|
+
const request = {
|
|
510
|
+
method: "POST",
|
|
511
|
+
path: requestPath,
|
|
512
|
+
queryParameters,
|
|
513
|
+
headers,
|
|
514
|
+
data: transformationCreate
|
|
515
|
+
};
|
|
516
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
517
|
+
},
|
|
329
518
|
/**
|
|
330
519
|
* This method lets you send requests to the Algolia REST API.
|
|
331
520
|
* @param customDelete - The customDelete object.
|
|
@@ -346,6 +535,29 @@ function createIngestionClient({
|
|
|
346
535
|
};
|
|
347
536
|
return transporter.request(request, requestOptions);
|
|
348
537
|
},
|
|
538
|
+
/**
|
|
539
|
+
* This method lets you send requests to the Algolia REST API.
|
|
540
|
+
*
|
|
541
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
542
|
+
* @param customDelete - The customDelete object.
|
|
543
|
+
* @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
|
|
544
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
545
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
546
|
+
* @see customDelete for the plain version.
|
|
547
|
+
*/
|
|
548
|
+
customDeleteWithHTTPInfo({ path, parameters }, requestOptions) {
|
|
549
|
+
validateRequired("path", "customDeleteWithHTTPInfo", path);
|
|
550
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
551
|
+
const headers = {};
|
|
552
|
+
const queryParameters = parameters ? parameters : {};
|
|
553
|
+
const request = {
|
|
554
|
+
method: "DELETE",
|
|
555
|
+
path: requestPath,
|
|
556
|
+
queryParameters,
|
|
557
|
+
headers
|
|
558
|
+
};
|
|
559
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
560
|
+
},
|
|
349
561
|
/**
|
|
350
562
|
* This method lets you send requests to the Algolia REST API.
|
|
351
563
|
* @param customGet - The customGet object.
|
|
@@ -366,6 +578,29 @@ function createIngestionClient({
|
|
|
366
578
|
};
|
|
367
579
|
return transporter.request(request, requestOptions);
|
|
368
580
|
},
|
|
581
|
+
/**
|
|
582
|
+
* This method lets you send requests to the Algolia REST API.
|
|
583
|
+
*
|
|
584
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
585
|
+
* @param customGet - The customGet object.
|
|
586
|
+
* @param customGet.path - Path of the endpoint, for example `1/newFeature`.
|
|
587
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
588
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
589
|
+
* @see customGet for the plain version.
|
|
590
|
+
*/
|
|
591
|
+
customGetWithHTTPInfo({ path, parameters }, requestOptions) {
|
|
592
|
+
validateRequired("path", "customGetWithHTTPInfo", path);
|
|
593
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
594
|
+
const headers = {};
|
|
595
|
+
const queryParameters = parameters ? parameters : {};
|
|
596
|
+
const request = {
|
|
597
|
+
method: "GET",
|
|
598
|
+
path: requestPath,
|
|
599
|
+
queryParameters,
|
|
600
|
+
headers
|
|
601
|
+
};
|
|
602
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
603
|
+
},
|
|
369
604
|
/**
|
|
370
605
|
* This method lets you send requests to the Algolia REST API.
|
|
371
606
|
* @param customPost - The customPost object.
|
|
@@ -388,6 +623,31 @@ function createIngestionClient({
|
|
|
388
623
|
};
|
|
389
624
|
return transporter.request(request, requestOptions);
|
|
390
625
|
},
|
|
626
|
+
/**
|
|
627
|
+
* This method lets you send requests to the Algolia REST API.
|
|
628
|
+
*
|
|
629
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
630
|
+
* @param customPost - The customPost object.
|
|
631
|
+
* @param customPost.path - Path of the endpoint, for example `1/newFeature`.
|
|
632
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
633
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
634
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
635
|
+
* @see customPost for the plain version.
|
|
636
|
+
*/
|
|
637
|
+
customPostWithHTTPInfo({ path, parameters, body }, requestOptions) {
|
|
638
|
+
validateRequired("path", "customPostWithHTTPInfo", path);
|
|
639
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
640
|
+
const headers = {};
|
|
641
|
+
const queryParameters = parameters ? parameters : {};
|
|
642
|
+
const request = {
|
|
643
|
+
method: "POST",
|
|
644
|
+
path: requestPath,
|
|
645
|
+
queryParameters,
|
|
646
|
+
headers,
|
|
647
|
+
data: body ? body : {}
|
|
648
|
+
};
|
|
649
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
650
|
+
},
|
|
391
651
|
/**
|
|
392
652
|
* This method lets you send requests to the Algolia REST API.
|
|
393
653
|
* @param customPut - The customPut object.
|
|
@@ -410,6 +670,31 @@ function createIngestionClient({
|
|
|
410
670
|
};
|
|
411
671
|
return transporter.request(request, requestOptions);
|
|
412
672
|
},
|
|
673
|
+
/**
|
|
674
|
+
* This method lets you send requests to the Algolia REST API.
|
|
675
|
+
*
|
|
676
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
677
|
+
* @param customPut - The customPut object.
|
|
678
|
+
* @param customPut.path - Path of the endpoint, for example `1/newFeature`.
|
|
679
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
680
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
681
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
682
|
+
* @see customPut for the plain version.
|
|
683
|
+
*/
|
|
684
|
+
customPutWithHTTPInfo({ path, parameters, body }, requestOptions) {
|
|
685
|
+
validateRequired("path", "customPutWithHTTPInfo", path);
|
|
686
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
687
|
+
const headers = {};
|
|
688
|
+
const queryParameters = parameters ? parameters : {};
|
|
689
|
+
const request = {
|
|
690
|
+
method: "PUT",
|
|
691
|
+
path: requestPath,
|
|
692
|
+
queryParameters,
|
|
693
|
+
headers,
|
|
694
|
+
data: body ? body : {}
|
|
695
|
+
};
|
|
696
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
697
|
+
},
|
|
413
698
|
/**
|
|
414
699
|
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
415
700
|
*
|
|
@@ -438,21 +723,24 @@ function createIngestionClient({
|
|
|
438
723
|
return transporter.request(request, requestOptions);
|
|
439
724
|
},
|
|
440
725
|
/**
|
|
441
|
-
* Deletes
|
|
726
|
+
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
727
|
+
*
|
|
728
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
442
729
|
*
|
|
443
730
|
* Required API Key ACLs:
|
|
444
731
|
* - addObject
|
|
445
732
|
* - deleteIndex
|
|
446
733
|
* - editSettings
|
|
447
|
-
* @param
|
|
448
|
-
* @param
|
|
734
|
+
* @param deleteAuthentication - The deleteAuthentication object.
|
|
735
|
+
* @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
449
736
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
737
|
+
* @see deleteAuthentication for the plain version.
|
|
450
738
|
*/
|
|
451
|
-
|
|
452
|
-
validateRequired("
|
|
453
|
-
const requestPath = "/1/
|
|
454
|
-
"{
|
|
455
|
-
encodeURIComponent(
|
|
739
|
+
deleteAuthenticationWithHTTPInfo({ authenticationID }, requestOptions) {
|
|
740
|
+
validateRequired("authenticationID", "deleteAuthenticationWithHTTPInfo", authenticationID);
|
|
741
|
+
const requestPath = "/1/authentications/{authenticationID}".replace(
|
|
742
|
+
"{authenticationID}",
|
|
743
|
+
encodeURIComponent(authenticationID)
|
|
456
744
|
);
|
|
457
745
|
const headers = {};
|
|
458
746
|
const queryParameters = {};
|
|
@@ -462,22 +750,25 @@ function createIngestionClient({
|
|
|
462
750
|
queryParameters,
|
|
463
751
|
headers
|
|
464
752
|
};
|
|
465
|
-
return transporter.
|
|
753
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
466
754
|
},
|
|
467
755
|
/**
|
|
468
|
-
* Deletes a
|
|
756
|
+
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
469
757
|
*
|
|
470
758
|
* Required API Key ACLs:
|
|
471
759
|
* - addObject
|
|
472
760
|
* - deleteIndex
|
|
473
761
|
* - editSettings
|
|
474
|
-
* @param
|
|
475
|
-
* @param
|
|
762
|
+
* @param deleteDestination - The deleteDestination object.
|
|
763
|
+
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
476
764
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
477
765
|
*/
|
|
478
|
-
|
|
479
|
-
validateRequired("
|
|
480
|
-
const requestPath = "/1/
|
|
766
|
+
deleteDestination({ destinationID }, requestOptions) {
|
|
767
|
+
validateRequired("destinationID", "deleteDestination", destinationID);
|
|
768
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
769
|
+
"{destinationID}",
|
|
770
|
+
encodeURIComponent(destinationID)
|
|
771
|
+
);
|
|
481
772
|
const headers = {};
|
|
482
773
|
const queryParameters = {};
|
|
483
774
|
const request = {
|
|
@@ -489,19 +780,25 @@ function createIngestionClient({
|
|
|
489
780
|
return transporter.request(request, requestOptions);
|
|
490
781
|
},
|
|
491
782
|
/**
|
|
492
|
-
* Deletes a
|
|
783
|
+
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
784
|
+
*
|
|
785
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
493
786
|
*
|
|
494
787
|
* Required API Key ACLs:
|
|
495
788
|
* - addObject
|
|
496
789
|
* - deleteIndex
|
|
497
790
|
* - editSettings
|
|
498
|
-
* @param
|
|
499
|
-
* @param
|
|
791
|
+
* @param deleteDestination - The deleteDestination object.
|
|
792
|
+
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
500
793
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
794
|
+
* @see deleteDestination for the plain version.
|
|
501
795
|
*/
|
|
502
|
-
|
|
503
|
-
validateRequired("
|
|
504
|
-
const requestPath = "/
|
|
796
|
+
deleteDestinationWithHTTPInfo({ destinationID }, requestOptions) {
|
|
797
|
+
validateRequired("destinationID", "deleteDestinationWithHTTPInfo", destinationID);
|
|
798
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
799
|
+
"{destinationID}",
|
|
800
|
+
encodeURIComponent(destinationID)
|
|
801
|
+
);
|
|
505
802
|
const headers = {};
|
|
506
803
|
const queryParameters = {};
|
|
507
804
|
const request = {
|
|
@@ -510,24 +807,22 @@ function createIngestionClient({
|
|
|
510
807
|
queryParameters,
|
|
511
808
|
headers
|
|
512
809
|
};
|
|
513
|
-
return transporter.
|
|
810
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
514
811
|
},
|
|
515
812
|
/**
|
|
516
|
-
* Deletes a
|
|
813
|
+
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
517
814
|
*
|
|
518
815
|
* Required API Key ACLs:
|
|
519
816
|
* - addObject
|
|
520
817
|
* - deleteIndex
|
|
521
818
|
* - editSettings
|
|
522
|
-
*
|
|
523
|
-
* @
|
|
524
|
-
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
525
|
-
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
819
|
+
* @param deleteSource - The deleteSource object.
|
|
820
|
+
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
526
821
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
527
822
|
*/
|
|
528
|
-
|
|
529
|
-
validateRequired("
|
|
530
|
-
const requestPath = "/1/
|
|
823
|
+
deleteSource({ sourceID }, requestOptions) {
|
|
824
|
+
validateRequired("sourceID", "deleteSource", sourceID);
|
|
825
|
+
const requestPath = "/1/sources/{sourceID}".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
531
826
|
const headers = {};
|
|
532
827
|
const queryParameters = {};
|
|
533
828
|
const request = {
|
|
@@ -539,22 +834,22 @@ function createIngestionClient({
|
|
|
539
834
|
return transporter.request(request, requestOptions);
|
|
540
835
|
},
|
|
541
836
|
/**
|
|
542
|
-
* Deletes a
|
|
837
|
+
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
838
|
+
*
|
|
839
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
543
840
|
*
|
|
544
841
|
* Required API Key ACLs:
|
|
545
842
|
* - addObject
|
|
546
843
|
* - deleteIndex
|
|
547
844
|
* - editSettings
|
|
548
|
-
* @param
|
|
549
|
-
* @param
|
|
845
|
+
* @param deleteSource - The deleteSource object.
|
|
846
|
+
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
550
847
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
848
|
+
* @see deleteSource for the plain version.
|
|
551
849
|
*/
|
|
552
|
-
|
|
553
|
-
validateRequired("
|
|
554
|
-
const requestPath = "/1/
|
|
555
|
-
"{transformationID}",
|
|
556
|
-
encodeURIComponent(transformationID)
|
|
557
|
-
);
|
|
850
|
+
deleteSourceWithHTTPInfo({ sourceID }, requestOptions) {
|
|
851
|
+
validateRequired("sourceID", "deleteSourceWithHTTPInfo", sourceID);
|
|
852
|
+
const requestPath = "/1/sources/{sourceID}".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
558
853
|
const headers = {};
|
|
559
854
|
const queryParameters = {};
|
|
560
855
|
const request = {
|
|
@@ -563,26 +858,26 @@ function createIngestionClient({
|
|
|
563
858
|
queryParameters,
|
|
564
859
|
headers
|
|
565
860
|
};
|
|
566
|
-
return transporter.
|
|
861
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
567
862
|
},
|
|
568
863
|
/**
|
|
569
|
-
*
|
|
864
|
+
* Deletes a task by its ID.
|
|
570
865
|
*
|
|
571
866
|
* Required API Key ACLs:
|
|
572
867
|
* - addObject
|
|
573
868
|
* - deleteIndex
|
|
574
869
|
* - editSettings
|
|
575
|
-
* @param
|
|
576
|
-
* @param
|
|
870
|
+
* @param deleteTask - The deleteTask object.
|
|
871
|
+
* @param deleteTask.taskID - Unique identifier of a task.
|
|
577
872
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
578
873
|
*/
|
|
579
|
-
|
|
580
|
-
validateRequired("taskID", "
|
|
581
|
-
const requestPath = "/2/tasks/{taskID}
|
|
874
|
+
deleteTask({ taskID }, requestOptions) {
|
|
875
|
+
validateRequired("taskID", "deleteTask", taskID);
|
|
876
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
582
877
|
const headers = {};
|
|
583
878
|
const queryParameters = {};
|
|
584
879
|
const request = {
|
|
585
|
-
method: "
|
|
880
|
+
method: "DELETE",
|
|
586
881
|
path: requestPath,
|
|
587
882
|
queryParameters,
|
|
588
883
|
headers
|
|
@@ -590,49 +885,52 @@ function createIngestionClient({
|
|
|
590
885
|
return transporter.request(request, requestOptions);
|
|
591
886
|
},
|
|
592
887
|
/**
|
|
593
|
-
*
|
|
888
|
+
* Deletes a task by its ID.
|
|
889
|
+
*
|
|
890
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
594
891
|
*
|
|
595
892
|
* Required API Key ACLs:
|
|
596
893
|
* - addObject
|
|
597
894
|
* - deleteIndex
|
|
598
895
|
* - editSettings
|
|
599
|
-
*
|
|
600
|
-
* @
|
|
601
|
-
* @param disableTaskV1 - The disableTaskV1 object.
|
|
602
|
-
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
896
|
+
* @param deleteTask - The deleteTask object.
|
|
897
|
+
* @param deleteTask.taskID - Unique identifier of a task.
|
|
603
898
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
899
|
+
* @see deleteTask for the plain version.
|
|
604
900
|
*/
|
|
605
|
-
|
|
606
|
-
validateRequired("taskID", "
|
|
607
|
-
const requestPath = "/
|
|
901
|
+
deleteTaskWithHTTPInfo({ taskID }, requestOptions) {
|
|
902
|
+
validateRequired("taskID", "deleteTaskWithHTTPInfo", taskID);
|
|
903
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
608
904
|
const headers = {};
|
|
609
905
|
const queryParameters = {};
|
|
610
906
|
const request = {
|
|
611
|
-
method: "
|
|
907
|
+
method: "DELETE",
|
|
612
908
|
path: requestPath,
|
|
613
909
|
queryParameters,
|
|
614
910
|
headers
|
|
615
911
|
};
|
|
616
|
-
return transporter.
|
|
912
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
617
913
|
},
|
|
618
914
|
/**
|
|
619
|
-
*
|
|
915
|
+
* Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead.
|
|
620
916
|
*
|
|
621
917
|
* Required API Key ACLs:
|
|
622
918
|
* - addObject
|
|
623
919
|
* - deleteIndex
|
|
624
920
|
* - editSettings
|
|
625
|
-
*
|
|
626
|
-
* @
|
|
921
|
+
*
|
|
922
|
+
* @deprecated
|
|
923
|
+
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
924
|
+
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
627
925
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
628
926
|
*/
|
|
629
|
-
|
|
630
|
-
validateRequired("taskID", "
|
|
631
|
-
const requestPath = "/
|
|
927
|
+
deleteTaskV1({ taskID }, requestOptions) {
|
|
928
|
+
validateRequired("taskID", "deleteTaskV1", taskID);
|
|
929
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
632
930
|
const headers = {};
|
|
633
931
|
const queryParameters = {};
|
|
634
932
|
const request = {
|
|
635
|
-
method: "
|
|
933
|
+
method: "DELETE",
|
|
636
934
|
path: requestPath,
|
|
637
935
|
queryParameters,
|
|
638
936
|
headers
|
|
@@ -640,7 +938,9 @@ function createIngestionClient({
|
|
|
640
938
|
return transporter.request(request, requestOptions);
|
|
641
939
|
},
|
|
642
940
|
/**
|
|
643
|
-
*
|
|
941
|
+
* Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead.
|
|
942
|
+
*
|
|
943
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
644
944
|
*
|
|
645
945
|
* Required API Key ACLs:
|
|
646
946
|
* - addObject
|
|
@@ -648,44 +948,45 @@ function createIngestionClient({
|
|
|
648
948
|
* - editSettings
|
|
649
949
|
*
|
|
650
950
|
* @deprecated
|
|
651
|
-
* @param
|
|
652
|
-
* @param
|
|
951
|
+
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
952
|
+
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
653
953
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
954
|
+
* @see deleteTaskV1 for the plain version.
|
|
654
955
|
*/
|
|
655
|
-
|
|
656
|
-
validateRequired("taskID", "
|
|
657
|
-
const requestPath = "/1/tasks/{taskID}
|
|
956
|
+
deleteTaskV1WithHTTPInfo({ taskID }, requestOptions) {
|
|
957
|
+
validateRequired("taskID", "deleteTaskV1WithHTTPInfo", taskID);
|
|
958
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
658
959
|
const headers = {};
|
|
659
960
|
const queryParameters = {};
|
|
660
961
|
const request = {
|
|
661
|
-
method: "
|
|
962
|
+
method: "DELETE",
|
|
662
963
|
path: requestPath,
|
|
663
964
|
queryParameters,
|
|
664
965
|
headers
|
|
665
966
|
};
|
|
666
|
-
return transporter.
|
|
967
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
667
968
|
},
|
|
668
969
|
/**
|
|
669
|
-
*
|
|
970
|
+
* Deletes a transformation by its ID.
|
|
670
971
|
*
|
|
671
972
|
* Required API Key ACLs:
|
|
672
973
|
* - addObject
|
|
673
974
|
* - deleteIndex
|
|
674
975
|
* - editSettings
|
|
675
|
-
* @param
|
|
676
|
-
* @param
|
|
976
|
+
* @param deleteTransformation - The deleteTransformation object.
|
|
977
|
+
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
677
978
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
678
979
|
*/
|
|
679
|
-
|
|
680
|
-
validateRequired("
|
|
681
|
-
const requestPath = "/1/
|
|
682
|
-
"{
|
|
683
|
-
encodeURIComponent(
|
|
980
|
+
deleteTransformation({ transformationID }, requestOptions) {
|
|
981
|
+
validateRequired("transformationID", "deleteTransformation", transformationID);
|
|
982
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
983
|
+
"{transformationID}",
|
|
984
|
+
encodeURIComponent(transformationID)
|
|
684
985
|
);
|
|
685
986
|
const headers = {};
|
|
686
987
|
const queryParameters = {};
|
|
687
988
|
const request = {
|
|
688
|
-
method: "
|
|
989
|
+
method: "DELETE",
|
|
689
990
|
path: requestPath,
|
|
690
991
|
queryParameters,
|
|
691
992
|
headers
|
|
@@ -693,52 +994,53 @@ function createIngestionClient({
|
|
|
693
994
|
return transporter.request(request, requestOptions);
|
|
694
995
|
},
|
|
695
996
|
/**
|
|
696
|
-
*
|
|
997
|
+
* Deletes a transformation by its ID.
|
|
998
|
+
*
|
|
999
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
697
1000
|
*
|
|
698
1001
|
* Required API Key ACLs:
|
|
699
1002
|
* - addObject
|
|
700
1003
|
* - deleteIndex
|
|
701
1004
|
* - editSettings
|
|
702
|
-
* @param
|
|
703
|
-
* @param
|
|
1005
|
+
* @param deleteTransformation - The deleteTransformation object.
|
|
1006
|
+
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
704
1007
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1008
|
+
* @see deleteTransformation for the plain version.
|
|
705
1009
|
*/
|
|
706
|
-
|
|
707
|
-
validateRequired("
|
|
708
|
-
const requestPath = "/1/
|
|
709
|
-
"{
|
|
710
|
-
encodeURIComponent(
|
|
1010
|
+
deleteTransformationWithHTTPInfo({ transformationID }, requestOptions) {
|
|
1011
|
+
validateRequired("transformationID", "deleteTransformationWithHTTPInfo", transformationID);
|
|
1012
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
1013
|
+
"{transformationID}",
|
|
1014
|
+
encodeURIComponent(transformationID)
|
|
711
1015
|
);
|
|
712
1016
|
const headers = {};
|
|
713
1017
|
const queryParameters = {};
|
|
714
1018
|
const request = {
|
|
715
|
-
method: "
|
|
1019
|
+
method: "DELETE",
|
|
716
1020
|
path: requestPath,
|
|
717
1021
|
queryParameters,
|
|
718
1022
|
headers
|
|
719
1023
|
};
|
|
720
|
-
return transporter.
|
|
1024
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
721
1025
|
},
|
|
722
1026
|
/**
|
|
723
|
-
*
|
|
1027
|
+
* Disables a task.
|
|
724
1028
|
*
|
|
725
1029
|
* Required API Key ACLs:
|
|
726
1030
|
* - addObject
|
|
727
1031
|
* - deleteIndex
|
|
728
1032
|
* - editSettings
|
|
729
|
-
* @param
|
|
730
|
-
* @param
|
|
731
|
-
* @param getEvent.eventID - Unique identifier of an event.
|
|
1033
|
+
* @param disableTask - The disableTask object.
|
|
1034
|
+
* @param disableTask.taskID - Unique identifier of a task.
|
|
732
1035
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
733
1036
|
*/
|
|
734
|
-
|
|
735
|
-
validateRequired("
|
|
736
|
-
|
|
737
|
-
const requestPath = "/1/runs/{runID}/events/{eventID}".replace("{runID}", encodeURIComponent(runID)).replace("{eventID}", encodeURIComponent(eventID));
|
|
1037
|
+
disableTask({ taskID }, requestOptions) {
|
|
1038
|
+
validateRequired("taskID", "disableTask", taskID);
|
|
1039
|
+
const requestPath = "/2/tasks/{taskID}/disable".replace("{taskID}", encodeURIComponent(taskID));
|
|
738
1040
|
const headers = {};
|
|
739
1041
|
const queryParameters = {};
|
|
740
1042
|
const request = {
|
|
741
|
-
method: "
|
|
1043
|
+
method: "PUT",
|
|
742
1044
|
path: requestPath,
|
|
743
1045
|
queryParameters,
|
|
744
1046
|
headers
|
|
@@ -746,47 +1048,52 @@ function createIngestionClient({
|
|
|
746
1048
|
return transporter.request(request, requestOptions);
|
|
747
1049
|
},
|
|
748
1050
|
/**
|
|
749
|
-
*
|
|
1051
|
+
* Disables a task.
|
|
1052
|
+
*
|
|
1053
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
750
1054
|
*
|
|
751
1055
|
* Required API Key ACLs:
|
|
752
1056
|
* - addObject
|
|
753
1057
|
* - deleteIndex
|
|
754
1058
|
* - editSettings
|
|
755
|
-
* @param
|
|
756
|
-
* @param
|
|
1059
|
+
* @param disableTask - The disableTask object.
|
|
1060
|
+
* @param disableTask.taskID - Unique identifier of a task.
|
|
757
1061
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1062
|
+
* @see disableTask for the plain version.
|
|
758
1063
|
*/
|
|
759
|
-
|
|
760
|
-
validateRequired("
|
|
761
|
-
const requestPath = "/
|
|
1064
|
+
disableTaskWithHTTPInfo({ taskID }, requestOptions) {
|
|
1065
|
+
validateRequired("taskID", "disableTaskWithHTTPInfo", taskID);
|
|
1066
|
+
const requestPath = "/2/tasks/{taskID}/disable".replace("{taskID}", encodeURIComponent(taskID));
|
|
762
1067
|
const headers = {};
|
|
763
1068
|
const queryParameters = {};
|
|
764
1069
|
const request = {
|
|
765
|
-
method: "
|
|
1070
|
+
method: "PUT",
|
|
766
1071
|
path: requestPath,
|
|
767
1072
|
queryParameters,
|
|
768
1073
|
headers
|
|
769
1074
|
};
|
|
770
|
-
return transporter.
|
|
1075
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
771
1076
|
},
|
|
772
1077
|
/**
|
|
773
|
-
*
|
|
1078
|
+
* Disables a task using the v1 endpoint. Use `disableTask` instead.
|
|
774
1079
|
*
|
|
775
1080
|
* Required API Key ACLs:
|
|
776
1081
|
* - addObject
|
|
777
1082
|
* - deleteIndex
|
|
778
1083
|
* - editSettings
|
|
779
|
-
*
|
|
780
|
-
* @
|
|
1084
|
+
*
|
|
1085
|
+
* @deprecated
|
|
1086
|
+
* @param disableTaskV1 - The disableTaskV1 object.
|
|
1087
|
+
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
781
1088
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
782
1089
|
*/
|
|
783
|
-
|
|
784
|
-
validateRequired("
|
|
785
|
-
const requestPath = "/1/
|
|
1090
|
+
disableTaskV1({ taskID }, requestOptions) {
|
|
1091
|
+
validateRequired("taskID", "disableTaskV1", taskID);
|
|
1092
|
+
const requestPath = "/1/tasks/{taskID}/disable".replace("{taskID}", encodeURIComponent(taskID));
|
|
786
1093
|
const headers = {};
|
|
787
1094
|
const queryParameters = {};
|
|
788
1095
|
const request = {
|
|
789
|
-
method: "
|
|
1096
|
+
method: "PUT",
|
|
790
1097
|
path: requestPath,
|
|
791
1098
|
queryParameters,
|
|
792
1099
|
headers
|
|
@@ -794,49 +1101,52 @@ function createIngestionClient({
|
|
|
794
1101
|
return transporter.request(request, requestOptions);
|
|
795
1102
|
},
|
|
796
1103
|
/**
|
|
797
|
-
*
|
|
1104
|
+
* Disables a task using the v1 endpoint. Use `disableTask` instead.
|
|
1105
|
+
*
|
|
1106
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
798
1107
|
*
|
|
799
1108
|
* Required API Key ACLs:
|
|
800
1109
|
* - addObject
|
|
801
1110
|
* - deleteIndex
|
|
802
1111
|
* - editSettings
|
|
803
|
-
*
|
|
804
|
-
* @
|
|
1112
|
+
*
|
|
1113
|
+
* @deprecated
|
|
1114
|
+
* @param disableTaskV1 - The disableTaskV1 object.
|
|
1115
|
+
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
805
1116
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1117
|
+
* @see disableTaskV1 for the plain version.
|
|
806
1118
|
*/
|
|
807
|
-
|
|
808
|
-
validateRequired("taskID", "
|
|
809
|
-
const requestPath = "/
|
|
1119
|
+
disableTaskV1WithHTTPInfo({ taskID }, requestOptions) {
|
|
1120
|
+
validateRequired("taskID", "disableTaskV1WithHTTPInfo", taskID);
|
|
1121
|
+
const requestPath = "/1/tasks/{taskID}/disable".replace("{taskID}", encodeURIComponent(taskID));
|
|
810
1122
|
const headers = {};
|
|
811
1123
|
const queryParameters = {};
|
|
812
1124
|
const request = {
|
|
813
|
-
method: "
|
|
1125
|
+
method: "PUT",
|
|
814
1126
|
path: requestPath,
|
|
815
1127
|
queryParameters,
|
|
816
1128
|
headers
|
|
817
1129
|
};
|
|
818
|
-
return transporter.
|
|
1130
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
819
1131
|
},
|
|
820
1132
|
/**
|
|
821
|
-
*
|
|
1133
|
+
* Enables a task.
|
|
822
1134
|
*
|
|
823
1135
|
* Required API Key ACLs:
|
|
824
1136
|
* - addObject
|
|
825
1137
|
* - deleteIndex
|
|
826
1138
|
* - editSettings
|
|
827
|
-
*
|
|
828
|
-
* @
|
|
829
|
-
* @param getTaskV1 - The getTaskV1 object.
|
|
830
|
-
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
1139
|
+
* @param enableTask - The enableTask object.
|
|
1140
|
+
* @param enableTask.taskID - Unique identifier of a task.
|
|
831
1141
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
832
1142
|
*/
|
|
833
|
-
|
|
834
|
-
validateRequired("taskID", "
|
|
835
|
-
const requestPath = "/
|
|
1143
|
+
enableTask({ taskID }, requestOptions) {
|
|
1144
|
+
validateRequired("taskID", "enableTask", taskID);
|
|
1145
|
+
const requestPath = "/2/tasks/{taskID}/enable".replace("{taskID}", encodeURIComponent(taskID));
|
|
836
1146
|
const headers = {};
|
|
837
1147
|
const queryParameters = {};
|
|
838
1148
|
const request = {
|
|
839
|
-
method: "
|
|
1149
|
+
method: "PUT",
|
|
840
1150
|
path: requestPath,
|
|
841
1151
|
queryParameters,
|
|
842
1152
|
headers
|
|
@@ -844,63 +1154,651 @@ function createIngestionClient({
|
|
|
844
1154
|
return transporter.request(request, requestOptions);
|
|
845
1155
|
},
|
|
846
1156
|
/**
|
|
847
|
-
*
|
|
1157
|
+
* Enables a task.
|
|
1158
|
+
*
|
|
1159
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
848
1160
|
*
|
|
849
1161
|
* Required API Key ACLs:
|
|
850
1162
|
* - addObject
|
|
851
1163
|
* - deleteIndex
|
|
852
1164
|
* - editSettings
|
|
853
|
-
* @param
|
|
854
|
-
* @param
|
|
1165
|
+
* @param enableTask - The enableTask object.
|
|
1166
|
+
* @param enableTask.taskID - Unique identifier of a task.
|
|
855
1167
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1168
|
+
* @see enableTask for the plain version.
|
|
856
1169
|
*/
|
|
857
|
-
|
|
858
|
-
validateRequired("
|
|
859
|
-
const requestPath = "/
|
|
860
|
-
"{transformationID}",
|
|
861
|
-
encodeURIComponent(transformationID)
|
|
862
|
-
);
|
|
1170
|
+
enableTaskWithHTTPInfo({ taskID }, requestOptions) {
|
|
1171
|
+
validateRequired("taskID", "enableTaskWithHTTPInfo", taskID);
|
|
1172
|
+
const requestPath = "/2/tasks/{taskID}/enable".replace("{taskID}", encodeURIComponent(taskID));
|
|
863
1173
|
const headers = {};
|
|
864
1174
|
const queryParameters = {};
|
|
865
1175
|
const request = {
|
|
866
|
-
method: "
|
|
1176
|
+
method: "PUT",
|
|
867
1177
|
path: requestPath,
|
|
868
1178
|
queryParameters,
|
|
869
1179
|
headers
|
|
870
1180
|
};
|
|
871
|
-
return transporter.
|
|
1181
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
872
1182
|
},
|
|
873
1183
|
/**
|
|
874
|
-
*
|
|
1184
|
+
* Enables a task using the v1 endpoint. Use `enableTask` instead.
|
|
875
1185
|
*
|
|
876
1186
|
* Required API Key ACLs:
|
|
877
1187
|
* - addObject
|
|
878
1188
|
* - deleteIndex
|
|
879
1189
|
* - editSettings
|
|
880
|
-
*
|
|
881
|
-
* @
|
|
882
|
-
* @param
|
|
883
|
-
* @param
|
|
884
|
-
* @param listAuthentications.platform - Ecommerce platform for which to retrieve authentications.
|
|
885
|
-
* @param listAuthentications.sort - Property by which to sort the list of authentications.
|
|
886
|
-
* @param listAuthentications.order - Sort order of the response, ascending or descending.
|
|
1190
|
+
*
|
|
1191
|
+
* @deprecated
|
|
1192
|
+
* @param enableTaskV1 - The enableTaskV1 object.
|
|
1193
|
+
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
887
1194
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
888
1195
|
*/
|
|
889
|
-
|
|
890
|
-
|
|
1196
|
+
enableTaskV1({ taskID }, requestOptions) {
|
|
1197
|
+
validateRequired("taskID", "enableTaskV1", taskID);
|
|
1198
|
+
const requestPath = "/1/tasks/{taskID}/enable".replace("{taskID}", encodeURIComponent(taskID));
|
|
891
1199
|
const headers = {};
|
|
892
1200
|
const queryParameters = {};
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
}
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
1201
|
+
const request = {
|
|
1202
|
+
method: "PUT",
|
|
1203
|
+
path: requestPath,
|
|
1204
|
+
queryParameters,
|
|
1205
|
+
headers
|
|
1206
|
+
};
|
|
1207
|
+
return transporter.request(request, requestOptions);
|
|
1208
|
+
},
|
|
1209
|
+
/**
|
|
1210
|
+
* Enables a task using the v1 endpoint. Use `enableTask` instead.
|
|
1211
|
+
*
|
|
1212
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1213
|
+
*
|
|
1214
|
+
* Required API Key ACLs:
|
|
1215
|
+
* - addObject
|
|
1216
|
+
* - deleteIndex
|
|
1217
|
+
* - editSettings
|
|
1218
|
+
*
|
|
1219
|
+
* @deprecated
|
|
1220
|
+
* @param enableTaskV1 - The enableTaskV1 object.
|
|
1221
|
+
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
1222
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1223
|
+
* @see enableTaskV1 for the plain version.
|
|
1224
|
+
*/
|
|
1225
|
+
enableTaskV1WithHTTPInfo({ taskID }, requestOptions) {
|
|
1226
|
+
validateRequired("taskID", "enableTaskV1WithHTTPInfo", taskID);
|
|
1227
|
+
const requestPath = "/1/tasks/{taskID}/enable".replace("{taskID}", encodeURIComponent(taskID));
|
|
1228
|
+
const headers = {};
|
|
1229
|
+
const queryParameters = {};
|
|
1230
|
+
const request = {
|
|
1231
|
+
method: "PUT",
|
|
1232
|
+
path: requestPath,
|
|
1233
|
+
queryParameters,
|
|
1234
|
+
headers
|
|
1235
|
+
};
|
|
1236
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1237
|
+
},
|
|
1238
|
+
/**
|
|
1239
|
+
* Retrieves an authentication resource by its ID.
|
|
1240
|
+
*
|
|
1241
|
+
* Required API Key ACLs:
|
|
1242
|
+
* - addObject
|
|
1243
|
+
* - deleteIndex
|
|
1244
|
+
* - editSettings
|
|
1245
|
+
* @param getAuthentication - The getAuthentication object.
|
|
1246
|
+
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
1247
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1248
|
+
*/
|
|
1249
|
+
getAuthentication({ authenticationID }, requestOptions) {
|
|
1250
|
+
validateRequired("authenticationID", "getAuthentication", authenticationID);
|
|
1251
|
+
const requestPath = "/1/authentications/{authenticationID}".replace(
|
|
1252
|
+
"{authenticationID}",
|
|
1253
|
+
encodeURIComponent(authenticationID)
|
|
1254
|
+
);
|
|
1255
|
+
const headers = {};
|
|
1256
|
+
const queryParameters = {};
|
|
1257
|
+
const request = {
|
|
1258
|
+
method: "GET",
|
|
1259
|
+
path: requestPath,
|
|
1260
|
+
queryParameters,
|
|
1261
|
+
headers
|
|
1262
|
+
};
|
|
1263
|
+
return transporter.request(request, requestOptions);
|
|
1264
|
+
},
|
|
1265
|
+
/**
|
|
1266
|
+
* Retrieves an authentication resource by its ID.
|
|
1267
|
+
*
|
|
1268
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1269
|
+
*
|
|
1270
|
+
* Required API Key ACLs:
|
|
1271
|
+
* - addObject
|
|
1272
|
+
* - deleteIndex
|
|
1273
|
+
* - editSettings
|
|
1274
|
+
* @param getAuthentication - The getAuthentication object.
|
|
1275
|
+
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
1276
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1277
|
+
* @see getAuthentication for the plain version.
|
|
1278
|
+
*/
|
|
1279
|
+
getAuthenticationWithHTTPInfo({ authenticationID }, requestOptions) {
|
|
1280
|
+
validateRequired("authenticationID", "getAuthenticationWithHTTPInfo", authenticationID);
|
|
1281
|
+
const requestPath = "/1/authentications/{authenticationID}".replace(
|
|
1282
|
+
"{authenticationID}",
|
|
1283
|
+
encodeURIComponent(authenticationID)
|
|
1284
|
+
);
|
|
1285
|
+
const headers = {};
|
|
1286
|
+
const queryParameters = {};
|
|
1287
|
+
const request = {
|
|
1288
|
+
method: "GET",
|
|
1289
|
+
path: requestPath,
|
|
1290
|
+
queryParameters,
|
|
1291
|
+
headers
|
|
1292
|
+
};
|
|
1293
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1294
|
+
},
|
|
1295
|
+
/**
|
|
1296
|
+
* Retrieves a destination by its ID.
|
|
1297
|
+
*
|
|
1298
|
+
* Required API Key ACLs:
|
|
1299
|
+
* - addObject
|
|
1300
|
+
* - deleteIndex
|
|
1301
|
+
* - editSettings
|
|
1302
|
+
* @param getDestination - The getDestination object.
|
|
1303
|
+
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
1304
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1305
|
+
*/
|
|
1306
|
+
getDestination({ destinationID }, requestOptions) {
|
|
1307
|
+
validateRequired("destinationID", "getDestination", destinationID);
|
|
1308
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
1309
|
+
"{destinationID}",
|
|
1310
|
+
encodeURIComponent(destinationID)
|
|
1311
|
+
);
|
|
1312
|
+
const headers = {};
|
|
1313
|
+
const queryParameters = {};
|
|
1314
|
+
const request = {
|
|
1315
|
+
method: "GET",
|
|
1316
|
+
path: requestPath,
|
|
1317
|
+
queryParameters,
|
|
1318
|
+
headers
|
|
1319
|
+
};
|
|
1320
|
+
return transporter.request(request, requestOptions);
|
|
1321
|
+
},
|
|
1322
|
+
/**
|
|
1323
|
+
* Retrieves a destination by its ID.
|
|
1324
|
+
*
|
|
1325
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1326
|
+
*
|
|
1327
|
+
* Required API Key ACLs:
|
|
1328
|
+
* - addObject
|
|
1329
|
+
* - deleteIndex
|
|
1330
|
+
* - editSettings
|
|
1331
|
+
* @param getDestination - The getDestination object.
|
|
1332
|
+
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
1333
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1334
|
+
* @see getDestination for the plain version.
|
|
1335
|
+
*/
|
|
1336
|
+
getDestinationWithHTTPInfo({ destinationID }, requestOptions) {
|
|
1337
|
+
validateRequired("destinationID", "getDestinationWithHTTPInfo", destinationID);
|
|
1338
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
1339
|
+
"{destinationID}",
|
|
1340
|
+
encodeURIComponent(destinationID)
|
|
1341
|
+
);
|
|
1342
|
+
const headers = {};
|
|
1343
|
+
const queryParameters = {};
|
|
1344
|
+
const request = {
|
|
1345
|
+
method: "GET",
|
|
1346
|
+
path: requestPath,
|
|
1347
|
+
queryParameters,
|
|
1348
|
+
headers
|
|
1349
|
+
};
|
|
1350
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1351
|
+
},
|
|
1352
|
+
/**
|
|
1353
|
+
* Retrieves a single task run event by its ID.
|
|
1354
|
+
*
|
|
1355
|
+
* Required API Key ACLs:
|
|
1356
|
+
* - addObject
|
|
1357
|
+
* - deleteIndex
|
|
1358
|
+
* - editSettings
|
|
1359
|
+
* @param getEvent - The getEvent object.
|
|
1360
|
+
* @param getEvent.runID - Unique identifier of a task run.
|
|
1361
|
+
* @param getEvent.eventID - Unique identifier of an event.
|
|
1362
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1363
|
+
*/
|
|
1364
|
+
getEvent({ runID, eventID }, requestOptions) {
|
|
1365
|
+
validateRequired("runID", "getEvent", runID);
|
|
1366
|
+
validateRequired("eventID", "getEvent", eventID);
|
|
1367
|
+
const requestPath = "/1/runs/{runID}/events/{eventID}".replace("{runID}", encodeURIComponent(runID)).replace("{eventID}", encodeURIComponent(eventID));
|
|
1368
|
+
const headers = {};
|
|
1369
|
+
const queryParameters = {};
|
|
1370
|
+
const request = {
|
|
1371
|
+
method: "GET",
|
|
1372
|
+
path: requestPath,
|
|
1373
|
+
queryParameters,
|
|
1374
|
+
headers
|
|
1375
|
+
};
|
|
1376
|
+
return transporter.request(request, requestOptions);
|
|
1377
|
+
},
|
|
1378
|
+
/**
|
|
1379
|
+
* Retrieves a single task run event by its ID.
|
|
1380
|
+
*
|
|
1381
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1382
|
+
*
|
|
1383
|
+
* Required API Key ACLs:
|
|
1384
|
+
* - addObject
|
|
1385
|
+
* - deleteIndex
|
|
1386
|
+
* - editSettings
|
|
1387
|
+
* @param getEvent - The getEvent object.
|
|
1388
|
+
* @param getEvent.runID - Unique identifier of a task run.
|
|
1389
|
+
* @param getEvent.eventID - Unique identifier of an event.
|
|
1390
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1391
|
+
* @see getEvent for the plain version.
|
|
1392
|
+
*/
|
|
1393
|
+
getEventWithHTTPInfo({ runID, eventID }, requestOptions) {
|
|
1394
|
+
validateRequired("runID", "getEventWithHTTPInfo", runID);
|
|
1395
|
+
validateRequired("eventID", "getEventWithHTTPInfo", eventID);
|
|
1396
|
+
const requestPath = "/1/runs/{runID}/events/{eventID}".replace("{runID}", encodeURIComponent(runID)).replace("{eventID}", encodeURIComponent(eventID));
|
|
1397
|
+
const headers = {};
|
|
1398
|
+
const queryParameters = {};
|
|
1399
|
+
const request = {
|
|
1400
|
+
method: "GET",
|
|
1401
|
+
path: requestPath,
|
|
1402
|
+
queryParameters,
|
|
1403
|
+
headers
|
|
1404
|
+
};
|
|
1405
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1406
|
+
},
|
|
1407
|
+
/**
|
|
1408
|
+
* Retrieve a single task run by its ID.
|
|
1409
|
+
*
|
|
1410
|
+
* Required API Key ACLs:
|
|
1411
|
+
* - addObject
|
|
1412
|
+
* - deleteIndex
|
|
1413
|
+
* - editSettings
|
|
1414
|
+
* @param getRun - The getRun object.
|
|
1415
|
+
* @param getRun.runID - Unique identifier of a task run.
|
|
1416
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1417
|
+
*/
|
|
1418
|
+
getRun({ runID }, requestOptions) {
|
|
1419
|
+
validateRequired("runID", "getRun", runID);
|
|
1420
|
+
const requestPath = "/1/runs/{runID}".replace("{runID}", encodeURIComponent(runID));
|
|
1421
|
+
const headers = {};
|
|
1422
|
+
const queryParameters = {};
|
|
1423
|
+
const request = {
|
|
1424
|
+
method: "GET",
|
|
1425
|
+
path: requestPath,
|
|
1426
|
+
queryParameters,
|
|
1427
|
+
headers
|
|
1428
|
+
};
|
|
1429
|
+
return transporter.request(request, requestOptions);
|
|
1430
|
+
},
|
|
1431
|
+
/**
|
|
1432
|
+
* Retrieve a single task run by its ID.
|
|
1433
|
+
*
|
|
1434
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1435
|
+
*
|
|
1436
|
+
* Required API Key ACLs:
|
|
1437
|
+
* - addObject
|
|
1438
|
+
* - deleteIndex
|
|
1439
|
+
* - editSettings
|
|
1440
|
+
* @param getRun - The getRun object.
|
|
1441
|
+
* @param getRun.runID - Unique identifier of a task run.
|
|
1442
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1443
|
+
* @see getRun for the plain version.
|
|
1444
|
+
*/
|
|
1445
|
+
getRunWithHTTPInfo({ runID }, requestOptions) {
|
|
1446
|
+
validateRequired("runID", "getRunWithHTTPInfo", runID);
|
|
1447
|
+
const requestPath = "/1/runs/{runID}".replace("{runID}", encodeURIComponent(runID));
|
|
1448
|
+
const headers = {};
|
|
1449
|
+
const queryParameters = {};
|
|
1450
|
+
const request = {
|
|
1451
|
+
method: "GET",
|
|
1452
|
+
path: requestPath,
|
|
1453
|
+
queryParameters,
|
|
1454
|
+
headers
|
|
1455
|
+
};
|
|
1456
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1457
|
+
},
|
|
1458
|
+
/**
|
|
1459
|
+
* Retrieve a source by its ID.
|
|
1460
|
+
*
|
|
1461
|
+
* Required API Key ACLs:
|
|
1462
|
+
* - addObject
|
|
1463
|
+
* - deleteIndex
|
|
1464
|
+
* - editSettings
|
|
1465
|
+
* @param getSource - The getSource object.
|
|
1466
|
+
* @param getSource.sourceID - Unique identifier of a source.
|
|
1467
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1468
|
+
*/
|
|
1469
|
+
getSource({ sourceID }, requestOptions) {
|
|
1470
|
+
validateRequired("sourceID", "getSource", sourceID);
|
|
1471
|
+
const requestPath = "/1/sources/{sourceID}".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
1472
|
+
const headers = {};
|
|
1473
|
+
const queryParameters = {};
|
|
1474
|
+
const request = {
|
|
1475
|
+
method: "GET",
|
|
1476
|
+
path: requestPath,
|
|
1477
|
+
queryParameters,
|
|
1478
|
+
headers
|
|
1479
|
+
};
|
|
1480
|
+
return transporter.request(request, requestOptions);
|
|
1481
|
+
},
|
|
1482
|
+
/**
|
|
1483
|
+
* Retrieve a source by its ID.
|
|
1484
|
+
*
|
|
1485
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1486
|
+
*
|
|
1487
|
+
* Required API Key ACLs:
|
|
1488
|
+
* - addObject
|
|
1489
|
+
* - deleteIndex
|
|
1490
|
+
* - editSettings
|
|
1491
|
+
* @param getSource - The getSource object.
|
|
1492
|
+
* @param getSource.sourceID - Unique identifier of a source.
|
|
1493
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1494
|
+
* @see getSource for the plain version.
|
|
1495
|
+
*/
|
|
1496
|
+
getSourceWithHTTPInfo({ sourceID }, requestOptions) {
|
|
1497
|
+
validateRequired("sourceID", "getSourceWithHTTPInfo", sourceID);
|
|
1498
|
+
const requestPath = "/1/sources/{sourceID}".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
1499
|
+
const headers = {};
|
|
1500
|
+
const queryParameters = {};
|
|
1501
|
+
const request = {
|
|
1502
|
+
method: "GET",
|
|
1503
|
+
path: requestPath,
|
|
1504
|
+
queryParameters,
|
|
1505
|
+
headers
|
|
1506
|
+
};
|
|
1507
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1508
|
+
},
|
|
1509
|
+
/**
|
|
1510
|
+
* Retrieves a task by its ID.
|
|
1511
|
+
*
|
|
1512
|
+
* Required API Key ACLs:
|
|
1513
|
+
* - addObject
|
|
1514
|
+
* - deleteIndex
|
|
1515
|
+
* - editSettings
|
|
1516
|
+
* @param getTask - The getTask object.
|
|
1517
|
+
* @param getTask.taskID - Unique identifier of a task.
|
|
1518
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1519
|
+
*/
|
|
1520
|
+
getTask({ taskID }, requestOptions) {
|
|
1521
|
+
validateRequired("taskID", "getTask", taskID);
|
|
1522
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
1523
|
+
const headers = {};
|
|
1524
|
+
const queryParameters = {};
|
|
1525
|
+
const request = {
|
|
1526
|
+
method: "GET",
|
|
1527
|
+
path: requestPath,
|
|
1528
|
+
queryParameters,
|
|
1529
|
+
headers
|
|
1530
|
+
};
|
|
1531
|
+
return transporter.request(request, requestOptions);
|
|
1532
|
+
},
|
|
1533
|
+
/**
|
|
1534
|
+
* Retrieves a task by its ID.
|
|
1535
|
+
*
|
|
1536
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1537
|
+
*
|
|
1538
|
+
* Required API Key ACLs:
|
|
1539
|
+
* - addObject
|
|
1540
|
+
* - deleteIndex
|
|
1541
|
+
* - editSettings
|
|
1542
|
+
* @param getTask - The getTask object.
|
|
1543
|
+
* @param getTask.taskID - Unique identifier of a task.
|
|
1544
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1545
|
+
* @see getTask for the plain version.
|
|
1546
|
+
*/
|
|
1547
|
+
getTaskWithHTTPInfo({ taskID }, requestOptions) {
|
|
1548
|
+
validateRequired("taskID", "getTaskWithHTTPInfo", taskID);
|
|
1549
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
1550
|
+
const headers = {};
|
|
1551
|
+
const queryParameters = {};
|
|
1552
|
+
const request = {
|
|
1553
|
+
method: "GET",
|
|
1554
|
+
path: requestPath,
|
|
1555
|
+
queryParameters,
|
|
1556
|
+
headers
|
|
1557
|
+
};
|
|
1558
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1559
|
+
},
|
|
1560
|
+
/**
|
|
1561
|
+
* Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead.
|
|
1562
|
+
*
|
|
1563
|
+
* Required API Key ACLs:
|
|
1564
|
+
* - addObject
|
|
1565
|
+
* - deleteIndex
|
|
1566
|
+
* - editSettings
|
|
1567
|
+
*
|
|
1568
|
+
* @deprecated
|
|
1569
|
+
* @param getTaskV1 - The getTaskV1 object.
|
|
1570
|
+
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
1571
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1572
|
+
*/
|
|
1573
|
+
getTaskV1({ taskID }, requestOptions) {
|
|
1574
|
+
validateRequired("taskID", "getTaskV1", taskID);
|
|
1575
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
1576
|
+
const headers = {};
|
|
1577
|
+
const queryParameters = {};
|
|
1578
|
+
const request = {
|
|
1579
|
+
method: "GET",
|
|
1580
|
+
path: requestPath,
|
|
1581
|
+
queryParameters,
|
|
1582
|
+
headers
|
|
1583
|
+
};
|
|
1584
|
+
return transporter.request(request, requestOptions);
|
|
1585
|
+
},
|
|
1586
|
+
/**
|
|
1587
|
+
* Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead.
|
|
1588
|
+
*
|
|
1589
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1590
|
+
*
|
|
1591
|
+
* Required API Key ACLs:
|
|
1592
|
+
* - addObject
|
|
1593
|
+
* - deleteIndex
|
|
1594
|
+
* - editSettings
|
|
1595
|
+
*
|
|
1596
|
+
* @deprecated
|
|
1597
|
+
* @param getTaskV1 - The getTaskV1 object.
|
|
1598
|
+
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
1599
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1600
|
+
* @see getTaskV1 for the plain version.
|
|
1601
|
+
*/
|
|
1602
|
+
getTaskV1WithHTTPInfo({ taskID }, requestOptions) {
|
|
1603
|
+
validateRequired("taskID", "getTaskV1WithHTTPInfo", taskID);
|
|
1604
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
1605
|
+
const headers = {};
|
|
1606
|
+
const queryParameters = {};
|
|
1607
|
+
const request = {
|
|
1608
|
+
method: "GET",
|
|
1609
|
+
path: requestPath,
|
|
1610
|
+
queryParameters,
|
|
1611
|
+
headers
|
|
1612
|
+
};
|
|
1613
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1614
|
+
},
|
|
1615
|
+
/**
|
|
1616
|
+
* Retrieves a transformation by its ID.
|
|
1617
|
+
*
|
|
1618
|
+
* Required API Key ACLs:
|
|
1619
|
+
* - addObject
|
|
1620
|
+
* - deleteIndex
|
|
1621
|
+
* - editSettings
|
|
1622
|
+
* @param getTransformation - The getTransformation object.
|
|
1623
|
+
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
1624
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1625
|
+
*/
|
|
1626
|
+
getTransformation({ transformationID }, requestOptions) {
|
|
1627
|
+
validateRequired("transformationID", "getTransformation", transformationID);
|
|
1628
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
1629
|
+
"{transformationID}",
|
|
1630
|
+
encodeURIComponent(transformationID)
|
|
1631
|
+
);
|
|
1632
|
+
const headers = {};
|
|
1633
|
+
const queryParameters = {};
|
|
1634
|
+
const request = {
|
|
1635
|
+
method: "GET",
|
|
1636
|
+
path: requestPath,
|
|
1637
|
+
queryParameters,
|
|
1638
|
+
headers
|
|
1639
|
+
};
|
|
1640
|
+
return transporter.request(request, requestOptions);
|
|
1641
|
+
},
|
|
1642
|
+
/**
|
|
1643
|
+
* Retrieves a transformation by its ID.
|
|
1644
|
+
*
|
|
1645
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1646
|
+
*
|
|
1647
|
+
* Required API Key ACLs:
|
|
1648
|
+
* - addObject
|
|
1649
|
+
* - deleteIndex
|
|
1650
|
+
* - editSettings
|
|
1651
|
+
* @param getTransformation - The getTransformation object.
|
|
1652
|
+
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
1653
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1654
|
+
* @see getTransformation for the plain version.
|
|
1655
|
+
*/
|
|
1656
|
+
getTransformationWithHTTPInfo({ transformationID }, requestOptions) {
|
|
1657
|
+
validateRequired("transformationID", "getTransformationWithHTTPInfo", transformationID);
|
|
1658
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
1659
|
+
"{transformationID}",
|
|
1660
|
+
encodeURIComponent(transformationID)
|
|
1661
|
+
);
|
|
1662
|
+
const headers = {};
|
|
1663
|
+
const queryParameters = {};
|
|
1664
|
+
const request = {
|
|
1665
|
+
method: "GET",
|
|
1666
|
+
path: requestPath,
|
|
1667
|
+
queryParameters,
|
|
1668
|
+
headers
|
|
1669
|
+
};
|
|
1670
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1671
|
+
},
|
|
1672
|
+
/**
|
|
1673
|
+
* Retrieves a list of all authentication resources.
|
|
1674
|
+
*
|
|
1675
|
+
* Required API Key ACLs:
|
|
1676
|
+
* - addObject
|
|
1677
|
+
* - deleteIndex
|
|
1678
|
+
* - editSettings
|
|
1679
|
+
* @param listAuthentications - The listAuthentications object.
|
|
1680
|
+
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
1681
|
+
* @param listAuthentications.page - Page number of the paginated API response.
|
|
1682
|
+
* @param listAuthentications.type - Type of authentication resource to retrieve.
|
|
1683
|
+
* @param listAuthentications.platform - Ecommerce platform for which to retrieve authentications.
|
|
1684
|
+
* @param listAuthentications.sort - Property by which to sort the list of authentications.
|
|
1685
|
+
* @param listAuthentications.order - Sort order of the response, ascending or descending.
|
|
1686
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1687
|
+
*/
|
|
1688
|
+
listAuthentications({ itemsPerPage, page, type, platform, sort, order } = {}, requestOptions = void 0) {
|
|
1689
|
+
const requestPath = "/1/authentications";
|
|
1690
|
+
const headers = {};
|
|
1691
|
+
const queryParameters = {};
|
|
1692
|
+
if (itemsPerPage !== void 0) {
|
|
1693
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1694
|
+
}
|
|
1695
|
+
if (page !== void 0) {
|
|
1696
|
+
queryParameters["page"] = page.toString();
|
|
1697
|
+
}
|
|
1698
|
+
if (type !== void 0) {
|
|
1699
|
+
queryParameters["type"] = type.toString();
|
|
1700
|
+
}
|
|
1701
|
+
if (platform !== void 0) {
|
|
1702
|
+
queryParameters["platform"] = platform.toString();
|
|
1703
|
+
}
|
|
1704
|
+
if (sort !== void 0) {
|
|
1705
|
+
queryParameters["sort"] = sort.toString();
|
|
1706
|
+
}
|
|
1707
|
+
if (order !== void 0) {
|
|
1708
|
+
queryParameters["order"] = order.toString();
|
|
1709
|
+
}
|
|
1710
|
+
const request = {
|
|
1711
|
+
method: "GET",
|
|
1712
|
+
path: requestPath,
|
|
1713
|
+
queryParameters,
|
|
1714
|
+
headers
|
|
1715
|
+
};
|
|
1716
|
+
return transporter.request(request, requestOptions);
|
|
1717
|
+
},
|
|
1718
|
+
/**
|
|
1719
|
+
* Retrieves a list of all authentication resources.
|
|
1720
|
+
*
|
|
1721
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1722
|
+
*
|
|
1723
|
+
* Required API Key ACLs:
|
|
1724
|
+
* - addObject
|
|
1725
|
+
* - deleteIndex
|
|
1726
|
+
* - editSettings
|
|
1727
|
+
* @param listAuthentications - The listAuthentications object.
|
|
1728
|
+
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
1729
|
+
* @param listAuthentications.page - Page number of the paginated API response.
|
|
1730
|
+
* @param listAuthentications.type - Type of authentication resource to retrieve.
|
|
1731
|
+
* @param listAuthentications.platform - Ecommerce platform for which to retrieve authentications.
|
|
1732
|
+
* @param listAuthentications.sort - Property by which to sort the list of authentications.
|
|
1733
|
+
* @param listAuthentications.order - Sort order of the response, ascending or descending.
|
|
1734
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1735
|
+
* @see listAuthentications for the plain version.
|
|
1736
|
+
*/
|
|
1737
|
+
listAuthenticationsWithHTTPInfo({ itemsPerPage, page, type, platform, sort, order } = {}, requestOptions = void 0) {
|
|
1738
|
+
const requestPath = "/1/authentications";
|
|
1739
|
+
const headers = {};
|
|
1740
|
+
const queryParameters = {};
|
|
1741
|
+
if (itemsPerPage !== void 0) {
|
|
1742
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1743
|
+
}
|
|
1744
|
+
if (page !== void 0) {
|
|
1745
|
+
queryParameters["page"] = page.toString();
|
|
1746
|
+
}
|
|
1747
|
+
if (type !== void 0) {
|
|
1748
|
+
queryParameters["type"] = type.toString();
|
|
1749
|
+
}
|
|
1750
|
+
if (platform !== void 0) {
|
|
1751
|
+
queryParameters["platform"] = platform.toString();
|
|
1752
|
+
}
|
|
1753
|
+
if (sort !== void 0) {
|
|
1754
|
+
queryParameters["sort"] = sort.toString();
|
|
1755
|
+
}
|
|
1756
|
+
if (order !== void 0) {
|
|
1757
|
+
queryParameters["order"] = order.toString();
|
|
1758
|
+
}
|
|
1759
|
+
const request = {
|
|
1760
|
+
method: "GET",
|
|
1761
|
+
path: requestPath,
|
|
1762
|
+
queryParameters,
|
|
1763
|
+
headers
|
|
1764
|
+
};
|
|
1765
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1766
|
+
},
|
|
1767
|
+
/**
|
|
1768
|
+
* Retrieves a list of destinations.
|
|
1769
|
+
*
|
|
1770
|
+
* Required API Key ACLs:
|
|
1771
|
+
* - addObject
|
|
1772
|
+
* - deleteIndex
|
|
1773
|
+
* - editSettings
|
|
1774
|
+
* @param listDestinations - The listDestinations object.
|
|
1775
|
+
* @param listDestinations.itemsPerPage - Number of items per page.
|
|
1776
|
+
* @param listDestinations.page - Page number of the paginated API response.
|
|
1777
|
+
* @param listDestinations.type - Destination type.
|
|
1778
|
+
* @param listDestinations.authenticationID - Authentication ID used by destinations.
|
|
1779
|
+
* @param listDestinations.transformationID - Get the list of destinations used by a transformation.
|
|
1780
|
+
* @param listDestinations.sort - Property by which to sort the destinations.
|
|
1781
|
+
* @param listDestinations.order - Sort order of the response, ascending or descending.
|
|
1782
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1783
|
+
*/
|
|
1784
|
+
listDestinations({ itemsPerPage, page, type, authenticationID, transformationID, sort, order } = {}, requestOptions = void 0) {
|
|
1785
|
+
const requestPath = "/1/destinations";
|
|
1786
|
+
const headers = {};
|
|
1787
|
+
const queryParameters = {};
|
|
1788
|
+
if (itemsPerPage !== void 0) {
|
|
1789
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1790
|
+
}
|
|
1791
|
+
if (page !== void 0) {
|
|
1792
|
+
queryParameters["page"] = page.toString();
|
|
1793
|
+
}
|
|
1794
|
+
if (type !== void 0) {
|
|
1795
|
+
queryParameters["type"] = type.toString();
|
|
1796
|
+
}
|
|
1797
|
+
if (authenticationID !== void 0) {
|
|
1798
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
1799
|
+
}
|
|
1800
|
+
if (transformationID !== void 0) {
|
|
1801
|
+
queryParameters["transformationID"] = transformationID.toString();
|
|
904
1802
|
}
|
|
905
1803
|
if (sort !== void 0) {
|
|
906
1804
|
queryParameters["sort"] = sort.toString();
|
|
@@ -919,6 +1817,8 @@ function createIngestionClient({
|
|
|
919
1817
|
/**
|
|
920
1818
|
* Retrieves a list of destinations.
|
|
921
1819
|
*
|
|
1820
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1821
|
+
*
|
|
922
1822
|
* Required API Key ACLs:
|
|
923
1823
|
* - addObject
|
|
924
1824
|
* - deleteIndex
|
|
@@ -932,8 +1832,9 @@ function createIngestionClient({
|
|
|
932
1832
|
* @param listDestinations.sort - Property by which to sort the destinations.
|
|
933
1833
|
* @param listDestinations.order - Sort order of the response, ascending or descending.
|
|
934
1834
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1835
|
+
* @see listDestinations for the plain version.
|
|
935
1836
|
*/
|
|
936
|
-
|
|
1837
|
+
listDestinationsWithHTTPInfo({ itemsPerPage, page, type, authenticationID, transformationID, sort, order } = {}, requestOptions = void 0) {
|
|
937
1838
|
const requestPath = "/1/destinations";
|
|
938
1839
|
const headers = {};
|
|
939
1840
|
const queryParameters = {};
|
|
@@ -964,7 +1865,7 @@ function createIngestionClient({
|
|
|
964
1865
|
queryParameters,
|
|
965
1866
|
headers
|
|
966
1867
|
};
|
|
967
|
-
return transporter.
|
|
1868
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
968
1869
|
},
|
|
969
1870
|
/**
|
|
970
1871
|
* Retrieves a list of events for a task run, identified by its ID.
|
|
@@ -1022,6 +1923,65 @@ function createIngestionClient({
|
|
|
1022
1923
|
};
|
|
1023
1924
|
return transporter.request(request, requestOptions);
|
|
1024
1925
|
},
|
|
1926
|
+
/**
|
|
1927
|
+
* Retrieves a list of events for a task run, identified by its ID.
|
|
1928
|
+
*
|
|
1929
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1930
|
+
*
|
|
1931
|
+
* Required API Key ACLs:
|
|
1932
|
+
* - addObject
|
|
1933
|
+
* - deleteIndex
|
|
1934
|
+
* - editSettings
|
|
1935
|
+
* @param listEvents - The listEvents object.
|
|
1936
|
+
* @param listEvents.runID - Unique identifier of a task run.
|
|
1937
|
+
* @param listEvents.itemsPerPage - Number of items per page.
|
|
1938
|
+
* @param listEvents.page - Page number of the paginated API response.
|
|
1939
|
+
* @param listEvents.status - Event status for filtering the list of task runs.
|
|
1940
|
+
* @param listEvents.type - Event type for filtering the list of task runs.
|
|
1941
|
+
* @param listEvents.sort - Property by which to sort the list of task run events.
|
|
1942
|
+
* @param listEvents.order - Sort order of the response, ascending or descending.
|
|
1943
|
+
* @param listEvents.startDate - Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
|
|
1944
|
+
* @param listEvents.endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
|
|
1945
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1946
|
+
* @see listEvents for the plain version.
|
|
1947
|
+
*/
|
|
1948
|
+
listEventsWithHTTPInfo({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate }, requestOptions) {
|
|
1949
|
+
validateRequired("runID", "listEventsWithHTTPInfo", runID);
|
|
1950
|
+
const requestPath = "/1/runs/{runID}/events".replace("{runID}", encodeURIComponent(runID));
|
|
1951
|
+
const headers = {};
|
|
1952
|
+
const queryParameters = {};
|
|
1953
|
+
if (itemsPerPage !== void 0) {
|
|
1954
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1955
|
+
}
|
|
1956
|
+
if (page !== void 0) {
|
|
1957
|
+
queryParameters["page"] = page.toString();
|
|
1958
|
+
}
|
|
1959
|
+
if (status !== void 0) {
|
|
1960
|
+
queryParameters["status"] = status.toString();
|
|
1961
|
+
}
|
|
1962
|
+
if (type !== void 0) {
|
|
1963
|
+
queryParameters["type"] = type.toString();
|
|
1964
|
+
}
|
|
1965
|
+
if (sort !== void 0) {
|
|
1966
|
+
queryParameters["sort"] = sort.toString();
|
|
1967
|
+
}
|
|
1968
|
+
if (order !== void 0) {
|
|
1969
|
+
queryParameters["order"] = order.toString();
|
|
1970
|
+
}
|
|
1971
|
+
if (startDate !== void 0) {
|
|
1972
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1973
|
+
}
|
|
1974
|
+
if (endDate !== void 0) {
|
|
1975
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1976
|
+
}
|
|
1977
|
+
const request = {
|
|
1978
|
+
method: "GET",
|
|
1979
|
+
path: requestPath,
|
|
1980
|
+
queryParameters,
|
|
1981
|
+
headers
|
|
1982
|
+
};
|
|
1983
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1984
|
+
},
|
|
1025
1985
|
/**
|
|
1026
1986
|
* Retrieve a list of task runs.
|
|
1027
1987
|
*
|
|
@@ -1080,6 +2040,67 @@ function createIngestionClient({
|
|
|
1080
2040
|
};
|
|
1081
2041
|
return transporter.request(request, requestOptions);
|
|
1082
2042
|
},
|
|
2043
|
+
/**
|
|
2044
|
+
* Retrieve a list of task runs.
|
|
2045
|
+
*
|
|
2046
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2047
|
+
*
|
|
2048
|
+
* Required API Key ACLs:
|
|
2049
|
+
* - addObject
|
|
2050
|
+
* - deleteIndex
|
|
2051
|
+
* - editSettings
|
|
2052
|
+
* @param listRuns - The listRuns object.
|
|
2053
|
+
* @param listRuns.itemsPerPage - Number of items per page.
|
|
2054
|
+
* @param listRuns.page - Page number of the paginated API response.
|
|
2055
|
+
* @param listRuns.status - Run status for filtering the list of task runs.
|
|
2056
|
+
* @param listRuns.type - Run type for filtering the list of task runs.
|
|
2057
|
+
* @param listRuns.taskID - Task ID for filtering the list of task runs.
|
|
2058
|
+
* @param listRuns.sort - Property by which to sort the list of task runs.
|
|
2059
|
+
* @param listRuns.order - Sort order of the response, ascending or descending.
|
|
2060
|
+
* @param listRuns.startDate - Date and time for the earliest run to retrieve, in RFC 3339 format. By default, the current day minus seven days is used.
|
|
2061
|
+
* @param listRuns.endDate - Date and time for the latest run to retrieve, in RFC 3339 format. By default, the current day is used.
|
|
2062
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2063
|
+
* @see listRuns for the plain version.
|
|
2064
|
+
*/
|
|
2065
|
+
listRunsWithHTTPInfo({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate } = {}, requestOptions = void 0) {
|
|
2066
|
+
const requestPath = "/1/runs";
|
|
2067
|
+
const headers = {};
|
|
2068
|
+
const queryParameters = {};
|
|
2069
|
+
if (itemsPerPage !== void 0) {
|
|
2070
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2071
|
+
}
|
|
2072
|
+
if (page !== void 0) {
|
|
2073
|
+
queryParameters["page"] = page.toString();
|
|
2074
|
+
}
|
|
2075
|
+
if (status !== void 0) {
|
|
2076
|
+
queryParameters["status"] = status.toString();
|
|
2077
|
+
}
|
|
2078
|
+
if (type !== void 0) {
|
|
2079
|
+
queryParameters["type"] = type.toString();
|
|
2080
|
+
}
|
|
2081
|
+
if (taskID !== void 0) {
|
|
2082
|
+
queryParameters["taskID"] = taskID.toString();
|
|
2083
|
+
}
|
|
2084
|
+
if (sort !== void 0) {
|
|
2085
|
+
queryParameters["sort"] = sort.toString();
|
|
2086
|
+
}
|
|
2087
|
+
if (order !== void 0) {
|
|
2088
|
+
queryParameters["order"] = order.toString();
|
|
2089
|
+
}
|
|
2090
|
+
if (startDate !== void 0) {
|
|
2091
|
+
queryParameters["startDate"] = startDate.toString();
|
|
2092
|
+
}
|
|
2093
|
+
if (endDate !== void 0) {
|
|
2094
|
+
queryParameters["endDate"] = endDate.toString();
|
|
2095
|
+
}
|
|
2096
|
+
const request = {
|
|
2097
|
+
method: "GET",
|
|
2098
|
+
path: requestPath,
|
|
2099
|
+
queryParameters,
|
|
2100
|
+
headers
|
|
2101
|
+
};
|
|
2102
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2103
|
+
},
|
|
1083
2104
|
/**
|
|
1084
2105
|
* Retrieves a list of sources.
|
|
1085
2106
|
*
|
|
@@ -1106,11 +2127,138 @@ function createIngestionClient({
|
|
|
1106
2127
|
if (page !== void 0) {
|
|
1107
2128
|
queryParameters["page"] = page.toString();
|
|
1108
2129
|
}
|
|
1109
|
-
if (type !== void 0) {
|
|
1110
|
-
queryParameters["type"] = type.toString();
|
|
2130
|
+
if (type !== void 0) {
|
|
2131
|
+
queryParameters["type"] = type.toString();
|
|
2132
|
+
}
|
|
2133
|
+
if (authenticationID !== void 0) {
|
|
2134
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
2135
|
+
}
|
|
2136
|
+
if (sort !== void 0) {
|
|
2137
|
+
queryParameters["sort"] = sort.toString();
|
|
2138
|
+
}
|
|
2139
|
+
if (order !== void 0) {
|
|
2140
|
+
queryParameters["order"] = order.toString();
|
|
2141
|
+
}
|
|
2142
|
+
const request = {
|
|
2143
|
+
method: "GET",
|
|
2144
|
+
path: requestPath,
|
|
2145
|
+
queryParameters,
|
|
2146
|
+
headers
|
|
2147
|
+
};
|
|
2148
|
+
return transporter.request(request, requestOptions);
|
|
2149
|
+
},
|
|
2150
|
+
/**
|
|
2151
|
+
* Retrieves a list of sources.
|
|
2152
|
+
*
|
|
2153
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2154
|
+
*
|
|
2155
|
+
* Required API Key ACLs:
|
|
2156
|
+
* - addObject
|
|
2157
|
+
* - deleteIndex
|
|
2158
|
+
* - editSettings
|
|
2159
|
+
* @param listSources - The listSources object.
|
|
2160
|
+
* @param listSources.itemsPerPage - Number of items per page.
|
|
2161
|
+
* @param listSources.page - Page number of the paginated API response.
|
|
2162
|
+
* @param listSources.type - Source type. Some sources require authentication.
|
|
2163
|
+
* @param listSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
|
|
2164
|
+
* @param listSources.sort - Property by which to sort the list of sources.
|
|
2165
|
+
* @param listSources.order - Sort order of the response, ascending or descending.
|
|
2166
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2167
|
+
* @see listSources for the plain version.
|
|
2168
|
+
*/
|
|
2169
|
+
listSourcesWithHTTPInfo({ itemsPerPage, page, type, authenticationID, sort, order } = {}, requestOptions = void 0) {
|
|
2170
|
+
const requestPath = "/1/sources";
|
|
2171
|
+
const headers = {};
|
|
2172
|
+
const queryParameters = {};
|
|
2173
|
+
if (itemsPerPage !== void 0) {
|
|
2174
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2175
|
+
}
|
|
2176
|
+
if (page !== void 0) {
|
|
2177
|
+
queryParameters["page"] = page.toString();
|
|
2178
|
+
}
|
|
2179
|
+
if (type !== void 0) {
|
|
2180
|
+
queryParameters["type"] = type.toString();
|
|
2181
|
+
}
|
|
2182
|
+
if (authenticationID !== void 0) {
|
|
2183
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
2184
|
+
}
|
|
2185
|
+
if (sort !== void 0) {
|
|
2186
|
+
queryParameters["sort"] = sort.toString();
|
|
2187
|
+
}
|
|
2188
|
+
if (order !== void 0) {
|
|
2189
|
+
queryParameters["order"] = order.toString();
|
|
2190
|
+
}
|
|
2191
|
+
const request = {
|
|
2192
|
+
method: "GET",
|
|
2193
|
+
path: requestPath,
|
|
2194
|
+
queryParameters,
|
|
2195
|
+
headers
|
|
2196
|
+
};
|
|
2197
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2198
|
+
},
|
|
2199
|
+
/**
|
|
2200
|
+
* Retrieves a list of tasks.
|
|
2201
|
+
*
|
|
2202
|
+
* Required API Key ACLs:
|
|
2203
|
+
* - addObject
|
|
2204
|
+
* - deleteIndex
|
|
2205
|
+
* - editSettings
|
|
2206
|
+
* @param listTasks - The listTasks object.
|
|
2207
|
+
* @param listTasks.itemsPerPage - Number of items per page.
|
|
2208
|
+
* @param listTasks.page - Page number of the paginated API response.
|
|
2209
|
+
* @param listTasks.action - Actions for filtering the list of tasks.
|
|
2210
|
+
* @param listTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
|
|
2211
|
+
* @param listTasks.sourceID - Source IDs for filtering the list of tasks.
|
|
2212
|
+
* @param listTasks.sourceType - Filters the tasks with the specified source type.
|
|
2213
|
+
* @param listTasks.destinationID - Destination IDs for filtering the list of tasks.
|
|
2214
|
+
* @param listTasks.triggerType - Type of task trigger for filtering the list of tasks.
|
|
2215
|
+
* @param listTasks.withEmailNotifications - If specified, the response only includes tasks with notifications.email.enabled set to this value.
|
|
2216
|
+
* @param listTasks.sort - Property by which to sort the list of tasks.
|
|
2217
|
+
* @param listTasks.order - Sort order of the response, ascending or descending.
|
|
2218
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2219
|
+
*/
|
|
2220
|
+
listTasks({
|
|
2221
|
+
itemsPerPage,
|
|
2222
|
+
page,
|
|
2223
|
+
action,
|
|
2224
|
+
enabled,
|
|
2225
|
+
sourceID,
|
|
2226
|
+
sourceType,
|
|
2227
|
+
destinationID,
|
|
2228
|
+
triggerType,
|
|
2229
|
+
withEmailNotifications,
|
|
2230
|
+
sort,
|
|
2231
|
+
order
|
|
2232
|
+
} = {}, requestOptions = void 0) {
|
|
2233
|
+
const requestPath = "/2/tasks";
|
|
2234
|
+
const headers = {};
|
|
2235
|
+
const queryParameters = {};
|
|
2236
|
+
if (itemsPerPage !== void 0) {
|
|
2237
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2238
|
+
}
|
|
2239
|
+
if (page !== void 0) {
|
|
2240
|
+
queryParameters["page"] = page.toString();
|
|
2241
|
+
}
|
|
2242
|
+
if (action !== void 0) {
|
|
2243
|
+
queryParameters["action"] = action.toString();
|
|
1111
2244
|
}
|
|
1112
|
-
if (
|
|
1113
|
-
queryParameters["
|
|
2245
|
+
if (enabled !== void 0) {
|
|
2246
|
+
queryParameters["enabled"] = enabled.toString();
|
|
2247
|
+
}
|
|
2248
|
+
if (sourceID !== void 0) {
|
|
2249
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
2250
|
+
}
|
|
2251
|
+
if (sourceType !== void 0) {
|
|
2252
|
+
queryParameters["sourceType"] = sourceType.toString();
|
|
2253
|
+
}
|
|
2254
|
+
if (destinationID !== void 0) {
|
|
2255
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
2256
|
+
}
|
|
2257
|
+
if (triggerType !== void 0) {
|
|
2258
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
2259
|
+
}
|
|
2260
|
+
if (withEmailNotifications !== void 0) {
|
|
2261
|
+
queryParameters["withEmailNotifications"] = withEmailNotifications.toString();
|
|
1114
2262
|
}
|
|
1115
2263
|
if (sort !== void 0) {
|
|
1116
2264
|
queryParameters["sort"] = sort.toString();
|
|
@@ -1129,6 +2277,8 @@ function createIngestionClient({
|
|
|
1129
2277
|
/**
|
|
1130
2278
|
* Retrieves a list of tasks.
|
|
1131
2279
|
*
|
|
2280
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2281
|
+
*
|
|
1132
2282
|
* Required API Key ACLs:
|
|
1133
2283
|
* - addObject
|
|
1134
2284
|
* - deleteIndex
|
|
@@ -1146,8 +2296,9 @@ function createIngestionClient({
|
|
|
1146
2296
|
* @param listTasks.sort - Property by which to sort the list of tasks.
|
|
1147
2297
|
* @param listTasks.order - Sort order of the response, ascending or descending.
|
|
1148
2298
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2299
|
+
* @see listTasks for the plain version.
|
|
1149
2300
|
*/
|
|
1150
|
-
|
|
2301
|
+
listTasksWithHTTPInfo({
|
|
1151
2302
|
itemsPerPage,
|
|
1152
2303
|
page,
|
|
1153
2304
|
action,
|
|
@@ -1202,7 +2353,7 @@ function createIngestionClient({
|
|
|
1202
2353
|
queryParameters,
|
|
1203
2354
|
headers
|
|
1204
2355
|
};
|
|
1205
|
-
return transporter.
|
|
2356
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1206
2357
|
},
|
|
1207
2358
|
/**
|
|
1208
2359
|
* Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead.
|
|
@@ -1264,6 +2415,69 @@ function createIngestionClient({
|
|
|
1264
2415
|
};
|
|
1265
2416
|
return transporter.request(request, requestOptions);
|
|
1266
2417
|
},
|
|
2418
|
+
/**
|
|
2419
|
+
* Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead.
|
|
2420
|
+
*
|
|
2421
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2422
|
+
*
|
|
2423
|
+
* Required API Key ACLs:
|
|
2424
|
+
* - addObject
|
|
2425
|
+
* - deleteIndex
|
|
2426
|
+
* - editSettings
|
|
2427
|
+
*
|
|
2428
|
+
* @deprecated
|
|
2429
|
+
* @param listTasksV1 - The listTasksV1 object.
|
|
2430
|
+
* @param listTasksV1.itemsPerPage - Number of items per page.
|
|
2431
|
+
* @param listTasksV1.page - Page number of the paginated API response.
|
|
2432
|
+
* @param listTasksV1.action - Actions for filtering the list of tasks.
|
|
2433
|
+
* @param listTasksV1.enabled - Whether to filter the list of tasks by the `enabled` status.
|
|
2434
|
+
* @param listTasksV1.sourceID - Source IDs for filtering the list of tasks.
|
|
2435
|
+
* @param listTasksV1.destinationID - Destination IDs for filtering the list of tasks.
|
|
2436
|
+
* @param listTasksV1.triggerType - Type of task trigger for filtering the list of tasks.
|
|
2437
|
+
* @param listTasksV1.sort - Property by which to sort the list of tasks.
|
|
2438
|
+
* @param listTasksV1.order - Sort order of the response, ascending or descending.
|
|
2439
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2440
|
+
* @see listTasksV1 for the plain version.
|
|
2441
|
+
*/
|
|
2442
|
+
listTasksV1WithHTTPInfo({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order } = {}, requestOptions = void 0) {
|
|
2443
|
+
const requestPath = "/1/tasks";
|
|
2444
|
+
const headers = {};
|
|
2445
|
+
const queryParameters = {};
|
|
2446
|
+
if (itemsPerPage !== void 0) {
|
|
2447
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2448
|
+
}
|
|
2449
|
+
if (page !== void 0) {
|
|
2450
|
+
queryParameters["page"] = page.toString();
|
|
2451
|
+
}
|
|
2452
|
+
if (action !== void 0) {
|
|
2453
|
+
queryParameters["action"] = action.toString();
|
|
2454
|
+
}
|
|
2455
|
+
if (enabled !== void 0) {
|
|
2456
|
+
queryParameters["enabled"] = enabled.toString();
|
|
2457
|
+
}
|
|
2458
|
+
if (sourceID !== void 0) {
|
|
2459
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
2460
|
+
}
|
|
2461
|
+
if (destinationID !== void 0) {
|
|
2462
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
2463
|
+
}
|
|
2464
|
+
if (triggerType !== void 0) {
|
|
2465
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
2466
|
+
}
|
|
2467
|
+
if (sort !== void 0) {
|
|
2468
|
+
queryParameters["sort"] = sort.toString();
|
|
2469
|
+
}
|
|
2470
|
+
if (order !== void 0) {
|
|
2471
|
+
queryParameters["order"] = order.toString();
|
|
2472
|
+
}
|
|
2473
|
+
const request = {
|
|
2474
|
+
method: "GET",
|
|
2475
|
+
path: requestPath,
|
|
2476
|
+
queryParameters,
|
|
2477
|
+
headers
|
|
2478
|
+
};
|
|
2479
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2480
|
+
},
|
|
1267
2481
|
/**
|
|
1268
2482
|
* Retrieves a list of transformations.
|
|
1269
2483
|
*
|
|
@@ -1306,6 +2520,51 @@ function createIngestionClient({
|
|
|
1306
2520
|
};
|
|
1307
2521
|
return transporter.request(request, requestOptions);
|
|
1308
2522
|
},
|
|
2523
|
+
/**
|
|
2524
|
+
* Retrieves a list of transformations.
|
|
2525
|
+
*
|
|
2526
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2527
|
+
*
|
|
2528
|
+
* Required API Key ACLs:
|
|
2529
|
+
* - addObject
|
|
2530
|
+
* - deleteIndex
|
|
2531
|
+
* - editSettings
|
|
2532
|
+
* @param listTransformations - The listTransformations object.
|
|
2533
|
+
* @param listTransformations.itemsPerPage - Number of items per page.
|
|
2534
|
+
* @param listTransformations.page - Page number of the paginated API response.
|
|
2535
|
+
* @param listTransformations.sort - Property by which to sort the list of transformations.
|
|
2536
|
+
* @param listTransformations.order - Sort order of the response, ascending or descending.
|
|
2537
|
+
* @param listTransformations.type - Whether to filter the list of transformations by the type of transformation.
|
|
2538
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2539
|
+
* @see listTransformations for the plain version.
|
|
2540
|
+
*/
|
|
2541
|
+
listTransformationsWithHTTPInfo({ itemsPerPage, page, sort, order, type } = {}, requestOptions = void 0) {
|
|
2542
|
+
const requestPath = "/1/transformations";
|
|
2543
|
+
const headers = {};
|
|
2544
|
+
const queryParameters = {};
|
|
2545
|
+
if (itemsPerPage !== void 0) {
|
|
2546
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2547
|
+
}
|
|
2548
|
+
if (page !== void 0) {
|
|
2549
|
+
queryParameters["page"] = page.toString();
|
|
2550
|
+
}
|
|
2551
|
+
if (sort !== void 0) {
|
|
2552
|
+
queryParameters["sort"] = sort.toString();
|
|
2553
|
+
}
|
|
2554
|
+
if (order !== void 0) {
|
|
2555
|
+
queryParameters["order"] = order.toString();
|
|
2556
|
+
}
|
|
2557
|
+
if (type !== void 0) {
|
|
2558
|
+
queryParameters["type"] = type.toString();
|
|
2559
|
+
}
|
|
2560
|
+
const request = {
|
|
2561
|
+
method: "GET",
|
|
2562
|
+
path: requestPath,
|
|
2563
|
+
queryParameters,
|
|
2564
|
+
headers
|
|
2565
|
+
};
|
|
2566
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2567
|
+
},
|
|
1309
2568
|
/**
|
|
1310
2569
|
* Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
|
|
1311
2570
|
*
|
|
@@ -1342,6 +2601,7 @@ function createIngestionClient({
|
|
|
1342
2601
|
data: pushTaskPayload
|
|
1343
2602
|
};
|
|
1344
2603
|
requestOptions = {
|
|
2604
|
+
...requestOptions,
|
|
1345
2605
|
timeouts: {
|
|
1346
2606
|
connect: 18e4,
|
|
1347
2607
|
read: 18e4,
|
|
@@ -1351,6 +2611,55 @@ function createIngestionClient({
|
|
|
1351
2611
|
};
|
|
1352
2612
|
return transporter.request(request, requestOptions);
|
|
1353
2613
|
},
|
|
2614
|
+
/**
|
|
2615
|
+
* Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
|
|
2616
|
+
*
|
|
2617
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2618
|
+
*
|
|
2619
|
+
* Required API Key ACLs:
|
|
2620
|
+
* - addObject
|
|
2621
|
+
* - deleteIndex
|
|
2622
|
+
* - editSettings
|
|
2623
|
+
* @param push - The push object.
|
|
2624
|
+
* @param push.indexName - Name of the index on which to perform the operation.
|
|
2625
|
+
* @param push.pushTaskPayload - The pushTaskPayload object.
|
|
2626
|
+
* @param push.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
|
|
2627
|
+
* @param push.referenceIndexName - This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index\'s transformation to it (e.g. the source index name).
|
|
2628
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2629
|
+
* @see push for the plain version.
|
|
2630
|
+
*/
|
|
2631
|
+
pushWithHTTPInfo({ indexName, pushTaskPayload, watch, referenceIndexName }, requestOptions) {
|
|
2632
|
+
validateRequired("indexName", "pushWithHTTPInfo", indexName);
|
|
2633
|
+
validateRequired("pushTaskPayload", "pushWithHTTPInfo", pushTaskPayload);
|
|
2634
|
+
validateRequired("pushTaskPayload.action", "pushWithHTTPInfo", pushTaskPayload.action);
|
|
2635
|
+
validateRequired("pushTaskPayload.records", "pushWithHTTPInfo", pushTaskPayload.records);
|
|
2636
|
+
const requestPath = "/1/push/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
|
|
2637
|
+
const headers = {};
|
|
2638
|
+
const queryParameters = {};
|
|
2639
|
+
if (watch !== void 0) {
|
|
2640
|
+
queryParameters["watch"] = watch.toString();
|
|
2641
|
+
}
|
|
2642
|
+
if (referenceIndexName !== void 0) {
|
|
2643
|
+
queryParameters["referenceIndexName"] = referenceIndexName.toString();
|
|
2644
|
+
}
|
|
2645
|
+
const request = {
|
|
2646
|
+
method: "POST",
|
|
2647
|
+
path: requestPath,
|
|
2648
|
+
queryParameters,
|
|
2649
|
+
headers,
|
|
2650
|
+
data: pushTaskPayload
|
|
2651
|
+
};
|
|
2652
|
+
requestOptions = {
|
|
2653
|
+
...requestOptions,
|
|
2654
|
+
timeouts: {
|
|
2655
|
+
connect: 18e4,
|
|
2656
|
+
read: 18e4,
|
|
2657
|
+
write: 18e4,
|
|
2658
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
2659
|
+
}
|
|
2660
|
+
};
|
|
2661
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2662
|
+
},
|
|
1354
2663
|
/**
|
|
1355
2664
|
* Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
|
|
1356
2665
|
*
|
|
@@ -1383,6 +2692,7 @@ function createIngestionClient({
|
|
|
1383
2692
|
data: pushTaskPayload
|
|
1384
2693
|
};
|
|
1385
2694
|
requestOptions = {
|
|
2695
|
+
...requestOptions,
|
|
1386
2696
|
timeouts: {
|
|
1387
2697
|
connect: 18e4,
|
|
1388
2698
|
read: 18e4,
|
|
@@ -1392,6 +2702,51 @@ function createIngestionClient({
|
|
|
1392
2702
|
};
|
|
1393
2703
|
return transporter.request(request, requestOptions);
|
|
1394
2704
|
},
|
|
2705
|
+
/**
|
|
2706
|
+
* Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
|
|
2707
|
+
*
|
|
2708
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2709
|
+
*
|
|
2710
|
+
* Required API Key ACLs:
|
|
2711
|
+
* - addObject
|
|
2712
|
+
* - deleteIndex
|
|
2713
|
+
* - editSettings
|
|
2714
|
+
* @param pushTask - The pushTask object.
|
|
2715
|
+
* @param pushTask.taskID - Unique identifier of a task.
|
|
2716
|
+
* @param pushTask.pushTaskPayload - The pushTaskPayload object.
|
|
2717
|
+
* @param pushTask.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
|
|
2718
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2719
|
+
* @see pushTask for the plain version.
|
|
2720
|
+
*/
|
|
2721
|
+
pushTaskWithHTTPInfo({ taskID, pushTaskPayload, watch }, requestOptions) {
|
|
2722
|
+
validateRequired("taskID", "pushTaskWithHTTPInfo", taskID);
|
|
2723
|
+
validateRequired("pushTaskPayload", "pushTaskWithHTTPInfo", pushTaskPayload);
|
|
2724
|
+
validateRequired("pushTaskPayload.action", "pushTaskWithHTTPInfo", pushTaskPayload.action);
|
|
2725
|
+
validateRequired("pushTaskPayload.records", "pushTaskWithHTTPInfo", pushTaskPayload.records);
|
|
2726
|
+
const requestPath = "/2/tasks/{taskID}/push".replace("{taskID}", encodeURIComponent(taskID));
|
|
2727
|
+
const headers = {};
|
|
2728
|
+
const queryParameters = {};
|
|
2729
|
+
if (watch !== void 0) {
|
|
2730
|
+
queryParameters["watch"] = watch.toString();
|
|
2731
|
+
}
|
|
2732
|
+
const request = {
|
|
2733
|
+
method: "POST",
|
|
2734
|
+
path: requestPath,
|
|
2735
|
+
queryParameters,
|
|
2736
|
+
headers,
|
|
2737
|
+
data: pushTaskPayload
|
|
2738
|
+
};
|
|
2739
|
+
requestOptions = {
|
|
2740
|
+
...requestOptions,
|
|
2741
|
+
timeouts: {
|
|
2742
|
+
connect: 18e4,
|
|
2743
|
+
read: 18e4,
|
|
2744
|
+
write: 18e4,
|
|
2745
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
2746
|
+
}
|
|
2747
|
+
};
|
|
2748
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2749
|
+
},
|
|
1395
2750
|
/**
|
|
1396
2751
|
* Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
|
|
1397
2752
|
*
|
|
@@ -1417,13 +2772,73 @@ function createIngestionClient({
|
|
|
1417
2772
|
path: requestPath,
|
|
1418
2773
|
queryParameters,
|
|
1419
2774
|
headers,
|
|
1420
|
-
data: taskReplace
|
|
2775
|
+
data: taskReplace
|
|
2776
|
+
};
|
|
2777
|
+
return transporter.request(request, requestOptions);
|
|
2778
|
+
},
|
|
2779
|
+
/**
|
|
2780
|
+
* Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
|
|
2781
|
+
*
|
|
2782
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2783
|
+
*
|
|
2784
|
+
* Required API Key ACLs:
|
|
2785
|
+
* - addObject
|
|
2786
|
+
* - deleteIndex
|
|
2787
|
+
* - editSettings
|
|
2788
|
+
* @param replaceTask - The replaceTask object.
|
|
2789
|
+
* @param replaceTask.taskID - Unique identifier of a task.
|
|
2790
|
+
* @param replaceTask.taskReplace - The taskReplace object.
|
|
2791
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2792
|
+
* @see replaceTask for the plain version.
|
|
2793
|
+
*/
|
|
2794
|
+
replaceTaskWithHTTPInfo({ taskID, taskReplace }, requestOptions) {
|
|
2795
|
+
validateRequired("taskID", "replaceTaskWithHTTPInfo", taskID);
|
|
2796
|
+
validateRequired("taskReplace", "replaceTaskWithHTTPInfo", taskReplace);
|
|
2797
|
+
validateRequired("taskReplace.destinationID", "replaceTaskWithHTTPInfo", taskReplace.destinationID);
|
|
2798
|
+
validateRequired("taskReplace.action", "replaceTaskWithHTTPInfo", taskReplace.action);
|
|
2799
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
2800
|
+
const headers = {};
|
|
2801
|
+
const queryParameters = {};
|
|
2802
|
+
const request = {
|
|
2803
|
+
method: "PUT",
|
|
2804
|
+
path: requestPath,
|
|
2805
|
+
queryParameters,
|
|
2806
|
+
headers,
|
|
2807
|
+
data: taskReplace
|
|
2808
|
+
};
|
|
2809
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2810
|
+
},
|
|
2811
|
+
/**
|
|
2812
|
+
* Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
|
|
2813
|
+
*
|
|
2814
|
+
* Required API Key ACLs:
|
|
2815
|
+
* - addObject
|
|
2816
|
+
* - deleteIndex
|
|
2817
|
+
* - editSettings
|
|
2818
|
+
* @param runSource - The runSource object.
|
|
2819
|
+
* @param runSource.sourceID - Unique identifier of a source.
|
|
2820
|
+
* @param runSource.runSourcePayload -
|
|
2821
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2822
|
+
*/
|
|
2823
|
+
runSource({ sourceID, runSourcePayload }, requestOptions) {
|
|
2824
|
+
validateRequired("sourceID", "runSource", sourceID);
|
|
2825
|
+
const requestPath = "/1/sources/{sourceID}/run".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
2826
|
+
const headers = {};
|
|
2827
|
+
const queryParameters = {};
|
|
2828
|
+
const request = {
|
|
2829
|
+
method: "POST",
|
|
2830
|
+
path: requestPath,
|
|
2831
|
+
queryParameters,
|
|
2832
|
+
headers,
|
|
2833
|
+
data: runSourcePayload ? runSourcePayload : {}
|
|
1421
2834
|
};
|
|
1422
2835
|
return transporter.request(request, requestOptions);
|
|
1423
2836
|
},
|
|
1424
2837
|
/**
|
|
1425
2838
|
* Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
|
|
1426
2839
|
*
|
|
2840
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2841
|
+
*
|
|
1427
2842
|
* Required API Key ACLs:
|
|
1428
2843
|
* - addObject
|
|
1429
2844
|
* - deleteIndex
|
|
@@ -1432,9 +2847,10 @@ function createIngestionClient({
|
|
|
1432
2847
|
* @param runSource.sourceID - Unique identifier of a source.
|
|
1433
2848
|
* @param runSource.runSourcePayload -
|
|
1434
2849
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2850
|
+
* @see runSource for the plain version.
|
|
1435
2851
|
*/
|
|
1436
|
-
|
|
1437
|
-
validateRequired("sourceID", "
|
|
2852
|
+
runSourceWithHTTPInfo({ sourceID, runSourcePayload }, requestOptions) {
|
|
2853
|
+
validateRequired("sourceID", "runSourceWithHTTPInfo", sourceID);
|
|
1438
2854
|
const requestPath = "/1/sources/{sourceID}/run".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
1439
2855
|
const headers = {};
|
|
1440
2856
|
const queryParameters = {};
|
|
@@ -1445,7 +2861,7 @@ function createIngestionClient({
|
|
|
1445
2861
|
headers,
|
|
1446
2862
|
data: runSourcePayload ? runSourcePayload : {}
|
|
1447
2863
|
};
|
|
1448
|
-
return transporter.
|
|
2864
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1449
2865
|
},
|
|
1450
2866
|
/**
|
|
1451
2867
|
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
@@ -1473,6 +2889,35 @@ function createIngestionClient({
|
|
|
1473
2889
|
};
|
|
1474
2890
|
return transporter.request(request, requestOptions);
|
|
1475
2891
|
},
|
|
2892
|
+
/**
|
|
2893
|
+
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
2894
|
+
*
|
|
2895
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2896
|
+
*
|
|
2897
|
+
* Required API Key ACLs:
|
|
2898
|
+
* - addObject
|
|
2899
|
+
* - deleteIndex
|
|
2900
|
+
* - editSettings
|
|
2901
|
+
* @param runTask - The runTask object.
|
|
2902
|
+
* @param runTask.taskID - Unique identifier of a task.
|
|
2903
|
+
* @param runTask.runTaskPayload -
|
|
2904
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2905
|
+
* @see runTask for the plain version.
|
|
2906
|
+
*/
|
|
2907
|
+
runTaskWithHTTPInfo({ taskID, runTaskPayload }, requestOptions) {
|
|
2908
|
+
validateRequired("taskID", "runTaskWithHTTPInfo", taskID);
|
|
2909
|
+
const requestPath = "/2/tasks/{taskID}/run".replace("{taskID}", encodeURIComponent(taskID));
|
|
2910
|
+
const headers = {};
|
|
2911
|
+
const queryParameters = {};
|
|
2912
|
+
const request = {
|
|
2913
|
+
method: "POST",
|
|
2914
|
+
path: requestPath,
|
|
2915
|
+
queryParameters,
|
|
2916
|
+
headers,
|
|
2917
|
+
data: runTaskPayload ? runTaskPayload : {}
|
|
2918
|
+
};
|
|
2919
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2920
|
+
},
|
|
1476
2921
|
/**
|
|
1477
2922
|
* Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
1478
2923
|
*
|
|
@@ -1501,6 +2946,37 @@ function createIngestionClient({
|
|
|
1501
2946
|
};
|
|
1502
2947
|
return transporter.request(request, requestOptions);
|
|
1503
2948
|
},
|
|
2949
|
+
/**
|
|
2950
|
+
* Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
2951
|
+
*
|
|
2952
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2953
|
+
*
|
|
2954
|
+
* Required API Key ACLs:
|
|
2955
|
+
* - addObject
|
|
2956
|
+
* - deleteIndex
|
|
2957
|
+
* - editSettings
|
|
2958
|
+
*
|
|
2959
|
+
* @deprecated
|
|
2960
|
+
* @param runTaskV1 - The runTaskV1 object.
|
|
2961
|
+
* @param runTaskV1.taskID - Unique identifier of a task.
|
|
2962
|
+
* @param runTaskV1.runTaskPayload -
|
|
2963
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2964
|
+
* @see runTaskV1 for the plain version.
|
|
2965
|
+
*/
|
|
2966
|
+
runTaskV1WithHTTPInfo({ taskID, runTaskPayload }, requestOptions) {
|
|
2967
|
+
validateRequired("taskID", "runTaskV1WithHTTPInfo", taskID);
|
|
2968
|
+
const requestPath = "/1/tasks/{taskID}/run".replace("{taskID}", encodeURIComponent(taskID));
|
|
2969
|
+
const headers = {};
|
|
2970
|
+
const queryParameters = {};
|
|
2971
|
+
const request = {
|
|
2972
|
+
method: "POST",
|
|
2973
|
+
path: requestPath,
|
|
2974
|
+
queryParameters,
|
|
2975
|
+
headers,
|
|
2976
|
+
data: runTaskPayload ? runTaskPayload : {}
|
|
2977
|
+
};
|
|
2978
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2979
|
+
},
|
|
1504
2980
|
/**
|
|
1505
2981
|
* Searches for authentication resources.
|
|
1506
2982
|
*
|
|
@@ -1530,6 +3006,38 @@ function createIngestionClient({
|
|
|
1530
3006
|
};
|
|
1531
3007
|
return transporter.request(request, requestOptions);
|
|
1532
3008
|
},
|
|
3009
|
+
/**
|
|
3010
|
+
* Searches for authentication resources.
|
|
3011
|
+
*
|
|
3012
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3013
|
+
*
|
|
3014
|
+
* Required API Key ACLs:
|
|
3015
|
+
* - addObject
|
|
3016
|
+
* - deleteIndex
|
|
3017
|
+
* - editSettings
|
|
3018
|
+
* @param authenticationSearch - The authenticationSearch object.
|
|
3019
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3020
|
+
* @see searchAuthentications for the plain version.
|
|
3021
|
+
*/
|
|
3022
|
+
searchAuthenticationsWithHTTPInfo(authenticationSearch, requestOptions) {
|
|
3023
|
+
validateRequired("authenticationSearch", "searchAuthenticationsWithHTTPInfo", authenticationSearch);
|
|
3024
|
+
validateRequired(
|
|
3025
|
+
"authenticationSearch.authenticationIDs",
|
|
3026
|
+
"searchAuthenticationsWithHTTPInfo",
|
|
3027
|
+
authenticationSearch.authenticationIDs
|
|
3028
|
+
);
|
|
3029
|
+
const requestPath = "/1/authentications/search";
|
|
3030
|
+
const headers = {};
|
|
3031
|
+
const queryParameters = {};
|
|
3032
|
+
const request = {
|
|
3033
|
+
method: "POST",
|
|
3034
|
+
path: requestPath,
|
|
3035
|
+
queryParameters,
|
|
3036
|
+
headers,
|
|
3037
|
+
data: authenticationSearch
|
|
3038
|
+
};
|
|
3039
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3040
|
+
},
|
|
1533
3041
|
/**
|
|
1534
3042
|
* Searches for destinations.
|
|
1535
3043
|
*
|
|
@@ -1555,6 +3063,38 @@ function createIngestionClient({
|
|
|
1555
3063
|
};
|
|
1556
3064
|
return transporter.request(request, requestOptions);
|
|
1557
3065
|
},
|
|
3066
|
+
/**
|
|
3067
|
+
* Searches for destinations.
|
|
3068
|
+
*
|
|
3069
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3070
|
+
*
|
|
3071
|
+
* Required API Key ACLs:
|
|
3072
|
+
* - addObject
|
|
3073
|
+
* - deleteIndex
|
|
3074
|
+
* - editSettings
|
|
3075
|
+
* @param destinationSearch - The destinationSearch object.
|
|
3076
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3077
|
+
* @see searchDestinations for the plain version.
|
|
3078
|
+
*/
|
|
3079
|
+
searchDestinationsWithHTTPInfo(destinationSearch, requestOptions) {
|
|
3080
|
+
validateRequired("destinationSearch", "searchDestinationsWithHTTPInfo", destinationSearch);
|
|
3081
|
+
validateRequired(
|
|
3082
|
+
"destinationSearch.destinationIDs",
|
|
3083
|
+
"searchDestinationsWithHTTPInfo",
|
|
3084
|
+
destinationSearch.destinationIDs
|
|
3085
|
+
);
|
|
3086
|
+
const requestPath = "/1/destinations/search";
|
|
3087
|
+
const headers = {};
|
|
3088
|
+
const queryParameters = {};
|
|
3089
|
+
const request = {
|
|
3090
|
+
method: "POST",
|
|
3091
|
+
path: requestPath,
|
|
3092
|
+
queryParameters,
|
|
3093
|
+
headers,
|
|
3094
|
+
data: destinationSearch
|
|
3095
|
+
};
|
|
3096
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3097
|
+
},
|
|
1558
3098
|
/**
|
|
1559
3099
|
* Searches for sources.
|
|
1560
3100
|
*
|
|
@@ -1580,6 +3120,34 @@ function createIngestionClient({
|
|
|
1580
3120
|
};
|
|
1581
3121
|
return transporter.request(request, requestOptions);
|
|
1582
3122
|
},
|
|
3123
|
+
/**
|
|
3124
|
+
* Searches for sources.
|
|
3125
|
+
*
|
|
3126
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3127
|
+
*
|
|
3128
|
+
* Required API Key ACLs:
|
|
3129
|
+
* - addObject
|
|
3130
|
+
* - deleteIndex
|
|
3131
|
+
* - editSettings
|
|
3132
|
+
* @param sourceSearch - The sourceSearch object.
|
|
3133
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3134
|
+
* @see searchSources for the plain version.
|
|
3135
|
+
*/
|
|
3136
|
+
searchSourcesWithHTTPInfo(sourceSearch, requestOptions) {
|
|
3137
|
+
validateRequired("sourceSearch", "searchSourcesWithHTTPInfo", sourceSearch);
|
|
3138
|
+
validateRequired("sourceSearch.sourceIDs", "searchSourcesWithHTTPInfo", sourceSearch.sourceIDs);
|
|
3139
|
+
const requestPath = "/1/sources/search";
|
|
3140
|
+
const headers = {};
|
|
3141
|
+
const queryParameters = {};
|
|
3142
|
+
const request = {
|
|
3143
|
+
method: "POST",
|
|
3144
|
+
path: requestPath,
|
|
3145
|
+
queryParameters,
|
|
3146
|
+
headers,
|
|
3147
|
+
data: sourceSearch
|
|
3148
|
+
};
|
|
3149
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3150
|
+
},
|
|
1583
3151
|
/**
|
|
1584
3152
|
* Searches for tasks.
|
|
1585
3153
|
*
|
|
@@ -1605,6 +3173,34 @@ function createIngestionClient({
|
|
|
1605
3173
|
};
|
|
1606
3174
|
return transporter.request(request, requestOptions);
|
|
1607
3175
|
},
|
|
3176
|
+
/**
|
|
3177
|
+
* Searches for tasks.
|
|
3178
|
+
*
|
|
3179
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3180
|
+
*
|
|
3181
|
+
* Required API Key ACLs:
|
|
3182
|
+
* - addObject
|
|
3183
|
+
* - deleteIndex
|
|
3184
|
+
* - editSettings
|
|
3185
|
+
* @param taskSearch - The taskSearch object.
|
|
3186
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3187
|
+
* @see searchTasks for the plain version.
|
|
3188
|
+
*/
|
|
3189
|
+
searchTasksWithHTTPInfo(taskSearch, requestOptions) {
|
|
3190
|
+
validateRequired("taskSearch", "searchTasksWithHTTPInfo", taskSearch);
|
|
3191
|
+
validateRequired("taskSearch.taskIDs", "searchTasksWithHTTPInfo", taskSearch.taskIDs);
|
|
3192
|
+
const requestPath = "/2/tasks/search";
|
|
3193
|
+
const headers = {};
|
|
3194
|
+
const queryParameters = {};
|
|
3195
|
+
const request = {
|
|
3196
|
+
method: "POST",
|
|
3197
|
+
path: requestPath,
|
|
3198
|
+
queryParameters,
|
|
3199
|
+
headers,
|
|
3200
|
+
data: taskSearch
|
|
3201
|
+
};
|
|
3202
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3203
|
+
},
|
|
1608
3204
|
/**
|
|
1609
3205
|
* Searches for tasks using the v1 endpoint. Use `searchTasks` instead.
|
|
1610
3206
|
*
|
|
@@ -1632,6 +3228,36 @@ function createIngestionClient({
|
|
|
1632
3228
|
};
|
|
1633
3229
|
return transporter.request(request, requestOptions);
|
|
1634
3230
|
},
|
|
3231
|
+
/**
|
|
3232
|
+
* Searches for tasks using the v1 endpoint. Use `searchTasks` instead.
|
|
3233
|
+
*
|
|
3234
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3235
|
+
*
|
|
3236
|
+
* Required API Key ACLs:
|
|
3237
|
+
* - addObject
|
|
3238
|
+
* - deleteIndex
|
|
3239
|
+
* - editSettings
|
|
3240
|
+
*
|
|
3241
|
+
* @deprecated
|
|
3242
|
+
* @param taskSearch - The taskSearch object.
|
|
3243
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3244
|
+
* @see searchTasksV1 for the plain version.
|
|
3245
|
+
*/
|
|
3246
|
+
searchTasksV1WithHTTPInfo(taskSearch, requestOptions) {
|
|
3247
|
+
validateRequired("taskSearch", "searchTasksV1WithHTTPInfo", taskSearch);
|
|
3248
|
+
validateRequired("taskSearch.taskIDs", "searchTasksV1WithHTTPInfo", taskSearch.taskIDs);
|
|
3249
|
+
const requestPath = "/1/tasks/search";
|
|
3250
|
+
const headers = {};
|
|
3251
|
+
const queryParameters = {};
|
|
3252
|
+
const request = {
|
|
3253
|
+
method: "POST",
|
|
3254
|
+
path: requestPath,
|
|
3255
|
+
queryParameters,
|
|
3256
|
+
headers,
|
|
3257
|
+
data: taskSearch
|
|
3258
|
+
};
|
|
3259
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3260
|
+
},
|
|
1635
3261
|
/**
|
|
1636
3262
|
* Searches for transformations.
|
|
1637
3263
|
*
|
|
@@ -1661,6 +3287,38 @@ function createIngestionClient({
|
|
|
1661
3287
|
};
|
|
1662
3288
|
return transporter.request(request, requestOptions);
|
|
1663
3289
|
},
|
|
3290
|
+
/**
|
|
3291
|
+
* Searches for transformations.
|
|
3292
|
+
*
|
|
3293
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3294
|
+
*
|
|
3295
|
+
* Required API Key ACLs:
|
|
3296
|
+
* - addObject
|
|
3297
|
+
* - deleteIndex
|
|
3298
|
+
* - editSettings
|
|
3299
|
+
* @param transformationSearch - The transformationSearch object.
|
|
3300
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3301
|
+
* @see searchTransformations for the plain version.
|
|
3302
|
+
*/
|
|
3303
|
+
searchTransformationsWithHTTPInfo(transformationSearch, requestOptions) {
|
|
3304
|
+
validateRequired("transformationSearch", "searchTransformationsWithHTTPInfo", transformationSearch);
|
|
3305
|
+
validateRequired(
|
|
3306
|
+
"transformationSearch.transformationIDs",
|
|
3307
|
+
"searchTransformationsWithHTTPInfo",
|
|
3308
|
+
transformationSearch.transformationIDs
|
|
3309
|
+
);
|
|
3310
|
+
const requestPath = "/1/transformations/search";
|
|
3311
|
+
const headers = {};
|
|
3312
|
+
const queryParameters = {};
|
|
3313
|
+
const request = {
|
|
3314
|
+
method: "POST",
|
|
3315
|
+
path: requestPath,
|
|
3316
|
+
queryParameters,
|
|
3317
|
+
headers,
|
|
3318
|
+
data: transformationSearch
|
|
3319
|
+
};
|
|
3320
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3321
|
+
},
|
|
1664
3322
|
/**
|
|
1665
3323
|
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: airbyte`.
|
|
1666
3324
|
*
|
|
@@ -1684,6 +3342,43 @@ function createIngestionClient({
|
|
|
1684
3342
|
headers
|
|
1685
3343
|
};
|
|
1686
3344
|
requestOptions = {
|
|
3345
|
+
...requestOptions,
|
|
3346
|
+
timeouts: {
|
|
3347
|
+
connect: 18e4,
|
|
3348
|
+
read: 18e4,
|
|
3349
|
+
write: 18e4,
|
|
3350
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
3351
|
+
}
|
|
3352
|
+
};
|
|
3353
|
+
return transporter.request(request, requestOptions);
|
|
3354
|
+
},
|
|
3355
|
+
/**
|
|
3356
|
+
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: airbyte`.
|
|
3357
|
+
*
|
|
3358
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3359
|
+
*
|
|
3360
|
+
* Required API Key ACLs:
|
|
3361
|
+
* - addObject
|
|
3362
|
+
* - deleteIndex
|
|
3363
|
+
* - editSettings
|
|
3364
|
+
* @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
|
|
3365
|
+
* @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
|
|
3366
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3367
|
+
* @see triggerDockerSourceDiscover for the plain version.
|
|
3368
|
+
*/
|
|
3369
|
+
triggerDockerSourceDiscoverWithHTTPInfo({ sourceID }, requestOptions) {
|
|
3370
|
+
validateRequired("sourceID", "triggerDockerSourceDiscoverWithHTTPInfo", sourceID);
|
|
3371
|
+
const requestPath = "/1/sources/{sourceID}/discover".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
3372
|
+
const headers = {};
|
|
3373
|
+
const queryParameters = {};
|
|
3374
|
+
const request = {
|
|
3375
|
+
method: "POST",
|
|
3376
|
+
path: requestPath,
|
|
3377
|
+
queryParameters,
|
|
3378
|
+
headers
|
|
3379
|
+
};
|
|
3380
|
+
requestOptions = {
|
|
3381
|
+
...requestOptions,
|
|
1687
3382
|
timeouts: {
|
|
1688
3383
|
connect: 18e4,
|
|
1689
3384
|
read: 18e4,
|
|
@@ -1691,21 +3386,53 @@ function createIngestionClient({
|
|
|
1691
3386
|
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
1692
3387
|
}
|
|
1693
3388
|
};
|
|
3389
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3390
|
+
},
|
|
3391
|
+
/**
|
|
3392
|
+
* Try a transformation before creating it.
|
|
3393
|
+
*
|
|
3394
|
+
* Required API Key ACLs:
|
|
3395
|
+
* - addObject
|
|
3396
|
+
* - deleteIndex
|
|
3397
|
+
* - editSettings
|
|
3398
|
+
* @param transformationTry - The transformationTry object.
|
|
3399
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3400
|
+
*/
|
|
3401
|
+
tryTransformation(transformationTry, requestOptions) {
|
|
3402
|
+
validateRequired("transformationTry", "tryTransformation", transformationTry);
|
|
3403
|
+
validateRequired("transformationTry.sampleRecord", "tryTransformation", transformationTry.sampleRecord);
|
|
3404
|
+
const requestPath = "/1/transformations/try";
|
|
3405
|
+
const headers = {};
|
|
3406
|
+
const queryParameters = {};
|
|
3407
|
+
const request = {
|
|
3408
|
+
method: "POST",
|
|
3409
|
+
path: requestPath,
|
|
3410
|
+
queryParameters,
|
|
3411
|
+
headers,
|
|
3412
|
+
data: transformationTry
|
|
3413
|
+
};
|
|
1694
3414
|
return transporter.request(request, requestOptions);
|
|
1695
3415
|
},
|
|
1696
3416
|
/**
|
|
1697
3417
|
* Try a transformation before creating it.
|
|
1698
3418
|
*
|
|
3419
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3420
|
+
*
|
|
1699
3421
|
* Required API Key ACLs:
|
|
1700
3422
|
* - addObject
|
|
1701
3423
|
* - deleteIndex
|
|
1702
3424
|
* - editSettings
|
|
1703
3425
|
* @param transformationTry - The transformationTry object.
|
|
1704
3426
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3427
|
+
* @see tryTransformation for the plain version.
|
|
1705
3428
|
*/
|
|
1706
|
-
|
|
1707
|
-
validateRequired("transformationTry", "
|
|
1708
|
-
validateRequired(
|
|
3429
|
+
tryTransformationWithHTTPInfo(transformationTry, requestOptions) {
|
|
3430
|
+
validateRequired("transformationTry", "tryTransformationWithHTTPInfo", transformationTry);
|
|
3431
|
+
validateRequired(
|
|
3432
|
+
"transformationTry.sampleRecord",
|
|
3433
|
+
"tryTransformationWithHTTPInfo",
|
|
3434
|
+
transformationTry.sampleRecord
|
|
3435
|
+
);
|
|
1709
3436
|
const requestPath = "/1/transformations/try";
|
|
1710
3437
|
const headers = {};
|
|
1711
3438
|
const queryParameters = {};
|
|
@@ -1716,7 +3443,7 @@ function createIngestionClient({
|
|
|
1716
3443
|
headers,
|
|
1717
3444
|
data: transformationTry
|
|
1718
3445
|
};
|
|
1719
|
-
return transporter.
|
|
3446
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1720
3447
|
},
|
|
1721
3448
|
/**
|
|
1722
3449
|
* Try a transformation before updating it.
|
|
@@ -1753,6 +3480,44 @@ function createIngestionClient({
|
|
|
1753
3480
|
};
|
|
1754
3481
|
return transporter.request(request, requestOptions);
|
|
1755
3482
|
},
|
|
3483
|
+
/**
|
|
3484
|
+
* Try a transformation before updating it.
|
|
3485
|
+
*
|
|
3486
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3487
|
+
*
|
|
3488
|
+
* Required API Key ACLs:
|
|
3489
|
+
* - addObject
|
|
3490
|
+
* - deleteIndex
|
|
3491
|
+
* - editSettings
|
|
3492
|
+
* @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
|
|
3493
|
+
* @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
|
|
3494
|
+
* @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
|
|
3495
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3496
|
+
* @see tryTransformationBeforeUpdate for the plain version.
|
|
3497
|
+
*/
|
|
3498
|
+
tryTransformationBeforeUpdateWithHTTPInfo({ transformationID, transformationTry }, requestOptions) {
|
|
3499
|
+
validateRequired("transformationID", "tryTransformationBeforeUpdateWithHTTPInfo", transformationID);
|
|
3500
|
+
validateRequired("transformationTry", "tryTransformationBeforeUpdateWithHTTPInfo", transformationTry);
|
|
3501
|
+
validateRequired(
|
|
3502
|
+
"transformationTry.sampleRecord",
|
|
3503
|
+
"tryTransformationBeforeUpdateWithHTTPInfo",
|
|
3504
|
+
transformationTry.sampleRecord
|
|
3505
|
+
);
|
|
3506
|
+
const requestPath = "/1/transformations/{transformationID}/try".replace(
|
|
3507
|
+
"{transformationID}",
|
|
3508
|
+
encodeURIComponent(transformationID)
|
|
3509
|
+
);
|
|
3510
|
+
const headers = {};
|
|
3511
|
+
const queryParameters = {};
|
|
3512
|
+
const request = {
|
|
3513
|
+
method: "POST",
|
|
3514
|
+
path: requestPath,
|
|
3515
|
+
queryParameters,
|
|
3516
|
+
headers,
|
|
3517
|
+
data: transformationTry
|
|
3518
|
+
};
|
|
3519
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3520
|
+
},
|
|
1756
3521
|
/**
|
|
1757
3522
|
* Updates an authentication resource.
|
|
1758
3523
|
*
|
|
@@ -1783,6 +3548,39 @@ function createIngestionClient({
|
|
|
1783
3548
|
};
|
|
1784
3549
|
return transporter.request(request, requestOptions);
|
|
1785
3550
|
},
|
|
3551
|
+
/**
|
|
3552
|
+
* Updates an authentication resource.
|
|
3553
|
+
*
|
|
3554
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3555
|
+
*
|
|
3556
|
+
* Required API Key ACLs:
|
|
3557
|
+
* - addObject
|
|
3558
|
+
* - deleteIndex
|
|
3559
|
+
* - editSettings
|
|
3560
|
+
* @param updateAuthentication - The updateAuthentication object.
|
|
3561
|
+
* @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
3562
|
+
* @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
|
|
3563
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3564
|
+
* @see updateAuthentication for the plain version.
|
|
3565
|
+
*/
|
|
3566
|
+
updateAuthenticationWithHTTPInfo({ authenticationID, authenticationUpdate }, requestOptions) {
|
|
3567
|
+
validateRequired("authenticationID", "updateAuthenticationWithHTTPInfo", authenticationID);
|
|
3568
|
+
validateRequired("authenticationUpdate", "updateAuthenticationWithHTTPInfo", authenticationUpdate);
|
|
3569
|
+
const requestPath = "/1/authentications/{authenticationID}".replace(
|
|
3570
|
+
"{authenticationID}",
|
|
3571
|
+
encodeURIComponent(authenticationID)
|
|
3572
|
+
);
|
|
3573
|
+
const headers = {};
|
|
3574
|
+
const queryParameters = {};
|
|
3575
|
+
const request = {
|
|
3576
|
+
method: "PATCH",
|
|
3577
|
+
path: requestPath,
|
|
3578
|
+
queryParameters,
|
|
3579
|
+
headers,
|
|
3580
|
+
data: authenticationUpdate
|
|
3581
|
+
};
|
|
3582
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3583
|
+
},
|
|
1786
3584
|
/**
|
|
1787
3585
|
* Updates the destination by its ID.
|
|
1788
3586
|
*
|
|
@@ -1813,6 +3611,39 @@ function createIngestionClient({
|
|
|
1813
3611
|
};
|
|
1814
3612
|
return transporter.request(request, requestOptions);
|
|
1815
3613
|
},
|
|
3614
|
+
/**
|
|
3615
|
+
* Updates the destination by its ID.
|
|
3616
|
+
*
|
|
3617
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3618
|
+
*
|
|
3619
|
+
* Required API Key ACLs:
|
|
3620
|
+
* - addObject
|
|
3621
|
+
* - deleteIndex
|
|
3622
|
+
* - editSettings
|
|
3623
|
+
* @param updateDestination - The updateDestination object.
|
|
3624
|
+
* @param updateDestination.destinationID - Unique identifier of a destination.
|
|
3625
|
+
* @param updateDestination.destinationUpdate - The destinationUpdate object.
|
|
3626
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3627
|
+
* @see updateDestination for the plain version.
|
|
3628
|
+
*/
|
|
3629
|
+
updateDestinationWithHTTPInfo({ destinationID, destinationUpdate }, requestOptions) {
|
|
3630
|
+
validateRequired("destinationID", "updateDestinationWithHTTPInfo", destinationID);
|
|
3631
|
+
validateRequired("destinationUpdate", "updateDestinationWithHTTPInfo", destinationUpdate);
|
|
3632
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
3633
|
+
"{destinationID}",
|
|
3634
|
+
encodeURIComponent(destinationID)
|
|
3635
|
+
);
|
|
3636
|
+
const headers = {};
|
|
3637
|
+
const queryParameters = {};
|
|
3638
|
+
const request = {
|
|
3639
|
+
method: "PATCH",
|
|
3640
|
+
path: requestPath,
|
|
3641
|
+
queryParameters,
|
|
3642
|
+
headers,
|
|
3643
|
+
data: destinationUpdate
|
|
3644
|
+
};
|
|
3645
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3646
|
+
},
|
|
1816
3647
|
/**
|
|
1817
3648
|
* Updates a source by its ID.
|
|
1818
3649
|
*
|
|
@@ -1840,6 +3671,36 @@ function createIngestionClient({
|
|
|
1840
3671
|
};
|
|
1841
3672
|
return transporter.request(request, requestOptions);
|
|
1842
3673
|
},
|
|
3674
|
+
/**
|
|
3675
|
+
* Updates a source by its ID.
|
|
3676
|
+
*
|
|
3677
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3678
|
+
*
|
|
3679
|
+
* Required API Key ACLs:
|
|
3680
|
+
* - addObject
|
|
3681
|
+
* - deleteIndex
|
|
3682
|
+
* - editSettings
|
|
3683
|
+
* @param updateSource - The updateSource object.
|
|
3684
|
+
* @param updateSource.sourceID - Unique identifier of a source.
|
|
3685
|
+
* @param updateSource.sourceUpdate - The sourceUpdate object.
|
|
3686
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3687
|
+
* @see updateSource for the plain version.
|
|
3688
|
+
*/
|
|
3689
|
+
updateSourceWithHTTPInfo({ sourceID, sourceUpdate }, requestOptions) {
|
|
3690
|
+
validateRequired("sourceID", "updateSourceWithHTTPInfo", sourceID);
|
|
3691
|
+
validateRequired("sourceUpdate", "updateSourceWithHTTPInfo", sourceUpdate);
|
|
3692
|
+
const requestPath = "/1/sources/{sourceID}".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
3693
|
+
const headers = {};
|
|
3694
|
+
const queryParameters = {};
|
|
3695
|
+
const request = {
|
|
3696
|
+
method: "PATCH",
|
|
3697
|
+
path: requestPath,
|
|
3698
|
+
queryParameters,
|
|
3699
|
+
headers,
|
|
3700
|
+
data: sourceUpdate
|
|
3701
|
+
};
|
|
3702
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3703
|
+
},
|
|
1843
3704
|
/**
|
|
1844
3705
|
* Partially updates a task by its ID.
|
|
1845
3706
|
*
|
|
@@ -1867,6 +3728,36 @@ function createIngestionClient({
|
|
|
1867
3728
|
};
|
|
1868
3729
|
return transporter.request(request, requestOptions);
|
|
1869
3730
|
},
|
|
3731
|
+
/**
|
|
3732
|
+
* Partially updates a task by its ID.
|
|
3733
|
+
*
|
|
3734
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3735
|
+
*
|
|
3736
|
+
* Required API Key ACLs:
|
|
3737
|
+
* - addObject
|
|
3738
|
+
* - deleteIndex
|
|
3739
|
+
* - editSettings
|
|
3740
|
+
* @param updateTask - The updateTask object.
|
|
3741
|
+
* @param updateTask.taskID - Unique identifier of a task.
|
|
3742
|
+
* @param updateTask.taskUpdate - The taskUpdate object.
|
|
3743
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3744
|
+
* @see updateTask for the plain version.
|
|
3745
|
+
*/
|
|
3746
|
+
updateTaskWithHTTPInfo({ taskID, taskUpdate }, requestOptions) {
|
|
3747
|
+
validateRequired("taskID", "updateTaskWithHTTPInfo", taskID);
|
|
3748
|
+
validateRequired("taskUpdate", "updateTaskWithHTTPInfo", taskUpdate);
|
|
3749
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
3750
|
+
const headers = {};
|
|
3751
|
+
const queryParameters = {};
|
|
3752
|
+
const request = {
|
|
3753
|
+
method: "PATCH",
|
|
3754
|
+
path: requestPath,
|
|
3755
|
+
queryParameters,
|
|
3756
|
+
headers,
|
|
3757
|
+
data: taskUpdate
|
|
3758
|
+
};
|
|
3759
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3760
|
+
},
|
|
1870
3761
|
/**
|
|
1871
3762
|
* Updates a task by its ID using the v1 endpoint. Use `updateTask` instead.
|
|
1872
3763
|
*
|
|
@@ -1896,6 +3787,38 @@ function createIngestionClient({
|
|
|
1896
3787
|
};
|
|
1897
3788
|
return transporter.request(request, requestOptions);
|
|
1898
3789
|
},
|
|
3790
|
+
/**
|
|
3791
|
+
* Updates a task by its ID using the v1 endpoint. Use `updateTask` instead.
|
|
3792
|
+
*
|
|
3793
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3794
|
+
*
|
|
3795
|
+
* Required API Key ACLs:
|
|
3796
|
+
* - addObject
|
|
3797
|
+
* - deleteIndex
|
|
3798
|
+
* - editSettings
|
|
3799
|
+
*
|
|
3800
|
+
* @deprecated
|
|
3801
|
+
* @param updateTaskV1 - The updateTaskV1 object.
|
|
3802
|
+
* @param updateTaskV1.taskID - Unique identifier of a task.
|
|
3803
|
+
* @param updateTaskV1.taskUpdate - The taskUpdate object.
|
|
3804
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3805
|
+
* @see updateTaskV1 for the plain version.
|
|
3806
|
+
*/
|
|
3807
|
+
updateTaskV1WithHTTPInfo({ taskID, taskUpdate }, requestOptions) {
|
|
3808
|
+
validateRequired("taskID", "updateTaskV1WithHTTPInfo", taskID);
|
|
3809
|
+
validateRequired("taskUpdate", "updateTaskV1WithHTTPInfo", taskUpdate);
|
|
3810
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
3811
|
+
const headers = {};
|
|
3812
|
+
const queryParameters = {};
|
|
3813
|
+
const request = {
|
|
3814
|
+
method: "PATCH",
|
|
3815
|
+
path: requestPath,
|
|
3816
|
+
queryParameters,
|
|
3817
|
+
headers,
|
|
3818
|
+
data: taskUpdate
|
|
3819
|
+
};
|
|
3820
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3821
|
+
},
|
|
1899
3822
|
/**
|
|
1900
3823
|
* Updates a transformation by its ID.
|
|
1901
3824
|
*
|
|
@@ -1927,6 +3850,40 @@ function createIngestionClient({
|
|
|
1927
3850
|
};
|
|
1928
3851
|
return transporter.request(request, requestOptions);
|
|
1929
3852
|
},
|
|
3853
|
+
/**
|
|
3854
|
+
* Updates a transformation by its ID.
|
|
3855
|
+
*
|
|
3856
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3857
|
+
*
|
|
3858
|
+
* Required API Key ACLs:
|
|
3859
|
+
* - addObject
|
|
3860
|
+
* - deleteIndex
|
|
3861
|
+
* - editSettings
|
|
3862
|
+
* @param updateTransformation - The updateTransformation object.
|
|
3863
|
+
* @param updateTransformation.transformationID - Unique identifier of a transformation.
|
|
3864
|
+
* @param updateTransformation.transformationCreate - The transformationCreate object.
|
|
3865
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3866
|
+
* @see updateTransformation for the plain version.
|
|
3867
|
+
*/
|
|
3868
|
+
updateTransformationWithHTTPInfo({ transformationID, transformationCreate }, requestOptions) {
|
|
3869
|
+
validateRequired("transformationID", "updateTransformationWithHTTPInfo", transformationID);
|
|
3870
|
+
validateRequired("transformationCreate", "updateTransformationWithHTTPInfo", transformationCreate);
|
|
3871
|
+
validateRequired("transformationCreate.name", "updateTransformationWithHTTPInfo", transformationCreate.name);
|
|
3872
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
3873
|
+
"{transformationID}",
|
|
3874
|
+
encodeURIComponent(transformationID)
|
|
3875
|
+
);
|
|
3876
|
+
const headers = {};
|
|
3877
|
+
const queryParameters = {};
|
|
3878
|
+
const request = {
|
|
3879
|
+
method: "PUT",
|
|
3880
|
+
path: requestPath,
|
|
3881
|
+
queryParameters,
|
|
3882
|
+
headers,
|
|
3883
|
+
data: transformationCreate
|
|
3884
|
+
};
|
|
3885
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3886
|
+
},
|
|
1930
3887
|
/**
|
|
1931
3888
|
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1932
3889
|
*
|
|
@@ -1949,6 +3906,7 @@ function createIngestionClient({
|
|
|
1949
3906
|
data: sourceCreate ? sourceCreate : {}
|
|
1950
3907
|
};
|
|
1951
3908
|
requestOptions = {
|
|
3909
|
+
...requestOptions,
|
|
1952
3910
|
timeouts: {
|
|
1953
3911
|
connect: 18e4,
|
|
1954
3912
|
read: 18e4,
|
|
@@ -1958,6 +3916,41 @@ function createIngestionClient({
|
|
|
1958
3916
|
};
|
|
1959
3917
|
return transporter.request(request, requestOptions);
|
|
1960
3918
|
},
|
|
3919
|
+
/**
|
|
3920
|
+
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
3921
|
+
*
|
|
3922
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3923
|
+
*
|
|
3924
|
+
* Required API Key ACLs:
|
|
3925
|
+
* - addObject
|
|
3926
|
+
* - deleteIndex
|
|
3927
|
+
* - editSettings
|
|
3928
|
+
* @param sourceCreate -
|
|
3929
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3930
|
+
* @see validateSource for the plain version.
|
|
3931
|
+
*/
|
|
3932
|
+
validateSourceWithHTTPInfo(sourceCreate, requestOptions = void 0) {
|
|
3933
|
+
const requestPath = "/1/sources/validate";
|
|
3934
|
+
const headers = {};
|
|
3935
|
+
const queryParameters = {};
|
|
3936
|
+
const request = {
|
|
3937
|
+
method: "POST",
|
|
3938
|
+
path: requestPath,
|
|
3939
|
+
queryParameters,
|
|
3940
|
+
headers,
|
|
3941
|
+
data: sourceCreate ? sourceCreate : {}
|
|
3942
|
+
};
|
|
3943
|
+
requestOptions = {
|
|
3944
|
+
...requestOptions,
|
|
3945
|
+
timeouts: {
|
|
3946
|
+
connect: 18e4,
|
|
3947
|
+
read: 18e4,
|
|
3948
|
+
write: 18e4,
|
|
3949
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
3950
|
+
}
|
|
3951
|
+
};
|
|
3952
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3953
|
+
},
|
|
1961
3954
|
/**
|
|
1962
3955
|
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1963
3956
|
*
|
|
@@ -1984,6 +3977,7 @@ function createIngestionClient({
|
|
|
1984
3977
|
data: sourceUpdate
|
|
1985
3978
|
};
|
|
1986
3979
|
requestOptions = {
|
|
3980
|
+
...requestOptions,
|
|
1987
3981
|
timeouts: {
|
|
1988
3982
|
connect: 18e4,
|
|
1989
3983
|
read: 18e4,
|
|
@@ -1992,6 +3986,45 @@ function createIngestionClient({
|
|
|
1992
3986
|
}
|
|
1993
3987
|
};
|
|
1994
3988
|
return transporter.request(request, requestOptions);
|
|
3989
|
+
},
|
|
3990
|
+
/**
|
|
3991
|
+
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
3992
|
+
*
|
|
3993
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3994
|
+
*
|
|
3995
|
+
* Required API Key ACLs:
|
|
3996
|
+
* - addObject
|
|
3997
|
+
* - deleteIndex
|
|
3998
|
+
* - editSettings
|
|
3999
|
+
* @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
|
|
4000
|
+
* @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
|
|
4001
|
+
* @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
|
|
4002
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
4003
|
+
* @see validateSourceBeforeUpdate for the plain version.
|
|
4004
|
+
*/
|
|
4005
|
+
validateSourceBeforeUpdateWithHTTPInfo({ sourceID, sourceUpdate }, requestOptions) {
|
|
4006
|
+
validateRequired("sourceID", "validateSourceBeforeUpdateWithHTTPInfo", sourceID);
|
|
4007
|
+
validateRequired("sourceUpdate", "validateSourceBeforeUpdateWithHTTPInfo", sourceUpdate);
|
|
4008
|
+
const requestPath = "/1/sources/{sourceID}/validate".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
4009
|
+
const headers = {};
|
|
4010
|
+
const queryParameters = {};
|
|
4011
|
+
const request = {
|
|
4012
|
+
method: "POST",
|
|
4013
|
+
path: requestPath,
|
|
4014
|
+
queryParameters,
|
|
4015
|
+
headers,
|
|
4016
|
+
data: sourceUpdate
|
|
4017
|
+
};
|
|
4018
|
+
requestOptions = {
|
|
4019
|
+
...requestOptions,
|
|
4020
|
+
timeouts: {
|
|
4021
|
+
connect: 18e4,
|
|
4022
|
+
read: 18e4,
|
|
4023
|
+
write: 18e4,
|
|
4024
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
4025
|
+
}
|
|
4026
|
+
};
|
|
4027
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1995
4028
|
}
|
|
1996
4029
|
};
|
|
1997
4030
|
}
|