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

package/dist/model/clientMethodProps.d.ts

@@ -1,283 +1,466 @@
-import type { ActionType } from './actionType';
-import type { AuthenticationUpdate } from './authenticationUpdate';
-import type { DestinationUpdate } from './destinationUpdate';
-import type { SourceUpdate } from './sourceUpdate';
-import type { TaskUpdate } from './taskUpdate';
-import type { TriggerType } from './triggerType';
-/**
- * Properties for the `deleteAuthentication` method.
- */
-export declare type DeleteAuthenticationProps = {
-    /**
-     * The authentication uuid.
-     */
-    authenticationID: string;
-};
-/**
- * Properties for the `deleteDestination` method.
- */
-export declare type DeleteDestinationProps = {
-    /**
-     * The destination uuid.
-     */
-    destinationID: string;
-};
-/**
- * Properties for the `deleteSource` method.
- */
-export declare type DeleteSourceProps = {
-    /**
-     * The source uuid.
-     */
-    sourceID: string;
-};
-/**
- * Properties for the `deleteTask` method.
- */
-export declare type DeleteTaskProps = {
-    /**
-     * The task uuid.
-     */
-    taskID: string;
-};
-/**
- * Properties for the `disableTask` method.
- */
-export declare type DisableTaskProps = {
-    /**
-     * The task uuid.
-     */
-    taskID: string;
-};
-/**
- * Properties for the `enableTask` method.
- */
-export declare type EnableTaskProps = {
-    /**
-     * The task uuid.
-     */
-    taskID: string;
-};
-/**
- * Properties for the `getAuthentication` method.
- */
-export declare type GetAuthenticationProps = {
-    /**
-     * The authentication uuid.
-     */
-    authenticationID: string;
-};
-/**
- * Properties for the `getAuthentications` method.
- */
-export declare type GetAuthenticationsProps = {
-    /**
-     * The number of items per page to return.
-     */
-    itemsPerPage?: number;
-    /**
-     * The page number to fetch, starting at 1.
-     */
-    page?: number;
-};
-/**
- * Properties for the `getDestination` method.
- */
-export declare type GetDestinationProps = {
-    /**
-     * The destination uuid.
-     */
-    destinationID: string;
-};
-/**
- * Properties for the `getDestinations` method.
- */
-export declare type GetDestinationsProps = {
-    /**
-     * The number of items per page to return.
-     */
-    itemsPerPage?: number;
-    /**
-     * The page number to fetch, starting at 1.
-     */
-    page?: number;
-};
-/**
- * Properties for the `getEvent` method.
- */
-export declare type GetEventProps = {
-    /**
-     * The run uuid.
-     */
-    runID: string;
-    /**
-     * The event uuid.
-     */
-    eventID: string;
-};
-/**
- * Properties for the `getEvents` method.
- */
-export declare type GetEventsProps = {
-    /**
-     * The run uuid.
-     */
-    runID: string;
-    /**
-     * The number of items per page to return.
-     */
-    itemsPerPage?: number;
-    /**
-     * The page number to fetch, starting at 1.
-     */
-    page?: number;
-};
-/**
- * Properties for the `getRun` method.
- */
-export declare type GetRunProps = {
-    /**
-     * The run uuid.
-     */
-    runID: string;
-};
-/**
- * Properties for the `getRuns` method.
- */
-export declare type GetRunsProps = {
-    /**
-     * The number of items per page to return.
-     */
-    itemsPerPage?: number;
-    /**
-     * The page number to fetch, starting at 1.
-     */
-    page?: number;
-};
-/**
- * Properties for the `getRunsByTaskID` method.
- */
-export declare type GetRunsByTaskIDProps = {
-    /**
-     * The task uuid.
-     */
-    taskID: string;
-    /**
-     * The number of items per page to return.
-     */
-    itemsPerPage?: number;
-    /**
-     * The page number to fetch, starting at 1.
-     */
-    page?: number;
-};
-/**
- * Properties for the `getSource` method.
- */
-export declare type GetSourceProps = {
-    /**
-     * The source uuid.
-     */
-    sourceID: string;
-};
-/**
- * Properties for the `getSources` method.
- */
-export declare type GetSourcesProps = {
-    /**
-     * The number of items per page to return.
-     */
-    itemsPerPage?: number;
-    /**
-     * The page number to fetch, starting at 1.
-     */
-    page?: number;
-};
-/**
- * Properties for the `getTask` method.
- */
-export declare type GetTaskProps = {
-    /**
-     * The task uuid.
-     */
-    taskID: string;
-};
-/**
- * Properties for the `getTasks` method.
- */
-export declare type GetTasksProps = {
-    /**
-     * The number of items per page to return.
-     */
-    itemsPerPage?: number;
-    /**
-     * The page number to fetch, starting at 1.
-     */
-    page?: number;
-    /**
-     * Which action the returned task should have. Can be a list of string separated with commas.
-     */
-    action?: ActionType[];
-    /**
-     * If the returned task should have its \'enabled\' property set to true.
-     */
-    enabled?: boolean;
-    /**
-     * Which destinationID the returned task should have. Can be a list of string separated with commas.
-     */
-    destinationID?: string[];
-    /**
-     * Which trigger type the returned task should have. Can be a list of string separated with commas.
-     */
-    triggerType?: TriggerType[];
-};
-/**
- * Properties for the `runTask` method.
- */
-export declare type RunTaskProps = {
-    /**
-     * The task uuid.
-     */
-    taskID: string;
-};
-/**
- * Properties for the `updateAuthentication` method.
- */
-export declare type UpdateAuthenticationProps = {
-    /**
-     * The authentication uuid.
-     */
-    authenticationID: string;
-    authenticationUpdate: AuthenticationUpdate;
-};
-/**
- * Properties for the `updateDestination` method.
- */
-export declare type UpdateDestinationProps = {
-    /**
-     * The destination uuid.
-     */
-    destinationID: string;
-    destinationUpdate: DestinationUpdate;
-};
-/**
- * Properties for the `updateSource` method.
- */
-export declare type UpdateSourceProps = {
-    /**
-     * The source uuid.
-     */
-    sourceID: string;
-    sourceUpdate: SourceUpdate;
-};
-/**
- * Properties for the `updateTask` method.
- */
-export declare type UpdateTaskProps = {
-    /**
-     * The task uuid.
-     */
-    taskID: string;
-    taskUpdate: TaskUpdate;
-};
+import type { ActionType } from './actionType';
+import type { AuthenticationSortKeys } from './authenticationSortKeys';
+import type { AuthenticationType } from './authenticationType';
+import type { AuthenticationUpdate } from './authenticationUpdate';
+import type { DestinationSortKeys } from './destinationSortKeys';
+import type { DestinationType } from './destinationType';
+import type { DestinationUpdate } from './destinationUpdate';
+import type { EventSortKeys } from './eventSortKeys';
+import type { EventStatus } from './eventStatus';
+import type { EventType } from './eventType';
+import type { OrderKeys } from './orderKeys';
+import type { PlatformWithNone } from './platformWithNone';
+import type { RunSortKeys } from './runSortKeys';
+import type { RunStatus } from './runStatus';
+import type { SourceSortKeys } from './sourceSortKeys';
+import type { SourceType } from './sourceType';
+import type { SourceUpdate } from './sourceUpdate';
+import type { TaskSortKeys } from './taskSortKeys';
+import type { TaskUpdate } from './taskUpdate';
+import type { TriggerType } from './triggerType';
+/**
+ * Properties for the `customDelete` method.
+ */
+export type CustomDeleteProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customGet` method.
+ */
+export type CustomGetProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customPost` method.
+ */
+export type CustomPostProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, any>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+export type CustomPutProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, any>;
+};
+/**
+ * Properties for the `deleteAuthentication` method.
+ */
+export type DeleteAuthenticationProps = {
+    /**
+     * Unique identifier of an authentication resource.
+     */
+    authenticationID: string;
+};
+/**
+ * Properties for the `deleteDestination` method.
+ */
+export type DeleteDestinationProps = {
+    /**
+     * Unique identifier of a destination.
+     */
+    destinationID: string;
+};
+/**
+ * Properties for the `deleteSource` method.
+ */
+export type DeleteSourceProps = {
+    /**
+     * Unique identifier of a source.
+     */
+    sourceID: string;
+};
+/**
+ * Properties for the `deleteTask` method.
+ */
+export type DeleteTaskProps = {
+    /**
+     * Unique identifier of a task.
+     */
+    taskID: string;
+};
+/**
+ * Properties for the `disableTask` method.
+ */
+export type DisableTaskProps = {
+    /**
+     * Unique identifier of a task.
+     */
+    taskID: string;
+};
+/**
+ * Properties for the `enableTask` method.
+ */
+export type EnableTaskProps = {
+    /**
+     * Unique identifier of a task.
+     */
+    taskID: string;
+};
+/**
+ * Properties for the `getAuthentication` method.
+ */
+export type GetAuthenticationProps = {
+    /**
+     * Unique identifier of an authentication resource.
+     */
+    authenticationID: string;
+};
+/**
+ * Properties for the `getAuthentications` method.
+ */
+export type GetAuthenticationsProps = {
+    /**
+     * Number of items per page.
+     */
+    itemsPerPage?: number;
+    /**
+     * Page number of the paginated API response.
+     */
+    page?: number;
+    /**
+     * Type of authentication resource to retrieve.
+     */
+    type?: AuthenticationType[];
+    /**
+     * Ecommerce platform for which to retrieve authentication resources.
+     */
+    platform?: PlatformWithNone[];
+    /**
+     * Property by which to sort the list of authentication resources.
+     */
+    sort?: AuthenticationSortKeys;
+    /**
+     * Sort order of the response, ascending or descending.
+     */
+    order?: OrderKeys;
+};
+/**
+ * Properties for the `getDestination` method.
+ */
+export type GetDestinationProps = {
+    /**
+     * Unique identifier of a destination.
+     */
+    destinationID: string;
+};
+/**
+ * Properties for the `getDestinations` method.
+ */
+export type GetDestinationsProps = {
+    /**
+     * Number of items per page.
+     */
+    itemsPerPage?: number;
+    /**
+     * Page number of the paginated API response.
+     */
+    page?: number;
+    /**
+     * Destination type.
+     */
+    type?: DestinationType[];
+    /**
+     * Authentication ID used by destinations.
+     */
+    authenticationID?: string[];
+    /**
+     * Property by which to sort the destinations.
+     */
+    sort?: DestinationSortKeys;
+    /**
+     * Sort order of the response, ascending or descending.
+     */
+    order?: OrderKeys;
+};
+/**
+ * Properties for the `getDockerSourceStreams` method.
+ */
+export type GetDockerSourceStreamsProps = {
+    /**
+     * Unique identifier of a source.
+     */
+    sourceID: string;
+};
+/**
+ * Properties for the `getEvent` method.
+ */
+export type GetEventProps = {
+    /**
+     * Unique identifier of a task run.
+     */
+    runID: string;
+    /**
+     * Unique identifier of an event.
+     */
+    eventID: string;
+};
+/**
+ * Properties for the `getEvents` method.
+ */
+export type GetEventsProps = {
+    /**
+     * Unique identifier of a task run.
+     */
+    runID: string;
+    /**
+     * Number of items per page.
+     */
+    itemsPerPage?: number;
+    /**
+     * Page number of the paginated API response.
+     */
+    page?: number;
+    /**
+     * Event status for filtering the list of task runs.
+     */
+    status?: EventStatus[];
+    /**
+     * Event type for filtering the list of task runs.
+     */
+    type?: EventType[];
+    /**
+     * Property by which to sort the list of task run events.
+     */
+    sort?: EventSortKeys;
+    /**
+     * Sort order of the response, ascending or descending.
+     */
+    order?: OrderKeys;
+    /**
+     * Date and time in RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
+     */
+    startDate?: string;
+    /**
+     * Date and time in RFC3339 format for the latest events to retrieve. By default, the current time is used.
+     */
+    endDate?: string;
+};
+/**
+ * Properties for the `getRun` method.
+ */
+export type GetRunProps = {
+    /**
+     * Unique identifier of a task run.
+     */
+    runID: string;
+};
+/**
+ * Properties for the `getRuns` method.
+ */
+export type GetRunsProps = {
+    /**
+     * Number of items per page.
+     */
+    itemsPerPage?: number;
+    /**
+     * Page number of the paginated API response.
+     */
+    page?: number;
+    /**
+     * Run status for filtering the list of task runs.
+     */
+    status?: RunStatus[];
+    /**
+     * Task ID for filtering the list of task runs.
+     */
+    taskID?: string;
+    /**
+     * Property by which to sort the list of task runs.
+     */
+    sort?: RunSortKeys;
+    /**
+     * Sort order of the response, ascending or descending.
+     */
+    order?: OrderKeys;
+    /**
+     * Date in RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
+     */
+    startDate?: string;
+    /**
+     * Date in RFC3339 format for the latest run to retrieve. By default, the current day is used.
+     */
+    endDate?: string;
+};
+/**
+ * Properties for the `getSource` method.
+ */
+export type GetSourceProps = {
+    /**
+     * Unique identifier of a source.
+     */
+    sourceID: string;
+};
+/**
+ * Properties for the `getSources` method.
+ */
+export type GetSourcesProps = {
+    /**
+     * Number of items per page.
+     */
+    itemsPerPage?: number;
+    /**
+     * Page number of the paginated API response.
+     */
+    page?: number;
+    /**
+     * Source type. Some sources require authentication.
+     */
+    type?: SourceType[];
+    /**
+     * Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication resource.
+     */
+    authenticationID?: string[];
+    /**
+     * Property by which to sort the list of sources.
+     */
+    sort?: SourceSortKeys;
+    /**
+     * Sort order of the response, ascending or descending.
+     */
+    order?: OrderKeys;
+};
+/**
+ * Properties for the `getTask` method.
+ */
+export type GetTaskProps = {
+    /**
+     * Unique identifier of a task.
+     */
+    taskID: string;
+};
+/**
+ * Properties for the `getTasks` method.
+ */
+export type GetTasksProps = {
+    /**
+     * Number of items per page.
+     */
+    itemsPerPage?: number;
+    /**
+     * Page number of the paginated API response.
+     */
+    page?: number;
+    /**
+     * Actions for filtering the list of tasks.
+     */
+    action?: ActionType[];
+    /**
+     * Whether to filter the list of tasks by the `enabled` status.
+     */
+    enabled?: boolean;
+    /**
+     * Source IDs for filtering the list of tasks.
+     */
+    sourceID?: string[];
+    /**
+     * Destination IDs for filtering the list of tasks.
+     */
+    destinationID?: string[];
+    /**
+     * Type of task trigger for filtering the list of tasks.
+     */
+    triggerType?: TriggerType[];
+    /**
+     * Property by which to sort the list of tasks.
+     */
+    sort?: TaskSortKeys;
+    /**
+     * Sort order of the response, ascending or descending.
+     */
+    order?: OrderKeys;
+};
+/**
+ * Properties for the `runTask` method.
+ */
+export type RunTaskProps = {
+    /**
+     * Unique identifier of a task.
+     */
+    taskID: string;
+};
+/**
+ * Properties for the `triggerDockerSourceDiscover` method.
+ */
+export type TriggerDockerSourceDiscoverProps = {
+    /**
+     * Unique identifier of a source.
+     */
+    sourceID: string;
+};
+/**
+ * Properties for the `updateAuthentication` method.
+ */
+export type UpdateAuthenticationProps = {
+    /**
+     * Unique identifier of an authentication resource.
+     */
+    authenticationID: string;
+    authenticationUpdate: AuthenticationUpdate;
+};
+/**
+ * Properties for the `updateDestination` method.
+ */
+export type UpdateDestinationProps = {
+    /**
+     * Unique identifier of a destination.
+     */
+    destinationID: string;
+    destinationUpdate: DestinationUpdate;
+};
+/**
+ * Properties for the `updateSource` method.
+ */
+export type UpdateSourceProps = {
+    /**
+     * Unique identifier of a source.
+     */
+    sourceID: string;
+    sourceUpdate: SourceUpdate;
+};
+/**
+ * Properties for the `updateTask` method.
+ */
+export type UpdateTaskProps = {
+    /**
+     * Unique identifier of a task.
+     */
+    taskID: string;
+    taskUpdate: TaskUpdate;
+};
 //# sourceMappingURL=clientMethodProps.d.ts.map