@algolia/ingestion 1.0.0-alpha.82 → 1.0.0-alpha.84

package/dist/src/ingestionClient.d.ts

@@ -37,7 +37,7 @@ 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-alpha.82";
+export declare const apiClientVersion = "1.0.0-alpha.84";
 export declare const REGIONS: readonly ["eu", "us"];
 export type Region = (typeof REGIONS)[number];
 /**
@@ -85,7 +85,7 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      */
     addAlgoliaAgent(segment: string, version?: string): void;
     /**
-     * Create a authentication.
+     * Creates a new authentication resource.
      *
      * Required API Key ACLs:
      * - addObject
@@ -97,7 +97,7 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      */
     createAuthentication(authenticationCreate: AuthenticationCreate, requestOptions?: RequestOptions): Promise<AuthenticationCreateResponse>;
     /**
-     * Create a destination.
+     * Creates a new destination.
      *
      * Required API Key ACLs:
      * - addObject
@@ -109,7 +109,7 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      */
     createDestination(destinationCreate: DestinationCreate, requestOptions?: RequestOptions): Promise<DestinationCreateResponse>;
     /**
-     * Create a source.
+     * Creates a new source.
      *
      * Required API Key ACLs:
      * - addObject
@@ -121,9 +121,9 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      */
     createSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions): Promise<SourceCreateResponse>;
     /**
-     * Create a task.
+     * Creates a new task.
      *
-     * @param taskCreate -.
+     * @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>;
@@ -166,7 +166,7 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      */
     customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
-     * Soft delete the authentication of the given authenticationID.
+     * Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
      *
      * Required API Key ACLs:
      * - addObject
