/** * 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 { AnalysisDimensionsTrait, ArchiveConfig, Trait, TraitMergePatch, TraitPost } from '../models'; export interface ArchiveTraitRequest { traitId: string; archiveConfig: ArchiveConfig; } export interface CreateTraitRequest { traitFields: TraitPost; } export interface DeleteTraitRequest { traitId: string; } export interface ForceUpdateTraitRequest { traitId: string; } export interface GetTraitRequest { traitId: string; } export interface GetTraitAnalysisDimensionsRequest { traitId: string; } export interface GetTraitsRequest { ids?: Array; } export interface UnarchiveTraitRequest { traitId: string; archiveConfig: ArchiveConfig; } export interface UpdateTraitRequest { traitId: string; traitMergePatch: TraitMergePatch; } /** * */ export declare class TraitsApi extends runtime.BaseAPI { /** * Archive a trait * Archive a trait */ archiveTraitRaw(requestParameters: ArchiveTraitRequest): Promise>; /** * Archive a trait * Archive a trait */ archiveTrait(traitId: string, archiveConfig: ArchiveConfig): Promise; /** * Create a new user-defined Trait. You can connect your uploaded data to this trait by sending a PATCH to the relevant dataset with `output_to_traits` defined. * Create a Trait */ createTraitRaw(requestParameters: CreateTraitRequest): Promise>; /** * Create a new user-defined Trait. You can connect your uploaded data to this trait by sending a PATCH to the relevant dataset with `output_to_traits` defined. * Create a Trait */ createTrait(traitFields: TraitPost): Promise; /** * Delete all traits without a source dataset. * Delete all orphaned traits */ deleteAllOrphanedTraitsRaw(): Promise>; /** * Delete all traits without a source dataset. * Delete all orphaned traits */ deleteAllOrphanedTraits(): Promise; /** * Delete a trait * Delete a trait */ deleteTraitRaw(requestParameters: DeleteTraitRequest): Promise>; /** * Delete a trait * Delete a trait */ deleteTrait(traitId: 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. */ forceUpdateTraitRaw(requestParameters: ForceUpdateTraitRequest): 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. */ forceUpdateTrait(traitId: string): Promise; /** * Get a specific trait by ID. * Get a specific trait */ getTraitRaw(requestParameters: GetTraitRequest): Promise>; /** * Get a specific trait by ID. * Get a specific trait */ getTrait(traitId: string): Promise; /** * The percentage of the US population that falls into each category of this trait. */ getTraitAnalysisDimensionsRaw(requestParameters: GetTraitAnalysisDimensionsRequest): Promise>; /** * The percentage of the US population that falls into each category of this trait. */ getTraitAnalysisDimensions(traitId: string): Promise; /** * Get a list of all available traits, including those provided by Faraday and those defined by the user. * List all user-defined and Faraday-provided traits */ getTraitsRaw(requestParameters: GetTraitsRequest): Promise>>; /** * Get a list of all available traits, including those provided by Faraday and those defined by the user. * List all user-defined and Faraday-provided traits */ getTraits(ids?: Array): Promise>; /** * Get a csv of all available traits, including those provided by Faraday and those defined by the user. * List all user-defined and Faraday-provided traits, in csv form */ getTraitsCsvRaw(): Promise>; /** * Get a csv of all available traits, including those provided by Faraday and those defined by the user. * List all user-defined and Faraday-provided traits, in csv form */ getTraitsCsv(): Promise; /** * Unarchive a trait * Unarchive a trait */ unarchiveTraitRaw(requestParameters: UnarchiveTraitRequest): Promise>; /** * Unarchive a trait * Unarchive a trait */ unarchiveTrait(traitId: string, archiveConfig: ArchiveConfig): Promise; /** * Update the configuration of a trait * Update a trait */ updateTraitRaw(requestParameters: UpdateTraitRequest): Promise>; /** * Update the configuration of a trait * Update a trait */ updateTrait(traitId: string, traitMergePatch: TraitMergePatch): Promise; }