@algolia/ingestion 1.0.0-alpha.9 → 1.0.0-beta.2

package/dist/src/ingestionClient.d.ts

@@ -1,326 +1,575 @@
-import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
-import type { AuthenticationCreate } from '../model/authenticationCreate';
-import type { AuthenticationCreateResponse } from '../model/authenticationCreateResponse';
-import type { AuthenticationUpdateResponse } from '../model/authenticationUpdateResponse';
-import type { AuthenticationWithInput } from '../model/authenticationWithInput';
-import type { DeleteAuthenticationProps, DeleteDestinationProps, DeleteSourceProps, DeleteTaskProps, DisableTaskProps, EnableTaskProps, GetAuthenticationProps, GetAuthenticationsProps, GetDestinationProps, GetDestinationsProps, GetEventProps, GetEventsProps, GetRunProps, GetRunsProps, GetRunsByTaskIDProps, GetSourceProps, GetSourcesProps, GetTaskProps, GetTasksProps, RunTaskProps, UpdateAuthenticationProps, UpdateDestinationProps, UpdateSourceProps, UpdateTaskProps } 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 { DestinationUpdateResponse } from '../model/destinationUpdateResponse';
-import type { Event } from '../model/event';
-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 { Run } from '../model/run';
-import type { RunListResponse } from '../model/runListResponse';
-import type { RunResponse } from '../model/runResponse';
-import type { Source } from '../model/source';
-import type { SourceCreate } from '../model/sourceCreate';
-import type { SourceCreateResponse } from '../model/sourceCreateResponse';
-import type { SourceUpdateResponse } from '../model/sourceUpdateResponse';
-import type { Task } from '../model/task';
-import type { TaskCreate } from '../model/taskCreate';
-import type { TaskCreateResponse } from '../model/taskCreateResponse';
-import type { TaskUpdateResponse } from '../model/taskUpdateResponse';
-export declare const apiClientVersion = "1.0.0-alpha.9";
-export declare const REGIONS: readonly ["us"];
-export declare type Region = typeof REGIONS[number];
-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;
-    /**
-     * Create a authentication.
-     *
-     * @summary Create a authentication.
-     * @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>;
-    /**
-     * Create a destination.
-     *
-     * @summary Create a destination.
-     * @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>;
-    /**
-     * Create a source.
-     *
-     * @summary Create a source.
-     * @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>;
-    /**
-     * Create a task.
-     *
-     * @summary Create a task.
-     * @param taskCreate -.
-     * @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>;
-    /**
-     * Soft delete a authentication.
-     *
-     * @summary Delete a authentication.
-     * @param deleteAuthentication - The deleteAuthentication object.
-     * @param deleteAuthentication.authenticationID - The authentication uuid.
-     * @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>;
-    /**
-     * Soft delete a destination.
-     *
-     * @summary Delete a destination.
-     * @param deleteDestination - The deleteDestination object.
-     * @param deleteDestination.destinationID - The destination uuid.
-     * @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>;
-    /**
-     * Soft delete a source.
-     *
-     * @summary Delete a source.
-     * @param deleteSource - The deleteSource object.
-     * @param deleteSource.sourceID - The source uuid.
-     * @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>;
-    /**
-     * Soft delete a task.
-     *
-     * @summary Delete a task.
-     * @param deleteTask - The deleteTask object.
-     * @param deleteTask.taskID - The task uuid.
-     * @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>;
-    /**
-     * Disable a task.
-     *
-     * @summary Disable a task.
-     * @param disableTask - The disableTask object.
-     * @param disableTask.taskID - The task uuid.
-     * @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>;
-    /**
-     * Enable a task.
-     *
-     * @summary Enable a task.
-     * @param enableTask - The enableTask object.
-     * @param enableTask.taskID - The task uuid.
-     * @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>;
-    /**
-     * Get a authentication.
-     *
-     * @summary Get a authentication.
-     * @param getAuthentication - The getAuthentication object.
-     * @param getAuthentication.authenticationID - The authentication uuid.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getAuthentication({ authenticationID }: GetAuthenticationProps, requestOptions?: RequestOptions): Promise<AuthenticationWithInput>;
-    /**
-     * Get a list of authentications.
-     *
-     * @summary Get a list of authentications.
-     * @param getAuthentications - The getAuthentications object.
-     * @param getAuthentications.itemsPerPage - The number of items per page to return.
-     * @param getAuthentications.page - The page number to fetch, starting at 1.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getAuthentications({ itemsPerPage, page }?: GetAuthenticationsProps, requestOptions?: RequestOptions | undefined): Promise<ListAuthenticationsResponse>;
-    /**
-     * Get a destination.
-     *
-     * @summary Get a destination.
-     * @param getDestination - The getDestination object.
-     * @param getDestination.destinationID - The destination uuid.
-     * @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>;
-    /**
-     * Get a list of destinations.
-     *
-     * @summary Get a list of destinations.
-     * @param getDestinations - The getDestinations object.
-     * @param getDestinations.itemsPerPage - The number of items per page to return.
-     * @param getDestinations.page - The page number to fetch, starting at 1.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getDestinations({ itemsPerPage, page }?: GetDestinationsProps, requestOptions?: RequestOptions | undefined): Promise<ListDestinationsResponse>;
-    /**
-     * Get an event in a specific run.
-     *
-     * @summary Get an event in a specific run.
-     * @param getEvent - The getEvent object.
-     * @param getEvent.runID - The run uuid.
-     * @param getEvent.eventID - The event uuid.
-     * @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>;
-    /**
-     * Get a list of events for a specific run.
-     *
-     * @summary Get a list of events for a specific run.
-     * @param getEvents - The getEvents object.
-     * @param getEvents.runID - The run uuid.
-     * @param getEvents.itemsPerPage - The number of items per page to return.
-     * @param getEvents.page - The page number to fetch, starting at 1.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getEvents({ runID, itemsPerPage, page }: GetEventsProps, requestOptions?: RequestOptions): Promise<ListEventsResponse>;
-    /**
-     * Get a run.
-     *
-     * @summary Get a run.
-     * @param getRun - The getRun object.
-     * @param getRun.runID - The run uuid.
-     * @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>;
-    /**
-     * Get a list of runs.
-     *
-     * @summary Get a list of runs.
-     * @param getRuns - The getRuns object.
-     * @param getRuns.itemsPerPage - The number of items per page to return.
-     * @param getRuns.page - The page number to fetch, starting at 1.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getRuns({ itemsPerPage, page }?: GetRunsProps, requestOptions?: RequestOptions | undefined): Promise<RunListResponse>;
-    /**
-     * Get a list of runs associated with a taskID.
-     *
-     * @summary Get a list of runs associated with a taskID.
-     * @param getRunsByTaskID - The getRunsByTaskID object.
-     * @param getRunsByTaskID.taskID - The task uuid.
-     * @param getRunsByTaskID.itemsPerPage - The number of items per page to return.
-     * @param getRunsByTaskID.page - The page number to fetch, starting at 1.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getRunsByTaskID({ taskID, itemsPerPage, page }: GetRunsByTaskIDProps, requestOptions?: RequestOptions): Promise<RunListResponse>;
-    /**
-     * Get a source.
-     *
-     * @summary Get a source.
-     * @param getSource - The getSource object.
-     * @param getSource.sourceID - The source uuid.
-     * @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>;
-    /**
-     * Get a list of sources.
-     *
-     * @summary Get a list of sources.
-     * @param getSources - The getSources object.
-     * @param getSources.itemsPerPage - The number of items per page to return.
-     * @param getSources.page - The page number to fetch, starting at 1.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getSources({ itemsPerPage, page }?: GetSourcesProps, requestOptions?: RequestOptions | undefined): Promise<ListSourcesResponse>;
-    /**
-     * Get a task.
-     *
-     * @summary Get a task.
-     * @param getTask - The getTask object.
-     * @param getTask.taskID - The task uuid.
-     * @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>;
-    /**
-     * Get a list of tasks.
-     *
-     * @summary Get a list of tasks.
-     * @param getTasks - The getTasks object.
-     * @param getTasks.itemsPerPage - The number of items per page to return.
-     * @param getTasks.page - The page number to fetch, starting at 1.
-     * @param getTasks.action - Which action the returned task should have. Can be a list of string separated with commas.
-     * @param getTasks.enabled - If the returned task should have its \'enabled\' property set to true.
-     * @param getTasks.destinationID - Which destinationID the returned task should have. Can be a list of string separated with commas.
-     * @param getTasks.triggerType - Which trigger type the returned task should have. Can be a list of string separated with commas.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getTasks({ itemsPerPage, page, action, enabled, destinationID, triggerType, }?: GetTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
-    /**
-     * Run a task.
-     *
-     * @summary Run a task.
-     * @param runTask - The runTask object.
-     * @param runTask.taskID - The task uuid.
-     * @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>;
-    /**
-     * Update a authentication.
-     *
-     * @summary Update a authentication.
-     * @param updateAuthentication - The updateAuthentication object.
-     * @param updateAuthentication.authenticationID - The authentication uuid.
-     * @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>;
-    /**
-     * Update a destination.
-     *
-     * @summary Update a destination.
-     * @param updateDestination - The updateDestination object.
-     * @param updateDestination.destinationID - The destination uuid.
-     * @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>;
-    /**
-     * Update a source.
-     *
-     * @summary Update a source.
-     * @param updateSource - The updateSource object.
-     * @param updateSource.sourceID - The source uuid.
-     * @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>;
-    /**
-     * Update a task.
-     *
-     * @summary Update a task.
-     * @param updateTask - The updateTask object.
-     * @param updateTask.taskID - The task uuid.
-     * @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>;
-};
-/**
- * The client type.
- */
-export declare type IngestionClient = ReturnType<typeof createIngestionClient>;
+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, DisableTaskProps, EnableTaskProps, GetAuthenticationProps, GetAuthenticationsProps, GetDestinationProps, GetDestinationsProps, GetDockerSourceStreamsProps, GetEventProps, GetEventsProps, GetRunProps, GetRunsProps, GetSourceProps, GetSourcesProps, GetTaskProps, GetTasksProps, RunTaskProps, TriggerDockerSourceDiscoverProps, UpdateAuthenticationProps, UpdateDestinationProps, UpdateSourceProps, UpdateTaskProps } 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 { DockerSourceDiscover } from '../model/dockerSourceDiscover';
+import type { DockerSourceStreams } from '../model/dockerSourceStreams';
+import type { Event } from '../model/event';
+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 { OnDemandTrigger } from '../model/onDemandTrigger';
+import type { Run } from '../model/run';
+import type { RunListResponse } from '../model/runListResponse';
+import type { RunResponse } from '../model/runResponse';
+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 { 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 { TaskSearch } from '../model/taskSearch';
+import type { TaskUpdateResponse } from '../model/taskUpdateResponse';
+import type { Trigger } from '../model/trigger';
+export declare const apiClientVersion = "1.0.0-beta.2";
+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>;
+    /**
+     * 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, any>>;
+    /**
+     * 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, any>>;
+    /**
+     * 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, any>>;
+    /**
+     * 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, any>>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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 list of all authentication resources.
+     *
+     * Required API Key ACLs:
+     * - addObject
+     * - deleteIndex
+     * - editSettings.
+     *
+     * @param getAuthentications - The getAuthentications object.
+     * @param getAuthentications.itemsPerPage - Number of items per page.
+     * @param getAuthentications.page - Page number of the paginated API response.
+     * @param getAuthentications.type - Type of authentication resource to retrieve.
+     * @param getAuthentications.platform - Ecommerce platform for which to retrieve authentication resources.
+     * @param getAuthentications.sort - Property by which to sort the list of authentication resources.
+     * @param getAuthentications.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.
+     */
+    getAuthentications({ itemsPerPage, page, type, platform, sort, order, }?: GetAuthenticationsProps, requestOptions?: RequestOptions | undefined): Promise<ListAuthenticationsResponse>;
+    /**
+     * 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 list of destinations.
+     *
+     * Required API Key ACLs:
+     * - addObject
+     * - deleteIndex
+     * - editSettings.
+     *
+     * @param getDestinations - The getDestinations object.
+     * @param getDestinations.itemsPerPage - Number of items per page.
+     * @param getDestinations.page - Page number of the paginated API response.
+     * @param getDestinations.type - Destination type.
+     * @param getDestinations.authenticationID - Authentication ID used by destinations.
+     * @param getDestinations.sort - Property by which to sort the destinations.
+     * @param getDestinations.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.
+     */
+    getDestinations({ itemsPerPage, page, type, authenticationID, sort, order, }?: GetDestinationsProps, requestOptions?: RequestOptions | undefined): Promise<ListDestinationsResponse>;
+    /**
+     * Retrieves a stream listing for a source.  Listing streams only works with sources with `type: docker` and `imageType: singer`.
+     *
+     * Required API Key ACLs:
+     * - addObject
+     * - deleteIndex
+     * - editSettings.
+     *
+     * @param getDockerSourceStreams - The getDockerSourceStreams object.
+     * @param getDockerSourceStreams.sourceID - Unique identifier of a source.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getDockerSourceStreams({ sourceID }: GetDockerSourceStreamsProps, requestOptions?: RequestOptions): Promise<DockerSourceStreams>;
+    /**
+     * 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>;
+    /**
+     * Retrieves a list of events for a task run, identified by it\'s ID.
+     *
+     * Required API Key ACLs:
+     * - addObject
+     * - deleteIndex
+     * - editSettings.
+     *
+     * @param getEvents - The getEvents object.
+     * @param getEvents.runID - Unique identifier of a task run.
+     * @param getEvents.itemsPerPage - Number of items per page.
+     * @param getEvents.page - Page number of the paginated API response.
+     * @param getEvents.status - Event status for filtering the list of task runs.
+     * @param getEvents.type - Event type for filtering the list of task runs.
+     * @param getEvents.sort - Property by which to sort the list of task run events.
+     * @param getEvents.order - Sort order of the response, ascending or descending.
+     * @param getEvents.startDate - Date and time in RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
+     * @param getEvents.endDate - Date and time in RFC3339 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.
+     */
+    getEvents({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate, }: GetEventsProps, requestOptions?: RequestOptions): Promise<ListEventsResponse>;
+    /**
+     * 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 list of task runs.
+     *
+     * Required API Key ACLs:
+     * - addObject
+     * - deleteIndex
+     * - editSettings.
+     *
+     * @param getRuns - The getRuns object.
+     * @param getRuns.itemsPerPage - Number of items per page.
+     * @param getRuns.page - Page number of the paginated API response.
+     * @param getRuns.status - Run status for filtering the list of task runs.
+     * @param getRuns.taskID - Task ID for filtering the list of task runs.
+     * @param getRuns.sort - Property by which to sort the list of task runs.
+     * @param getRuns.order - Sort order of the response, ascending or descending.
+     * @param getRuns.startDate - Date in RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
+     * @param getRuns.endDate - Date in RFC3339 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.
+     */
+    getRuns({ itemsPerPage, page, status, taskID, sort, order, startDate, endDate, }?: GetRunsProps, requestOptions?: RequestOptions | undefined): Promise<RunListResponse>;
+    /**
+     * 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 list of sources.
+     *
+     * Required API Key ACLs:
+     * - addObject
+     * - deleteIndex
+     * - editSettings.
+     *
+     * @param getSources - The getSources object.
+     * @param getSources.itemsPerPage - Number of items per page.
+     * @param getSources.page - Page number of the paginated API response.
+     * @param getSources.type - Source type. Some sources require authentication.
+     * @param getSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication resource.
+     * @param getSources.sort - Property by which to sort the list of sources.
+     * @param getSources.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.
+     */
+    getSources({ itemsPerPage, page, type, authenticationID, sort, order, }?: GetSourcesProps, requestOptions?: RequestOptions | undefined): Promise<ListSourcesResponse>;
+    /**
+     * 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 list of tasks.
+     *
+     * Required API Key ACLs:
+     * - addObject
+     * - deleteIndex
+     * - editSettings.
+     *
+     * @param getTasks - The getTasks object.
+     * @param getTasks.itemsPerPage - Number of items per page.
+     * @param getTasks.page - Page number of the paginated API response.
+     * @param getTasks.action - Actions for filtering the list of tasks.
+     * @param getTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
+     * @param getTasks.sourceID - Source IDs for filtering the list of tasks.
+     * @param getTasks.destinationID - Destination IDs for filtering the list of tasks.
+     * @param getTasks.triggerType - Type of task trigger for filtering the list of tasks.
+     * @param getTasks.sort - Property by which to sort the list of tasks.
+     * @param getTasks.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.
+     */
+    getTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order, }?: GetTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
+    /**
+     * 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>;
+    /**
+     * 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[]>;
+    /**
+     * 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<DockerSourceDiscover>;
+    /**
+     * 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>;
+};
 //# sourceMappingURL=ingestionClient.d.ts.map