/**
 * 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, Dataset, Outcome, PersonaSet, Recommender, Scope, ScopeAnalysis, ScopeEfficacy, ScopeGeography, ScopeMergePatch, ScopePost, Target } from '../models';
export interface ArchiveScopeRequest {
    scopeId: string;
    archiveConfig: ArchiveConfig;
}
export interface CreateScopeRequest {
    scopeFields: ScopePost;
}
export interface DeleteScopeRequest {
    scopeId: string;
}
export interface ForceUpdateScopeRequest {
    scopeId: string;
}
export interface GetScopeRequest {
    scopeId: string;
}
export interface GetScopeAnalysisRequest {
    scopeId: string;
}
export interface GetScopeDatasetsRequest {
    scopeId: string;
}
export interface GetScopeEfficacyRequest {
    scopeId: string;
}
export interface GetScopeGeographyRequest {
    scopeId: string;
}
export interface GetScopePayloadCohortsRequest {
    scopeId: string;
}
export interface GetScopePayloadOutcomesRequest {
    scopeId: string;
}
export interface GetScopePayloadPersonaSetsRequest {
    scopeId: string;
}
export interface GetScopePayloadRecommendersRequest {
    scopeId: string;
}
export interface GetScopePopulationCohortsRequest {
    scopeId: string;
}
export interface GetScopePopulationExclusionAddressLevelCohortsRequest {
    scopeId: string;
}
export interface GetScopePopulationExclusionCohortsRequest {
    scopeId: string;
}
export interface GetScopeTargetsRequest {
    scopeId: string;
}
export interface GetScopesRequest {
    ids?: Array<string>;
}
export interface UnarchiveScopeRequest {
    scopeId: string;
    archiveConfig: ArchiveConfig;
}
export interface UpdateScopeRequest {
    scopeId: string;
    scopeMergePatch: ScopeMergePatch;
}
/**
 *
 */
