@algolia/ingestion 1.2.4 → 5.2.4-beta.3

package/dist/src/ingestionClient.d.ts

@@ -1,854 +0,0 @@
-import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
-import type { Authentication } from '../model/authentication';
-import type { AuthenticationCreate } from '../model/authenticationCreate';
-import type { AuthenticationCreateResponse } from '../model/authenticationCreateResponse';
-import type { AuthenticationSearch } from '../model/authenticationSearch';
-import type { AuthenticationUpdateResponse } from '../model/authenticationUpdateResponse';
-import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteAuthenticationProps, DeleteDestinationProps, DeleteSourceProps, DeleteTaskProps, DeleteTaskV1Props, DeleteTransformationProps, DisableTaskProps, DisableTaskV1Props, EnableTaskProps, EnableTaskV1Props, GetAuthenticationProps, GetDestinationProps, GetEventProps, GetRunProps, GetSourceProps, GetTaskProps, GetTaskV1Props, GetTransformationProps, ListAuthenticationsProps, ListDestinationsProps, ListEventsProps, ListRunsProps, ListSourcesProps, ListTasksProps, ListTasksV1Props, ListTransformationsProps, PushTaskProps, RunSourceProps, RunTaskProps, RunTaskV1Props, TriggerDockerSourceDiscoverProps, TryTransformationBeforeUpdateProps, UpdateAuthenticationProps, UpdateDestinationProps, UpdateSourceProps, UpdateTaskProps, UpdateTaskV1Props, UpdateTransformationProps, ValidateSourceBeforeUpdateProps } from '../model/clientMethodProps';
-import type { DeleteResponse } from '../model/deleteResponse';
-import type { Destination } from '../model/destination';
-import type { DestinationCreate } from '../model/destinationCreate';
-import type { DestinationCreateResponse } from '../model/destinationCreateResponse';
-import type { DestinationSearch } from '../model/destinationSearch';
-import type { DestinationUpdateResponse } from '../model/destinationUpdateResponse';
-import type { Event } from '../model/event';
-import type { GenerateTransformationCodePayload } from '../model/generateTransformationCodePayload';
-import type { GenerateTransformationCodeResponse } from '../model/generateTransformationCodeResponse';
-import type { ListAuthenticationsResponse } from '../model/listAuthenticationsResponse';
-import type { ListDestinationsResponse } from '../model/listDestinationsResponse';
-import type { ListEventsResponse } from '../model/listEventsResponse';
-import type { ListSourcesResponse } from '../model/listSourcesResponse';
-import type { ListTasksResponse } from '../model/listTasksResponse';
-import type { ListTasksResponseV1 } from '../model/listTasksResponseV1';
-import type { ListTransformationsResponse } from '../model/listTransformationsResponse';
-import type { OnDemandTrigger } from '../model/onDemandTrigger';
-import type { Run } from '../model/run';
-import type { RunListResponse } from '../model/runListResponse';
-import type { RunResponse } from '../model/runResponse';
-import type { RunSourceResponse } from '../model/runSourceResponse';
-import type { ScheduleTrigger } from '../model/scheduleTrigger';
-import type { Source } from '../model/source';
-import type { SourceCreate } from '../model/sourceCreate';
-import type { SourceCreateResponse } from '../model/sourceCreateResponse';
-import type { SourceSearch } from '../model/sourceSearch';
-import type { SourceUpdateResponse } from '../model/sourceUpdateResponse';
-import type { SourceWatchResponse } from '../model/sourceWatchResponse';
-import type { SubscriptionTrigger } from '../model/subscriptionTrigger';
-import type { Task } from '../model/task';
-import type { TaskCreate } from '../model/taskCreate';
-import type { TaskCreateResponse } from '../model/taskCreateResponse';
-import type { TaskCreateTrigger } from '../model/taskCreateTrigger';
-import type { TaskCreateV1 } from '../model/taskCreateV1';
-import type { TaskSearch } from '../model/taskSearch';
-import type { TaskUpdateResponse } from '../model/taskUpdateResponse';
-import type { TaskV1 } from '../model/taskV1';
-import type { Transformation } from '../model/transformation';
-import type { TransformationCreate } from '../model/transformationCreate';
-import type { TransformationCreateResponse } from '../model/transformationCreateResponse';
-import type { TransformationModels } from '../model/transformationModels';
-import type { TransformationSearch } from '../model/transformationSearch';
-import type { TransformationTry } from '../model/transformationTry';
-import type { TransformationTryResponse } from '../model/transformationTryResponse';
-import type { TransformationUpdateResponse } from '../model/transformationUpdateResponse';
-import type { Trigger } from '../model/trigger';
-export declare const apiClientVersion = "1.2.4";
-export declare const REGIONS: readonly ["eu", "us"];
-export type Region = (typeof REGIONS)[number];
-/**
- * Guard: Return strongly typed specific OnDemandTrigger for a given Trigger.
- *
- * @summary Guard method that returns a strongly typed specific OnDemandTrigger for a given Trigger.
- * @param trigger - The given Task Trigger.
- */
-export declare function isOnDemandTrigger(trigger: TaskCreateTrigger | Trigger): trigger is OnDemandTrigger;
-/**
- * Guard: Return strongly typed specific ScheduleTrigger for a given Trigger.
- *
- * @summary Guard method that returns a strongly typed specific ScheduleTrigger for a given Trigger.
- * @param trigger - The given Task Trigger.
- */
-export declare function isScheduleTrigger(trigger: TaskCreateTrigger | Trigger): trigger is ScheduleTrigger;
-/**
- * Guard: Return strongly typed specific SubscriptionTrigger for a given Trigger.
- *
- * @summary Guard method that returns a strongly typed specific SubscriptionTrigger for a given Trigger.
- * @param trigger - The given Task Trigger.
- */
-export declare function isSubscriptionTrigger(trigger: TaskCreateTrigger | Trigger): trigger is SubscriptionTrigger;
-export declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
-    region: Region;
-}): {
-    transporter: import("@algolia/client-common").Transporter;
-    /**
-     * The `appId` currently in use.
-     */
-    appId: string;
-    /**
-     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
-     */
-    clearCache(): Promise<void>;
-    /**
-     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
-     */
-    readonly _ua: string;
-    /**
-     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
-     *
-     * @param segment - The algolia agent (user-agent) segment to add.
-     * @param version - The version of the agent.
-     */
-    addAlgoliaAgent(segment: string, version?: string): void;
-    /**
-     * Creates a new authentication resource.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param authenticationCreate -.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    createAuthentication(authenticationCreate: AuthenticationCreate, requestOptions?: RequestOptions): Promise<AuthenticationCreateResponse>;
-    /**
-     * Creates a new destination.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param destinationCreate -.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    createDestination(destinationCreate: DestinationCreate, requestOptions?: RequestOptions): Promise<DestinationCreateResponse>;
-    /**
-     * Creates a new source.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param sourceCreate -.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    createSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions): Promise<SourceCreateResponse>;
-    /**
-     * Creates a new task.
-     *
-     * @param taskCreate - Request body for creating a task.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    createTask(taskCreate: TaskCreate, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
-    /**
-     * Creates a new task using the v1 endpoint, please use `createTask` instead.
-     *
-     * @param taskCreate - Request body for creating a task.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    createTaskV1(taskCreate: TaskCreateV1, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
-    /**
-     * Creates a new transformation.
-     *
-     * @param transformationCreate - Request body for creating a transformation.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    createTransformation(transformationCreate: TransformationCreate, requestOptions?: RequestOptions): Promise<TransformationCreateResponse>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @param customDelete - The customDelete object.
-     * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
-     * @param customDelete.parameters - Query parameters to apply to the current query.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @param customGet - The customGet object.
-     * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
-     * @param customGet.parameters - Query parameters to apply to the current query.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @param customPost - The customPost object.
-     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
-     * @param customPost.parameters - Query parameters to apply to the current query.
-     * @param customPost.body - Parameters to send with the custom request.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @param customPut - The customPut object.
-     * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
-     * @param customPut.parameters - Query parameters to apply to the current query.
-     * @param customPut.body - Parameters to send with the custom request.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
-    /**
-     * Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param deleteAuthentication - The deleteAuthentication object.
-     * @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    deleteAuthentication({ authenticationID }: DeleteAuthenticationProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
-    /**
-     * Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param deleteDestination - The deleteDestination object.
-     * @param deleteDestination.destinationID - Unique identifier of a destination.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    deleteDestination({ destinationID }: DeleteDestinationProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
-    /**
-     * Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param deleteSource - The deleteSource object.
-     * @param deleteSource.sourceID - Unique identifier of a source.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    deleteSource({ sourceID }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
-    /**
-     * Deletes a task by its ID.
-     *
-     * @param deleteTask - The deleteTask object.
-     * @param deleteTask.taskID - Unique identifier of a task.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    deleteTask({ taskID }: DeleteTaskProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
-    /**
-     * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
-     *
-     * @param deleteTaskV1 - The deleteTaskV1 object.
-     * @param deleteTaskV1.taskID - Unique identifier of a task.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    deleteTaskV1({ taskID }: DeleteTaskV1Props, requestOptions?: RequestOptions): Promise<DeleteResponse>;
-    /**
-     * Deletes a transformation by its ID.
-     *
-     * @param deleteTransformation - The deleteTransformation object.
-     * @param deleteTransformation.transformationID - Unique identifier of a transformation.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    deleteTransformation({ transformationID }: DeleteTransformationProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
-    /**
-     * Disables a task.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param disableTask - The disableTask object.
-     * @param disableTask.taskID - Unique identifier of a task.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    disableTask({ taskID }: DisableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
-    /**
-     * Disables a task using the v1 endpoint, please use `disableTask` instead.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param disableTaskV1 - The disableTaskV1 object.
-     * @param disableTaskV1.taskID - Unique identifier of a task.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    disableTaskV1({ taskID }: DisableTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
-    /**
-     * Enables a task.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param enableTask - The enableTask object.
-     * @param enableTask.taskID - Unique identifier of a task.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    enableTask({ taskID }: EnableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
-    /**
-     * Enables a task using the v1 endpoint, please use `enableTask` instead.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param enableTaskV1 - The enableTaskV1 object.
-     * @param enableTaskV1.taskID - Unique identifier of a task.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    enableTaskV1({ taskID }: EnableTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
-    /**
-     * Generates code for the selected model based on the given prompt.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param generateTransformationCodePayload - The generateTransformationCodePayload object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    generateTransformationCode(generateTransformationCodePayload: GenerateTransformationCodePayload, requestOptions?: RequestOptions): Promise<GenerateTransformationCodeResponse>;
-    /**
-     * Retrieves an authentication resource by its ID.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param getAuthentication - The getAuthentication object.
-     * @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getAuthentication({ authenticationID }: GetAuthenticationProps, requestOptions?: RequestOptions): Promise<Authentication>;
-    /**
-     * Retrieves a destination by its ID.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param getDestination - The getDestination object.
-     * @param getDestination.destinationID - Unique identifier of a destination.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getDestination({ destinationID }: GetDestinationProps, requestOptions?: RequestOptions): Promise<Destination>;
-    /**
-     * Retrieves a single task run event by its ID.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param getEvent - The getEvent object.
-     * @param getEvent.runID - Unique identifier of a task run.
-     * @param getEvent.eventID - Unique identifier of an event.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getEvent({ runID, eventID }: GetEventProps, requestOptions?: RequestOptions): Promise<Event>;
-    /**
-     * Retrieve a single task run by its ID.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param getRun - The getRun object.
-     * @param getRun.runID - Unique identifier of a task run.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getRun({ runID }: GetRunProps, requestOptions?: RequestOptions): Promise<Run>;
-    /**
-     * Retrieve a source by its ID.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param getSource - The getSource object.
-     * @param getSource.sourceID - Unique identifier of a source.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getSource({ sourceID }: GetSourceProps, requestOptions?: RequestOptions): Promise<Source>;
-    /**
-     * Retrieves a task by its ID.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param getTask - The getTask object.
-     * @param getTask.taskID - Unique identifier of a task.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getTask({ taskID }: GetTaskProps, requestOptions?: RequestOptions): Promise<Task>;
-    /**
-     * Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param getTaskV1 - The getTaskV1 object.
-     * @param getTaskV1.taskID - Unique identifier of a task.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getTaskV1({ taskID }: GetTaskV1Props, requestOptions?: RequestOptions): Promise<TaskV1>;
-    /**
-     * Retrieves a transformation by its ID.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param getTransformation - The getTransformation object.
-     * @param getTransformation.transformationID - Unique identifier of a transformation.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getTransformation({ transformationID }: GetTransformationProps, requestOptions?: RequestOptions): Promise<Transformation>;
-    /**
-     * Retrieves a list of all authentication resources.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param listAuthentications - The listAuthentications object.
-     * @param listAuthentications.itemsPerPage - Number of items per page.
-     * @param listAuthentications.page - Page number of the paginated API response.
-     * @param listAuthentications.type - Type of authentication resource to retrieve.
-     * @param listAuthentications.platform - Ecommerce platform for which to retrieve authentication resources.
-     * @param listAuthentications.sort - Property by which to sort the list of authentication resources.
-     * @param listAuthentications.order - Sort order of the response, ascending or descending.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    listAuthentications({ itemsPerPage, page, type, platform, sort, order }?: ListAuthenticationsProps, requestOptions?: RequestOptions | undefined): Promise<ListAuthenticationsResponse>;
-    /**
-     * Retrieves a list of destinations.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param listDestinations - The listDestinations object.
-     * @param listDestinations.itemsPerPage - Number of items per page.
-     * @param listDestinations.page - Page number of the paginated API response.
-     * @param listDestinations.type - Destination type.
-     * @param listDestinations.authenticationID - Authentication ID used by destinations.
-     * @param listDestinations.sort - Property by which to sort the destinations.
-     * @param listDestinations.order - Sort order of the response, ascending or descending.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    listDestinations({ itemsPerPage, page, type, authenticationID, sort, order }?: ListDestinationsProps, requestOptions?: RequestOptions | undefined): Promise<ListDestinationsResponse>;
-    /**
-     * Retrieves a list of events for a task run, identified by it\'s ID.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param listEvents - The listEvents object.
-     * @param listEvents.runID - Unique identifier of a task run.
-     * @param listEvents.itemsPerPage - Number of items per page.
-     * @param listEvents.page - Page number of the paginated API response.
-     * @param listEvents.status - Event status for filtering the list of task runs.
-     * @param listEvents.type - Event type for filtering the list of task runs.
-     * @param listEvents.sort - Property by which to sort the list of task run events.
-     * @param listEvents.order - Sort order of the response, ascending or descending.
-     * @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.
-     * @param listEvents.endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    listEvents({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate }: ListEventsProps, requestOptions?: RequestOptions): Promise<ListEventsResponse>;
-    /**
-     * Retrieve a list of task runs.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param listRuns - The listRuns object.
-     * @param listRuns.itemsPerPage - Number of items per page.
-     * @param listRuns.page - Page number of the paginated API response.
-     * @param listRuns.status - Run status for filtering the list of task runs.
-     * @param listRuns.type - Run type for filtering the list of task runs.
-     * @param listRuns.taskID - Task ID for filtering the list of task runs.
-     * @param listRuns.sort - Property by which to sort the list of task runs.
-     * @param listRuns.order - Sort order of the response, ascending or descending.
-     * @param listRuns.startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
-     * @param listRuns.endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    listRuns({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate }?: ListRunsProps, requestOptions?: RequestOptions | undefined): Promise<RunListResponse>;
-    /**
-     * Retrieves a list of sources.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param listSources - The listSources object.
-     * @param listSources.itemsPerPage - Number of items per page.
-     * @param listSources.page - Page number of the paginated API response.
-     * @param listSources.type - Source type. Some sources require authentication.
-     * @param listSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication resource.
-     * @param listSources.sort - Property by which to sort the list of sources.
-     * @param listSources.order - Sort order of the response, ascending or descending.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    listSources({ itemsPerPage, page, type, authenticationID, sort, order }?: ListSourcesProps, requestOptions?: RequestOptions | undefined): Promise<ListSourcesResponse>;
-    /**
-     * Retrieves a list of tasks.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param listTasks - The listTasks object.
-     * @param listTasks.itemsPerPage - Number of items per page.
-     * @param listTasks.page - Page number of the paginated API response.
-     * @param listTasks.action - Actions for filtering the list of tasks.
-     * @param listTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
-     * @param listTasks.sourceID - Source IDs for filtering the list of tasks.
-     * @param listTasks.destinationID - Destination IDs for filtering the list of tasks.
-     * @param listTasks.triggerType - Type of task trigger for filtering the list of tasks.
-     * @param listTasks.sort - Property by which to sort the list of tasks.
-     * @param listTasks.order - Sort order of the response, ascending or descending.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    listTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
-    /**
-     * Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param listTasksV1 - The listTasksV1 object.
-     * @param listTasksV1.itemsPerPage - Number of items per page.
-     * @param listTasksV1.page - Page number of the paginated API response.
-     * @param listTasksV1.action - Actions for filtering the list of tasks.
-     * @param listTasksV1.enabled - Whether to filter the list of tasks by the `enabled` status.
-     * @param listTasksV1.sourceID - Source IDs for filtering the list of tasks.
-     * @param listTasksV1.destinationID - Destination IDs for filtering the list of tasks.
-     * @param listTasksV1.triggerType - Type of task trigger for filtering the list of tasks.
-     * @param listTasksV1.sort - Property by which to sort the list of tasks.
-     * @param listTasksV1.order - Sort order of the response, ascending or descending.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    listTasksV1({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order }?: ListTasksV1Props, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponseV1>;
-    /**
-     * Retrieves a list of existing LLM transformation helpers.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    listTransformationModels(requestOptions?: RequestOptions): Promise<TransformationModels>;
-    /**
-     * Retrieves a list of transformations.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param listTransformations - The listTransformations object.
-     * @param listTransformations.itemsPerPage - Number of items per page.
-     * @param listTransformations.page - Page number of the paginated API response.
-     * @param listTransformations.sort - Property by which to sort the list.
-     * @param listTransformations.order - Sort order of the response, ascending or descending.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    listTransformations({ itemsPerPage, page, sort, order }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<ListTransformationsResponse>;
-    /**
-     * Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param pushTask - The pushTask object.
-     * @param pushTask.taskID - Unique identifier of a task.
-     * @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    pushTask({ taskID, pushTaskPayload }: PushTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
-    /**
-     * Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param runSource - The runSource object.
-     * @param runSource.sourceID - Unique identifier of a source.
-     * @param runSource.runSourcePayload -.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    runSource({ sourceID, runSourcePayload }: RunSourceProps, requestOptions?: RequestOptions): Promise<RunSourceResponse>;
-    /**
-     * Runs a task. You can check the status of task runs with the observability endpoints.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param runTask - The runTask object.
-     * @param runTask.taskID - Unique identifier of a task.
-     * @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>;
-    /**
-     * Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param runTaskV1 - The runTaskV1 object.
-     * @param runTaskV1.taskID - Unique identifier of a task.
-     * @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>;
-    /**
-     * Searches for authentication resources.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param authenticationSearch - The authenticationSearch object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    searchAuthentications(authenticationSearch: AuthenticationSearch, requestOptions?: RequestOptions): Promise<Authentication[]>;
-    /**
-     * Searches for destinations.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param destinationSearch - The destinationSearch object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    searchDestinations(destinationSearch: DestinationSearch, requestOptions?: RequestOptions): Promise<Destination[]>;
-    /**
-     * Searches for sources.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param sourceSearch - The sourceSearch object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    searchSources(sourceSearch: SourceSearch, requestOptions?: RequestOptions): Promise<Source[]>;
-    /**
-     * Searches for tasks.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param taskSearch - The taskSearch object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    searchTasks(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<Task[]>;
-    /**
-     * Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param taskSearch - The taskSearch object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    searchTasksV1(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<TaskV1[]>;
-    /**
-     * Searches for transformations.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param transformationSearch - The transformationSearch object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    searchTransformations(transformationSearch: TransformationSearch, requestOptions?: RequestOptions): Promise<Transformation[]>;
-    /**
-     * Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
-     * @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    triggerDockerSourceDiscover({ sourceID }: TriggerDockerSourceDiscoverProps, requestOptions?: RequestOptions): Promise<SourceWatchResponse>;
-    /**
-     * Try a transformation before creating it.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param transformationTry - The transformationTry object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    tryTransformation(transformationTry: TransformationTry, requestOptions?: RequestOptions): Promise<TransformationTryResponse>;
-    /**
-     * Try a transformation before updating it.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
-     * @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
-     * @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    tryTransformationBeforeUpdate({ transformationID, transformationTry }: TryTransformationBeforeUpdateProps, requestOptions?: RequestOptions): Promise<TransformationTryResponse>;
-    /**
-     * Updates an authentication resource.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param updateAuthentication - The updateAuthentication object.
-     * @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
-     * @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    updateAuthentication({ authenticationID, authenticationUpdate }: UpdateAuthenticationProps, requestOptions?: RequestOptions): Promise<AuthenticationUpdateResponse>;
-    /**
-     * Updates the destination by its ID.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param updateDestination - The updateDestination object.
-     * @param updateDestination.destinationID - Unique identifier of a destination.
-     * @param updateDestination.destinationUpdate - The destinationUpdate object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    updateDestination({ destinationID, destinationUpdate }: UpdateDestinationProps, requestOptions?: RequestOptions): Promise<DestinationUpdateResponse>;
-    /**
-     * Updates a source by its ID.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param updateSource - The updateSource object.
-     * @param updateSource.sourceID - Unique identifier of a source.
-     * @param updateSource.sourceUpdate - The sourceUpdate object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    updateSource({ sourceID, sourceUpdate }: UpdateSourceProps, requestOptions?: RequestOptions): Promise<SourceUpdateResponse>;
-    /**
-     * Updates a task by its ID.
-     *
-     * @param updateTask - The updateTask object.
-     * @param updateTask.taskID - Unique identifier of a task.
-     * @param updateTask.taskUpdate - The taskUpdate object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    updateTask({ taskID, taskUpdate }: UpdateTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
-    /**
-     * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
-     *
-     * @param updateTaskV1 - The updateTaskV1 object.
-     * @param updateTaskV1.taskID - Unique identifier of a task.
-     * @param updateTaskV1.taskUpdate - The taskUpdate object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    updateTaskV1({ taskID, taskUpdate }: UpdateTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
-    /**
-     * Updates a transformation by its ID.
-     *
-     * @param updateTransformation - The updateTransformation object.
-     * @param updateTransformation.transformationID - Unique identifier of a transformation.
-     * @param updateTransformation.transformationCreate - The transformationCreate object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    updateTransformation({ transformationID, transformationCreate }: UpdateTransformationProps, requestOptions?: RequestOptions): Promise<TransformationUpdateResponse>;
-    /**
-     * Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param sourceCreate -.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    validateSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions | undefined): Promise<SourceWatchResponse>;
-    /**
-     * Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
-     *
-     * Required API Key ACLs:
-     * - addObject
-     * - deleteIndex
-     * - editSettings.
-     *
-     * @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
-     * @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
-     * @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    validateSourceBeforeUpdate({ sourceID, sourceUpdate }: ValidateSourceBeforeUpdateProps, requestOptions?: RequestOptions): Promise<SourceWatchResponse>;
-};
-//# sourceMappingURL=ingestionClient.d.ts.map