/** * Faraday REST API * The [Faraday](https://faraday.ai) API makes it easy to predict customer behavior programmatically. See our [API change policy](https://faraday.ai/legal). * * The version of the OpenAPI document: 1.0.0 * Contact: support@faraday.ai * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { ArchiveConfig, Dataset, DatasetIngressLog, DatasetMergePatch, DatasetPost } from '../models'; export interface ArchiveDatasetRequest { datasetId: string; archiveConfig: ArchiveConfig; } export interface CreateDatasetRequest { datasetFields: DatasetPost; } export interface DeleteDatasetRequest { datasetId: string; } export interface ForceUpdateDatasetRequest { datasetId: string; } export interface GetDatasetRequest { datasetId: string; } export interface GetDatasetIngressLogRequest { datasetId: string; logId: string; } export interface GetDatasetIngressLogsRequest { datasetId: string; limit?: number; offset?: number; } export interface GetDatasetsRequest { ids?: Array; } export interface UnarchiveDatasetRequest { datasetId: string; archiveConfig: ArchiveConfig; } export interface UpdateDatasetRequest { datasetId: string; datasetFields: DatasetMergePatch; } /** * */ export declare class DatasetsApi extends runtime.BaseAPI { /** * Archive a dataset * Archive a dataset */ archiveDatasetRaw(requestParameters: ArchiveDatasetRequest): Promise>; /** * Archive a dataset * Archive a dataset */ archiveDataset(datasetId: string, archiveConfig: ArchiveConfig): Promise; /** * Create a new dataset * Create dataset */ createDatasetRaw(requestParameters: CreateDatasetRequest): Promise>; /** * Create a new dataset * Create dataset */ createDataset(datasetFields: DatasetPost): Promise; /** * Delete a dataset */ deleteDatasetRaw(requestParameters: DeleteDatasetRequest): Promise>; /** * Delete a dataset */ deleteDataset(datasetId: string): Promise; /** * Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors. * Trigger a rerun for this resource. */ forceUpdateDatasetRaw(requestParameters: ForceUpdateDatasetRequest): Promise>; /** * Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors. * Trigger a rerun for this resource. */ forceUpdateDataset(datasetId: string): Promise; /** * Retrieve details on a specific dataset * Retrieve a dataset */ getDatasetRaw(requestParameters: GetDatasetRequest): Promise>; /** * Retrieve details on a specific dataset * Retrieve a dataset */ getDataset(datasetId: string): Promise; /** * Retrieves a specific ingress log entry for a dataset * Get a single dataset ingress log by ID */ getDatasetIngressLogRaw(requestParameters: GetDatasetIngressLogRequest): Promise>; /** * Retrieves a specific ingress log entry for a dataset * Get a single dataset ingress log by ID */ getDatasetIngressLog(datasetId: string, logId: string): Promise; /** * Retrieves ingress metrics for a specific dataset * Get dataset ingress metrics over time */ getDatasetIngressLogsRaw(requestParameters: GetDatasetIngressLogsRequest): Promise>>; /** * Retrieves ingress metrics for a specific dataset * Get dataset ingress metrics over time */ getDatasetIngressLogs(datasetId: string, limit?: number, offset?: number): Promise>; /** * Get a list of the datasets available in the developer’s account * List datasets */ getDatasetsRaw(requestParameters: GetDatasetsRequest): Promise>>; /** * Get a list of the datasets available in the developer’s account * List datasets */ getDatasets(ids?: Array): Promise>; /** * Unarchive a dataset * Unarchive a dataset */ unarchiveDatasetRaw(requestParameters: UnarchiveDatasetRequest): Promise>; /** * Unarchive a dataset * Unarchive a dataset */ unarchiveDataset(datasetId: string, archiveConfig: ArchiveConfig): Promise; /** * Update an existing dataset * Update dataset */ updateDatasetRaw(requestParameters: UpdateDatasetRequest): Promise>; /** * Update an existing dataset * Update dataset */ updateDataset(datasetId: string, datasetFields: DatasetMergePatch): Promise; }