export declare class ScopesApi extends runtime.BaseAPI {
    /**
     * Archive a scope
     * Archive a scope
     */
    archiveScopeRaw(requestParameters: ArchiveScopeRequest): Promise<runtime.ApiResponse<void>>;
    /**
     * Archive a scope
     * Archive a scope
     */
    archiveScope(scopeId: string, archiveConfig: ArchiveConfig): Promise<void>;
    /**
     * Add a new scope
     * Create scope
     */
    createScopeRaw(requestParameters: CreateScopeRequest): Promise<runtime.ApiResponse<Scope>>;
    /**
     * Add a new scope
     * Create scope
     */
    createScope(scopeFields: ScopePost): Promise<Scope>;
    /**
     * Delete a scope
     */
    deleteScopeRaw(requestParameters: DeleteScopeRequest): Promise<runtime.ApiResponse<void>>;
    /**
     * Delete a scope
     */
    deleteScope(scopeId: string): Promise<void>;
    /**
     * 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.
     */
    forceUpdateScopeRaw(requestParameters: ForceUpdateScopeRequest): Promise<runtime.ApiResponse<void>>;
    /**
     * 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.
     */
    forceUpdateScope(scopeId: string): Promise<void>;
    /**
     * Get details on a specific scope
     * Retrieve a scope
     */
    getScopeRaw(requestParameters: GetScopeRequest): Promise<runtime.ApiResponse<Scope>>;
    /**
     * Get details on a specific scope
     * Retrieve a scope
     */
    getScope(scopeId: string): Promise<Scope>;
    /**
     * Get analysis for a scope
     * Get analysis for a scope
     */
    getScopeAnalysisRaw(requestParameters: GetScopeAnalysisRequest): Promise<runtime.ApiResponse<ScopeAnalysis>>;
    /**
     * Get analysis for a scope
     * Get analysis for a scope
     */
    getScopeAnalysis(scopeId: string): Promise<ScopeAnalysis>;
    /**
     * Retrieve all datasets associated with a scope. For example, if your scope has population_cohorts, you built those cohorts using data from one of your datasets. This endpoint gets all such datasets. This can be used with referenced targets, to figure out which source tables the target can reference.
     * Retrieve all datasets associated with a scope
     */
    getScopeDatasetsRaw(requestParameters: GetScopeDatasetsRequest): Promise<runtime.ApiResponse<Array<Dataset>>>;
    /**
     * Retrieve all datasets associated with a scope. For example, if your scope has population_cohorts, you built those cohorts using data from one of your datasets. This endpoint gets all such datasets. This can be used with referenced targets, to figure out which source tables the target can reference.
     * Retrieve all datasets associated with a scope
     */
    getScopeDatasets(scopeId: string): Promise<Array<Dataset>>;
    /**
     * Get efficacy for a scope
     * Get efficacy for a scope
     */
    getScopeEfficacyRaw(requestParameters: GetScopeEfficacyRequest): Promise<runtime.ApiResponse<ScopeEfficacy>>;
    /**
     * Get efficacy for a scope
     * Get efficacy for a scope
     */
    getScopeEfficacy(scopeId: string): Promise<ScopeEfficacy>;
    /**
     * Get a postcode- and state-level breakdown of the scope population, including per-payload-cohort counts. `postcodes` may be omitted when the scope spans more than 250 distinct postcodes (the UI distribution table saturates at that point); `states` is always present.
     * Get geographic breakdown for a scope
     */
    getScopeGeographyRaw(requestParameters: GetScopeGeographyRequest): Promise<runtime.ApiResponse<ScopeGeography>>;
    /**
     * Get a postcode- and state-level breakdown of the scope population, including per-payload-cohort counts. `postcodes` may be omitted when the scope spans more than 250 distinct postcodes (the UI distribution table saturates at that point); `states` is always present.
     * Get geographic breakdown for a scope
     */
    getScopeGeography(scopeId: string): Promise<ScopeGeography>;
    /**
     * Get payload cohorts for a scope
     * Get payload cohorts for a scope
     */
    getScopePayloadCohortsRaw(requestParameters: GetScopePayloadCohortsRequest): Promise<runtime.ApiResponse<Array<Cohort>>>;
    /**
     * Get payload cohorts for a scope
     * Get payload cohorts for a scope
     */
    getScopePayloadCohorts(scopeId: string): Promise<Array<Cohort>>;
    /**
     * Get payload outcomes for a scope
     * Get payload outcomes for a scope
     */
    getScopePayloadOutcomesRaw(requestParameters: GetScopePayloadOutcomesRequest): Promise<runtime.ApiResponse<Array<Outcome>>>;
    /**
     * Get payload outcomes for a scope
     * Get payload outcomes for a scope
     */
    getScopePayloadOutcomes(scopeId: string): Promise<Array<Outcome>>;
    /**
     * Get payload persona sets for a scope
     * Get payload persona sets for a scope
     */
    getScopePayloadPersonaSetsRaw(requestParameters: GetScopePayloadPersonaSetsRequest): Promise<runtime.ApiResponse<Array<PersonaSet>>>;
    /**
     * Get payload persona sets for a scope
     * Get payload persona sets for a scope
     */
    getScopePayloadPersonaSets(scopeId: string): Promise<Array<PersonaSet>>;
    /**
     * Get payload recommenders for a scope
     * Get payload recommenders for a scope
     */
    getScopePayloadRecommendersRaw(requestParameters: GetScopePayloadRecommendersRequest): Promise<runtime.ApiResponse<Array<Recommender>>>;
    /**
     * Get payload recommenders for a scope
     * Get payload recommenders for a scope
     */
    getScopePayloadRecommenders(scopeId: string): Promise<Array<Recommender>>;
    /**
     * Get population cohorts for a scope
     * Get population cohorts for a scope
     */
    getScopePopulationCohortsRaw(requestParameters: GetScopePopulationCohortsRequest): Promise<runtime.ApiResponse<Array<Cohort>>>;
    /**
     * Get population cohorts for a scope
     * Get population cohorts for a scope
     */
    getScopePopulationCohorts(scopeId: string): Promise<Array<Cohort>>;
    /**
     * Get address-level population exclusion cohorts for a scope
     * Get address-level population exclusion cohorts for a scope
     */
    getScopePopulationExclusionAddressLevelCohortsRaw(requestParameters: GetScopePopulationExclusionAddressLevelCohortsRequest): Promise<runtime.ApiResponse<Array<Cohort>>>;
    /**
     * Get address-level population exclusion cohorts for a scope
     * Get address-level population exclusion cohorts for a scope
     */
    getScopePopulationExclusionAddressLevelCohorts(scopeId: string): Promise<Array<Cohort>>;
    /**
     * Get population exclusion cohorts for a scope
     * Get population exclusion cohorts for a scope
     */
    getScopePopulationExclusionCohortsRaw(requestParameters: GetScopePopulationExclusionCohortsRequest): Promise<runtime.ApiResponse<Array<Cohort>>>;
    /**
     * Get population exclusion cohorts for a scope
     * Get population exclusion cohorts for a scope
     */
    getScopePopulationExclusionCohorts(scopeId: string): Promise<Array<Cohort>>;
    /**
     * Get targets for a scope
     * Get targets for a scope
     */
    getScopeTargetsRaw(requestParameters: GetScopeTargetsRequest): Promise<runtime.ApiResponse<Array<Target>>>;
    /**
     * Get targets for a scope
     * Get targets for a scope
     */
    getScopeTargets(scopeId: string): Promise<Array<Target>>;
    /**
     * Get a list of scopes defined on the account
     * List scopes
     */
    getScopesRaw(requestParameters: GetScopesRequest): Promise<runtime.ApiResponse<Array<Scope>>>;
    /**
     * Get a list of scopes defined on the account
     * List scopes
     */
    getScopes(ids?: Array<string>): Promise<Array<Scope>>;
    /**
     * Unarchive a scope
     * Unarchive a scope
     */
    unarchiveScopeRaw(requestParameters: UnarchiveScopeRequest): Promise<runtime.ApiResponse<void>>;
    /**
     * Unarchive a scope
     * Unarchive a scope
     */
    unarchiveScope(scopeId: string, archiveConfig: ArchiveConfig): Promise<void>;
    /**
     * Update the configuration of a scope.
     * Update a scope
     */
    updateScopeRaw(requestParameters: UpdateScopeRequest): Promise<runtime.ApiResponse<Scope>>;
    /**
     * Update the configuration of a scope.
     * Update a scope
     */
    updateScope(scopeId: string, scopeMergePatch: ScopeMergePatch): Promise<Scope>;
}