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