/** * 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, Recommender, RecommenderAnalysis, RecommenderMergePatch, RecommenderPost } from '../models'; export interface ArchiveRecommenderRequest { recommenderId: string; archiveConfig: ArchiveConfig; } export interface CreateRecommenderRequest { recommenderFields: RecommenderPost; } export interface DeleteRecommenderRequest { recommenderId: string; } export interface ForceUpdateRecommenderRequest { recommenderId: string; } export interface GetRecommenderRequest { recommenderId: string; } export interface GetRecommenderAnalysisRequest { recommenderId: string; } export interface GetRecommendersRequest { ids?: Array; } export interface UnarchiveRecommenderRequest { recommenderId: string; archiveConfig: ArchiveConfig; } export interface UpdateRecommenderRequest { recommenderId: string; recommenderFields: RecommenderMergePatch; } /** * */ export declare class RecommendersApi extends runtime.BaseAPI { /** * Archive a recommender * Archive a recommender */ archiveRecommenderRaw(requestParameters: ArchiveRecommenderRequest): Promise>; /** * Archive a recommender * Archive a recommender */ archiveRecommender(recommenderId: string, archiveConfig: ArchiveConfig): Promise; /** * Add a new recommender. This feature is experimental and subject to change. To enable this feature, contact your account manager. * Create recommender */ createRecommenderRaw(requestParameters: CreateRecommenderRequest): Promise>; /** * Add a new recommender. This feature is experimental and subject to change. To enable this feature, contact your account manager. * Create recommender */ createRecommender(recommenderFields: RecommenderPost): Promise; /** * Delete a recommender */ deleteRecommenderRaw(requestParameters: DeleteRecommenderRequest): Promise>; /** * Delete a recommender */ deleteRecommender(recommenderId: string): Promise; /** * Trigger a rerun for this resource. * Trigger a rerun for this resource. */ forceUpdateRecommenderRaw(requestParameters: ForceUpdateRecommenderRequest): Promise>; /** * Trigger a rerun for this resource. * Trigger a rerun for this resource. */ forceUpdateRecommender(recommenderId: string): Promise; /** * Get details on a specific recommender * Retrieve a recommender */ getRecommenderRaw(requestParameters: GetRecommenderRequest): Promise>; /** * Get details on a specific recommender * Retrieve a recommender */ getRecommender(recommenderId: string): Promise; /** * Get details on a specific recommender\'s analysis report on model performance, bias, etc. * Retrieve a recommenders\'s analysis */ getRecommenderAnalysisRaw(requestParameters: GetRecommenderAnalysisRequest): Promise>; /** * Get details on a specific recommender\'s analysis report on model performance, bias, etc. * Retrieve a recommenders\'s analysis */ getRecommenderAnalysis(recommenderId: string): Promise; /** * Get a list of recommenders defined on the account * List recommenders */ getRecommendersRaw(requestParameters: GetRecommendersRequest): Promise>>; /** * Get a list of recommenders defined on the account * List recommenders */ getRecommenders(ids?: Array): Promise>; /** * Unarchive a recommender * Unarchive a recommender */ unarchiveRecommenderRaw(requestParameters: UnarchiveRecommenderRequest): Promise>; /** * Unarchive a recommender * Unarchive a recommender */ unarchiveRecommender(recommenderId: string, archiveConfig: ArchiveConfig): Promise; /** * Edit configuration of a recommender * Edit a recommender */ updateRecommenderRaw(requestParameters: UpdateRecommenderRequest): Promise>; /** * Edit configuration of a recommender * Edit a recommender */ updateRecommender(recommenderId: string, recommenderFields: RecommenderMergePatch): Promise; }