/** * 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, Outcome, OutcomeAnalysis, OutcomeMergePatch, OutcomePost } from '../models'; export interface ArchiveOutcomeRequest { outcomeId: string; archiveConfig: ArchiveConfig; } export interface CreateOutcomeRequest { outcomeFields: OutcomePost; } export interface DeleteOutcomeRequest { outcomeId: string; } export interface ForceUpdateOutcomeRequest { outcomeId: string; } export interface GetOutcomeRequest { outcomeId: string; } export interface GetOutcomeAnalysisRequest { outcomeId: string; } export interface GetOutcomeDownloadRequest { outcomeId: string; } export interface GetOutcomesRequest { ids?: Array; } export interface UnarchiveOutcomeRequest { outcomeId: string; archiveConfig: ArchiveConfig; } export interface UpdateOutcomeRequest { outcomeId: string; outcomeFields: OutcomeMergePatch; } /** * */ export declare class OutcomesApi extends runtime.BaseAPI { /** * Archive a outcome * Archive a outcome */ archiveOutcomeRaw(requestParameters: ArchiveOutcomeRequest): Promise>; /** * Archive a outcome * Archive a outcome */ archiveOutcome(outcomeId: string, archiveConfig: ArchiveConfig): Promise; /** * Add a new outcome (defined as a prediction of how likely individuals are to transition from one cohort to another) * Create outcome */ createOutcomeRaw(requestParameters: CreateOutcomeRequest): Promise>; /** * Add a new outcome (defined as a prediction of how likely individuals are to transition from one cohort to another) * Create outcome */ createOutcome(outcomeFields: OutcomePost): Promise; /** * Delete an outcome */ deleteOutcomeRaw(requestParameters: DeleteOutcomeRequest): Promise>; /** * Delete an outcome */ deleteOutcome(outcomeId: 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. */ forceUpdateOutcomeRaw(requestParameters: ForceUpdateOutcomeRequest): 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. */ forceUpdateOutcome(outcomeId: string): Promise; /** * Get details on a specific outcome * Retrieve an outcome */ getOutcomeRaw(requestParameters: GetOutcomeRequest): Promise>; /** * Get details on a specific outcome * Retrieve an outcome */ getOutcome(outcomeId: string): Promise; /** * Get details on a specific outcome\'s analysis report on model performance, bias, etc. * Retrieve an outcome\'s analysis */ getOutcomeAnalysisRaw(requestParameters: GetOutcomeAnalysisRequest): Promise>; /** * Get details on a specific outcome\'s analysis report on model performance, bias, etc. * Retrieve an outcome\'s analysis */ getOutcomeAnalysis(outcomeId: string): Promise; /** * Download an HTML report containing information such as the objective of the model, performance, and important features * Retrieve outcome report */ getOutcomeDownloadRaw(requestParameters: GetOutcomeDownloadRequest): Promise>; /** * Download an HTML report containing information such as the objective of the model, performance, and important features * Retrieve outcome report */ getOutcomeDownload(outcomeId: string): Promise; /** * Get a list of outcomes defined on the account * List outcomes */ getOutcomesRaw(requestParameters: GetOutcomesRequest): Promise>>; /** * Get a list of outcomes defined on the account * List outcomes */ getOutcomes(ids?: Array): Promise>; /** * Unarchive a outcome * Unarchive a outcome */ unarchiveOutcomeRaw(requestParameters: UnarchiveOutcomeRequest): Promise>; /** * Unarchive a outcome * Unarchive a outcome */ unarchiveOutcome(outcomeId: string, archiveConfig: ArchiveConfig): Promise; /** * Edit configuration of an existing outcome * Edit an outcome */ updateOutcomeRaw(requestParameters: UpdateOutcomeRequest): Promise>; /** * Edit configuration of an existing outcome * Edit an outcome */ updateOutcome(outcomeId: string, outcomeFields: OutcomeMergePatch): Promise; }