@@ -174,12 +174,12 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param deleteAuthentication - The deleteAuthentication object.
-     * @param deleteAuthentication.authenticationID - The authentication UUID.
+     * @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>;
     /**
-     * Soft delete the destination of the given destinationID.
+     * Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
      *
      * Required API Key ACLs:
      * - addObject
@@ -187,12 +187,12 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param deleteDestination - The deleteDestination object.
-     * @param deleteDestination.destinationID - The destination UUID.
+     * @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>;
     /**
-     * Soft delete the source of the given sourceID.
+     * Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
      *
      * Required API Key ACLs:
      * - addObject
@@ -200,20 +200,20 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param deleteSource - The deleteSource object.
-     * @param deleteSource.sourceID - The source UUID.
+     * @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>;
     /**
-     * Soft delete the task of the given taskID.
+     * Deletes a task by its ID.
      *
      * @param deleteTask - The deleteTask object.
-     * @param deleteTask.taskID - The task UUID.
+     * @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>;
     /**
-     * Disable the task of the given taskID.
+     * Disables a task.
      *
      * Required API Key ACLs:
      * - addObject
@@ -221,12 +221,12 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param disableTask - The disableTask object.
-     * @param disableTask.taskID - The task UUID.
+     * @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>;
     /**
-     * Enable the task of the given taskID.
+     * Enables a task.
      *
      * Required API Key ACLs:
      * - addObject
@@ -234,12 +234,12 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param enableTask - The enableTask object.
-     * @param enableTask.taskID - The task UUID.
+     * @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>;
     /**
-     * Get the authentication of the given authenticationID.
+     * Retrieves an authentication resource by its ID.
      *
      * Required API Key ACLs:
      * - addObject
@@ -247,12 +247,12 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param getAuthentication - The getAuthentication object.
-     * @param getAuthentication.authenticationID - The authentication UUID.
+     * @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>;
     /**
-     * Get a list of authentications for the given query parameters, with pagination details.
+     * Retrieves a list of all authentication resources.
      *
      * Required API Key ACLs:
      * - addObject
@@ -260,17 +260,17 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @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 getAuthentications.type - The type of the authentications to retrieve.
-     * @param getAuthentications.platform - The platform of the authentications to retrieve.
-     * @param getAuthentications.sort - The key by which the list should be sorted.
-     * @param getAuthentications.order - The order of the returned list.
+     * @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>;
     /**
-     * Get the destination of the given destinationID.
+     * Retrieves a destination by its ID.
      *
      * Required API Key ACLs:
      * - addObject
@@ -278,12 +278,12 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param getDestination - The getDestination object.
-     * @param getDestination.destinationID - The destination UUID.
+     * @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>;
     /**
-     * Get a list of destinations for the given query parameters, with pagination details.
+     * Retrieves a list of destinations.
      *
      * Required API Key ACLs:
      * - addObject
@@ -291,17 +291,17 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @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 getDestinations.type - The type of the destinations to retrive.
-     * @param getDestinations.authenticationID - The authenticationIDs of the destinations to retrive.
-     * @param getDestinations.sort - The key by which the list should be sorted.
-     * @param getDestinations.order - The order of the returned list.
+     * @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>;
     /**
-     * Retrieve a stream listing for a given Singer specification compatible docker type source ID.
+     * Retrieves a stream listing for a source.  Listing streams only works with sources with `type: docker` and `imageType: singer`.
      *
      * Required API Key ACLs:
      * - addObject
@@ -309,12 +309,12 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param getDockerSourceStreams - The getDockerSourceStreams object.
-     * @param getDockerSourceStreams.sourceID - The source UUID.
+     * @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>;
     /**
-     * Get a single event for a specific runID.
+     * Retrieves a single task run event by its ID.
      *
      * Required API Key ACLs:
      * - addObject
@@ -322,13 +322,13 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param getEvent - The getEvent object.
-     * @param getEvent.runID - The run UUID.
-     * @param getEvent.eventID - The event UUID.
+     * @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>;
     /**
-     * Get a list of events associated to the given runID, for the given query parameters.
+     * Retrieves a list of events for a task run, identified by it\'s ID.
      *
      * Required API Key ACLs:
      * - addObject
@@ -336,20 +336,20 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @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 getEvents.status - Filter the status of the events.
-     * @param getEvents.type - Filter the type of the events.
-     * @param getEvents.sort - The key by which the list should be sorted.
-     * @param getEvents.order - The order of the returned list.
-     * @param getEvents.startDate - The start date (in RFC3339 format) of the events fetching window. Defaults to \'now\'-3 hours if omitted.
-     * @param getEvents.endDate - The end date (in RFC3339 format) of the events fetching window. Defaults to \'now\' days if omitted.
+     * @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>;
     /**
-     * Get a single run for the given ID.
+     * Retrieve a single task run by its ID.
      *
      * Required API Key ACLs:
      * - addObject
@@ -357,12 +357,12 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param getRun - The getRun object.
-     * @param getRun.runID - The run UUID.
+     * @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>;
     /**
-     * Get a list of runs for the given query parameters, with pagination details.
+     * Retrieve a list of task runs.
      *
      * Required API Key ACLs:
      * - addObject
@@ -370,19 +370,19 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @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 getRuns.status - Filter the status of the runs.
-     * @param getRuns.taskID - Filter by taskID.
-     * @param getRuns.sort - The key by which the list should be sorted.
-     * @param getRuns.order - The order of the returned list.
-     * @param getRuns.startDate - The start date (in RFC3339 format) of the runs fetching window. Defaults to \'now\'-7 days if omitted.
-     * @param getRuns.endDate - The end date (in RFC3339 format) of the runs fetching window. Defaults to \'now\' days if omitted.
+     * @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>;
     /**
-     * Get the source of the given sourceID.
+     * Retrieve a source by its ID.
      *
      * Required API Key ACLs:
      * - addObject
@@ -390,12 +390,12 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param getSource - The getSource object.
-     * @param getSource.sourceID - The source UUID.
+     * @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>;
     /**
-     * Get a list of sources for the given query parameters, with pagination details.
+     * Retrieves a list of sources.
      *
      * Required API Key ACLs:
      * - addObject
@@ -403,17 +403,17 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @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 getSources.type - The type of the sources to retrieve.
-     * @param getSources.authenticationID - The authenticationIDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
-     * @param getSources.sort - The key by which the list should be sorted.
-     * @param getSources.order - The order of the returned list.
+     * @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>;
     /**
-     * Get the task of the given taskID.
+     * Retrieves a task by its ID.
      *
      * Required API Key ACLs:
      * - addObject
@@ -421,12 +421,12 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param getTask - The getTask object.
-     * @param getTask.taskID - The task UUID.
+     * @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>;
     /**
-     * Get a list of tasks for the given query parameters, with pagination details.
+     * Retrieves a list of tasks.
      *
      * Required API Key ACLs:
      * - addObject
@@ -434,20 +434,20 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @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 - The action of the tasks to retrieve.
-     * @param getTasks.enabled - Whether the task is enabled or not.
-     * @param getTasks.sourceID - The sourceIDs of the tasks to retrieve.
-     * @param getTasks.destinationID - The destinationIDs of the tasks to retrieve.
-     * @param getTasks.triggerType - The trigger type of the task.
-     * @param getTasks.sort - The key by which the list should be sorted.
-     * @param getTasks.order - The order of the returned list.
+     * @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>;
     /**
-     * Run the task of the given taskID.
+     * Runs a task. You can check the status of task runs with the observability endpoints.
      *
      * Required API Key ACLs:
      * - addObject
@@ -455,12 +455,12 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param runTask - The runTask object.
-     * @param runTask.taskID - The task UUID.
+     * @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>;
     /**
-     * Search among authentications with a defined set of parameters.
+     * Searches for authentication resources.
      *
      * Required API Key ACLs:
      * - addObject
@@ -472,7 +472,7 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      */
     searchAuthentications(authenticationSearch: AuthenticationSearch, requestOptions?: RequestOptions): Promise<Authentication[]>;
     /**
-     * Search among destinations with a defined set of parameters.
+     * Searches for destinations.
      *
      * Required API Key ACLs:
      * - addObject
@@ -484,7 +484,7 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      */
     searchDestinations(destinationSearch: DestinationSearch, requestOptions?: RequestOptions): Promise<Destination[]>;
     /**
-     * Search among sources with a defined set of parameters.
+     * Searches for sources.
      *
      * Required API Key ACLs:
      * - addObject
@@ -496,7 +496,7 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      */
     searchSources(sourceSearch: SourceSearch, requestOptions?: RequestOptions): Promise<Source[]>;
     /**
-     * Search among tasks with a defined set of parameters.
+     * Searches for tasks.
      *
      * Required API Key ACLs:
      * - addObject
@@ -508,7 +508,7 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      */
     searchTasks(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<Task[]>;
     /**
-     * Trigger a stream listing request for a Singer specification compatible docker type source.
+     * 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
@@ -516,12 +516,12 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
-     * @param triggerDockerSourceDiscover.sourceID - The source UUID.
+     * @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>;
     /**
-     * Update the authentication of the given authenticationID.
+     * Updates an authentication resource.
      *
      * Required API Key ACLs:
      * - addObject
@@ -529,13 +529,13 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param updateAuthentication - The updateAuthentication object.
-     * @param updateAuthentication.authenticationID - The authentication UUID.
+     * @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>;
     /**
-     * Update the destination of the given destinationID.
+     * Updates the destination by its ID.
      *
      * Required API Key ACLs:
      * - addObject
@@ -543,13 +543,13 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param updateDestination - The updateDestination object.
-     * @param updateDestination.destinationID - The destination UUID.
+     * @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>;
     /**
-     * Update the source of the given sourceID.
+     * Updates a source by its ID.
      *
      * Required API Key ACLs:
      * - addObject
@@ -557,16 +557,16 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
      * - editSettings.
      *
      * @param updateSource - The updateSource object.
-     * @param updateSource.sourceID - The source UUID.
+     * @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>;
     /**
-     * Update the task of the given taskID.
+     * Updates a task by its ID.
      *
      * @param updateTask - The updateTask object.
-     * @param updateTask.taskID - The task UUID.
+     * @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.
      */

package/model/actionType.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * The action to perform on the Algolia index.
+ * Action to perform on the Algolia index.
  */
 export type ActionType = 'append' | 'partial' | 'replace' | 'save';

package/model/authAPIKey.ts

@@ -1,8 +1,11 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Authentication input used for token credentials.
+ * Credentials for authenticating with an API key.
  */
 export type AuthAPIKey = {
+  /**
+   * API key. This field is `null` in the API response.
+   */
   key: string;
 };

package/model/authAPIKeyPartial.ts

@@ -1,8 +1,11 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Authentication input used for token credentials.
+ * Credentials for authenticating with an API key.
  */
 export type AuthAPIKeyPartial = {
+  /**
+   * API key. This field is `null` in the API response.
+   */
   key?: string;
 };

package/model/authAlgolia.ts

@@ -1,13 +1,16 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+/**
+ * Credentials for authenticating with Algolia.
+ */
 export type AuthAlgolia = {
   /**
-   * Algolia Application ID.
+   * Algolia application ID.
    */
   appID: string;
 
   /**
-   * Algolia API Key, with the correct rights to push to an index and change settings.
+   * Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`. This field is `null` in the API response.
    */
   apiKey: string;
 };

package/model/authAlgoliaPartial.ts

@@ -1,13 +1,16 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+/**
+ * Credentials for authenticating with Algolia.
+ */
 export type AuthAlgoliaPartial = {
   /**
-   * Algolia Application ID.
+   * Algolia application ID.
    */
   appID?: string;
 
   /**
-   * Algolia API Key, with the correct rights to push to an index and change settings.
+   * Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`. This field is `null` in the API response.
    */
   apiKey?: string;
 };

package/model/authBasic.ts

@@ -1,10 +1,16 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Authentication input for Basic login with username and password.
+ * Credentials for authenticating with user name and password.
  */
 export type AuthBasic = {
+  /**
+   * Username.
+   */
   username: string;
 
+  /**
+   * Password. This field is `null` in the API response.
+   */
   password: string;
 };