feat(specs): document runMetadata parameter (generated)

algolia/api-clients-automation#5087

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Devin Beeuwkes <[email protected]>

Author: algolia-bot

packages/ingestion/model/clientMethodProps.ts

@@ -23,6 +23,7 @@ import type { RunSortKeys } from '../model/runSortKeys';
 import type { RunSourcePayload } from '../model/runSourcePayload';
 
 import type { RunStatus } from '../model/runStatus';
+import type { RunTaskPayload } from '../model/runTaskPayload';
 import type { RunType } from '../model/runType';
 
 import type { SourceSortKeys } from '../model/sourceSortKeys';
@@ -637,6 +638,10 @@ export type RunTaskProps = {
    * Unique identifier of a task.
    */
   taskID: string;
+  /**
+   *
+   */
+  runTaskPayload?: RunTaskPayload | undefined;
 };
 
 /**
@@ -647,6 +652,10 @@ export type RunTaskV1Props = {
    * Unique identifier of a task.
    */
   taskID: string;
+  /**
+   *
+   */
+  runTaskPayload?: RunTaskPayload | undefined;
 };
 
 /**

packages/ingestion/model/index.ts

@@ -85,6 +85,7 @@ export * from './runSortKeys';
 export * from './runSourcePayload';
 export * from './runSourceResponse';
 export * from './runStatus';
+export * from './runTaskPayload';
 export * from './runType';
 export * from './scheduleTrigger';
 export * from './scheduleTriggerInput';

packages/ingestion/model/runSourcePayload.ts

@@ -19,4 +19,9 @@ export type RunSourcePayload = {
   entityIDs?: Array<string> | undefined;
 
   entityType?: EntityType | undefined;
+
+  /**
+   * Additional information that will be passed to the created runs.
+   */
+  runMetadata?: { [key: string]: any } | undefined;
 };

packages/ingestion/model/runTaskPayload.ts

@@ -0,0 +1,8 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type RunTaskPayload = {
+  /**
+   * Additional information that will be passed to the created run.
+   */
+  runMetadata?: { [key: string]: any } | undefined;
+};

packages/ingestion/src/ingestionClient.ts

@@ -1949,9 +1949,10 @@ export function createIngestionClient({
      *  - editSettings
      * @param runTask - The runTask object.
      * @param runTask.taskID - Unique identifier of a task.
+     * @param runTask.runTaskPayload -
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    runTask({ taskID }: RunTaskProps, requestOptions?: RequestOptions): Promise<RunResponse> {
+    runTask({ taskID, runTaskPayload }: RunTaskProps, requestOptions?: RequestOptions): Promise<RunResponse> {
       if (!taskID) {
         throw new Error('Parameter `taskID` is required when calling `runTask`.');
       }
@@ -1965,6 +1966,7 @@ export function createIngestionClient({
         path: requestPath,
         queryParameters,
         headers,
+        data: runTaskPayload ? runTaskPayload : {},
       };
 
       return transporter.request(request, requestOptions);
@@ -1981,9 +1983,10 @@ export function createIngestionClient({
      * @deprecated
      * @param runTaskV1 - The runTaskV1 object.
      * @param runTaskV1.taskID - Unique identifier of a task.
+     * @param runTaskV1.runTaskPayload -
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    runTaskV1({ taskID }: RunTaskV1Props, requestOptions?: RequestOptions): Promise<RunResponse> {
+    runTaskV1({ taskID, runTaskPayload }: RunTaskV1Props, requestOptions?: RequestOptions): Promise<RunResponse> {
       if (!taskID) {
         throw new Error('Parameter `taskID` is required when calling `runTaskV1`.');
       }
@@ -1997,6 +2000,7 @@ export function createIngestionClient({
         path: requestPath,
         queryParameters,
         headers,
+        data: runTaskPayload ? runTaskPayload : {},
       };
 
       return transporter.request(request, requestOptions);