Skip to content

Commit 892594b

Browse files
algolia-botmillotp
andcommitted
fix(specs): filter run list by type (generated)
algolia/api-clients-automation#3577 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
1 parent 643ae08 commit 892594b

File tree

3 files changed

+19
-11
lines changed

3 files changed

+19
-11
lines changed

packages/ingestion/model/clientMethodProps.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import type { PlatformWithNone } from './platformWithNone';
1616
import type { RunSortKeys } from './runSortKeys';
1717
import type { RunSourcePayload } from './runSourcePayload';
1818
import type { RunStatus } from './runStatus';
19+
import type { RunType } from './runType';
1920
import type { SortKeys } from './sortKeys';
2021
import type { SourceSortKeys } from './sourceSortKeys';
2122
import type { SourceType } from './sourceType';
@@ -393,6 +394,10 @@ export type ListRunsProps = {
393394
* Run status for filtering the list of task runs.
394395
*/
395396
status?: RunStatus[];
397+
/**
398+
* Run type for filtering the list of task runs.
399+
*/
400+
type?: RunType[];
396401
/**
397402
* Task ID for filtering the list of task runs.
398403
*/

packages/ingestion/model/runType.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
/**
44
* Task run type.
55
*/
6-
export type RunType = 'discover' | 'reindex' | 'update';
6+
export type RunType = 'discover' | 'push' | 'reindex' | 'update' | 'validate';

packages/ingestion/src/ingestionClient.ts

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1227,7 +1227,6 @@ export function createIngestionClient({
12271227
if (itemsPerPage !== undefined) {
12281228
queryParameters.itemsPerPage = itemsPerPage.toString();
12291229
}
1230-
12311230
if (page !== undefined) {
12321231
queryParameters.page = page.toString();
12331232
}
@@ -1237,6 +1236,7 @@ export function createIngestionClient({
12371236
if (platform !== undefined) {
12381237
queryParameters.platform = platform.toString();
12391238
}
1239+
12401240
if (sort !== undefined) {
12411241
queryParameters.sort = sort.toString();
12421242
}
@@ -1278,6 +1278,7 @@ export function createIngestionClient({
12781278
const requestPath = '/1/destinations';
12791279
const headers: Headers = {};
12801280
const queryParameters: QueryParameters = {};
1281+
12811282
if (itemsPerPage !== undefined) {
12821283
queryParameters.itemsPerPage = itemsPerPage.toString();
12831284
}
@@ -1287,7 +1288,6 @@ export function createIngestionClient({
12871288
if (type !== undefined) {
12881289
queryParameters.type = type.toString();
12891290
}
1290-
12911291
if (authenticationID !== undefined) {
12921292
queryParameters.authenticationID = authenticationID.toString();
12931293
}
@@ -1339,14 +1339,12 @@ export function createIngestionClient({
13391339
const requestPath = '/1/runs/{runID}/events'.replace('{runID}', encodeURIComponent(runID));
13401340
const headers: Headers = {};
13411341
const queryParameters: QueryParameters = {};
1342-
13431342
if (itemsPerPage !== undefined) {
13441343
queryParameters.itemsPerPage = itemsPerPage.toString();
13451344
}
13461345
if (page !== undefined) {
13471346
queryParameters.page = page.toString();
13481347
}
1349-
13501348
if (status !== undefined) {
13511349
queryParameters.status = status.toString();
13521350
}
@@ -1356,6 +1354,7 @@ export function createIngestionClient({
13561354
if (sort !== undefined) {
13571355
queryParameters.sort = sort.toString();
13581356
}
1357+
13591358
if (order !== undefined) {
13601359
queryParameters.order = order.toString();
13611360
}
@@ -1388,6 +1387,7 @@ export function createIngestionClient({
13881387
* @param listRuns.itemsPerPage - Number of items per page.
13891388
* @param listRuns.page - Page number of the paginated API response.
13901389
* @param listRuns.status - Run status for filtering the list of task runs.
1390+
* @param listRuns.type - Run type for filtering the list of task runs.
13911391
* @param listRuns.taskID - Task ID for filtering the list of task runs.
13921392
* @param listRuns.sort - Property by which to sort the list of task runs.
13931393
* @param listRuns.order - Sort order of the response, ascending or descending.
@@ -1396,12 +1396,13 @@ export function createIngestionClient({
13961396
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
13971397
*/
13981398
listRuns(
1399-
{ itemsPerPage, page, status, taskID, sort, order, startDate, endDate }: ListRunsProps = {},
1399+
{ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate }: ListRunsProps = {},
14001400
requestOptions: RequestOptions | undefined = undefined,
14011401
): Promise<RunListResponse> {
14021402
const requestPath = '/1/runs';
14031403
const headers: Headers = {};
14041404
const queryParameters: QueryParameters = {};
1405+
14051406
if (itemsPerPage !== undefined) {
14061407
queryParameters.itemsPerPage = itemsPerPage.toString();
14071408
}
@@ -1411,13 +1412,16 @@ export function createIngestionClient({
14111412
if (status !== undefined) {
14121413
queryParameters.status = status.toString();
14131414
}
1414-
1415+
if (type !== undefined) {
1416+
queryParameters.type = type.toString();
1417+
}
14151418
if (taskID !== undefined) {
14161419
queryParameters.taskID = taskID.toString();
14171420
}
14181421
if (sort !== undefined) {
14191422
queryParameters.sort = sort.toString();
14201423
}
1424+
14211425
if (order !== undefined) {
14221426
queryParameters.order = order.toString();
14231427
}
@@ -1471,7 +1475,6 @@ export function createIngestionClient({
14711475
if (type !== undefined) {
14721476
queryParameters.type = type.toString();
14731477
}
1474-
14751478
if (authenticationID !== undefined) {
14761479
queryParameters.authenticationID = authenticationID.toString();
14771480
}
@@ -1529,6 +1532,7 @@ export function createIngestionClient({
15291532
if (action !== undefined) {
15301533
queryParameters.action = action.toString();
15311534
}
1535+
15321536
if (enabled !== undefined) {
15331537
queryParameters.enabled = enabled.toString();
15341538
}
@@ -1541,7 +1545,6 @@ export function createIngestionClient({
15411545
if (triggerType !== undefined) {
15421546
queryParameters.triggerType = triggerType.toString();
15431547
}
1544-
15451548
if (sort !== undefined) {
15461549
queryParameters.sort = sort.toString();
15471550
}
@@ -1589,13 +1592,13 @@ export function createIngestionClient({
15891592
if (itemsPerPage !== undefined) {
15901593
queryParameters.itemsPerPage = itemsPerPage.toString();
15911594
}
1592-
15931595
if (page !== undefined) {
15941596
queryParameters.page = page.toString();
15951597
}
15961598
if (action !== undefined) {
15971599
queryParameters.action = action.toString();
15981600
}
1601+
15991602
if (enabled !== undefined) {
16001603
queryParameters.enabled = enabled.toString();
16011604
}
@@ -1609,7 +1612,6 @@ export function createIngestionClient({
16091612
if (triggerType !== undefined) {
16101613
queryParameters.triggerType = triggerType.toString();
16111614
}
1612-
16131615
if (sort !== undefined) {
16141616
queryParameters.sort = sort.toString();
16151617
}
@@ -1680,6 +1682,7 @@ export function createIngestionClient({
16801682
if (page !== undefined) {
16811683
queryParameters.page = page.toString();
16821684
}
1685+
16831686
if (sort !== undefined) {
16841687
queryParameters.sort = sort.toString();
16851688
}

0 commit comments

Comments
 (0)