/** * 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, Cohort, CohortAnalysisMembership, CohortMergePatch, CohortPost } from '../models'; export interface ArchiveCohortRequest { cohortId: string; archiveConfig: ArchiveConfig; } export interface CreateCohortRequest { cohortFields: CohortPost; } export interface DeleteCohortRequest { cohortId: string; } export interface ForceUpdateCohortRequest { cohortId: string; } export interface GetCohortRequest { cohortId: string; } export interface GetCohortAnalysisMembershipRequest { cohortId: string; } export interface GetCohortsRequest { ids?: Array; } export interface UnarchiveCohortRequest { cohortId: string; archiveConfig: ArchiveConfig; } export interface UpdateCohortRequest { cohortId: string; cohortFields: CohortMergePatch; } /** * */ export declare class CohortsApi extends runtime.BaseAPI { /** * Archive a cohort * Archive a cohort */ archiveCohortRaw(requestParameters: ArchiveCohortRequest): Promise>; /** * Archive a cohort * Archive a cohort */ archiveCohort(cohortId: string, archiveConfig: ArchiveConfig): Promise; /** * Add a new cohort (defined as people who have made qualifying emissions of certain events) * Create cohort */ createCohortRaw(requestParameters: CreateCohortRequest): Promise>; /** * Add a new cohort (defined as people who have made qualifying emissions of certain events) * Create cohort */ createCohort(cohortFields: CohortPost): Promise; /** * Delete a cohort */ deleteCohortRaw(requestParameters: DeleteCohortRequest): Promise>; /** * Delete a cohort */ deleteCohort(cohortId: 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. */ forceUpdateCohortRaw(requestParameters: ForceUpdateCohortRequest): 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. */ forceUpdateCohort(cohortId: string): Promise; /** * Get details on a specific cohort * Retrieve a cohort */ getCohortRaw(requestParameters: GetCohortRequest): Promise>; /** * Get details on a specific cohort * Retrieve a cohort */ getCohort(cohortId: string): Promise; /** * Get the cohort membership counts over time. */ getCohortAnalysisMembershipRaw(requestParameters: GetCohortAnalysisMembershipRequest): Promise>; /** * Get the cohort membership counts over time. */ getCohortAnalysisMembership(cohortId: string): Promise; /** * Get a list of cohorts defined on the account * List cohorts */ getCohortsRaw(requestParameters: GetCohortsRequest): Promise>>; /** * Get a list of cohorts defined on the account * List cohorts */ getCohorts(ids?: Array): Promise>; /** * Unarchive a cohort * Unarchive a cohort */ unarchiveCohortRaw(requestParameters: UnarchiveCohortRequest): Promise>; /** * Unarchive a cohort * Unarchive a cohort */ unarchiveCohort(cohortId: string, archiveConfig: ArchiveConfig): Promise; /** * Edit configuration of a cohort * Edit a cohort */ updateCohortRaw(requestParameters: UpdateCohortRequest): Promise>; /** * Edit configuration of a cohort * Edit a cohort */ updateCohort(cohortId: string, cohortFields: CohortMergePatch): Promise; }