/** * 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, InlineResponse200, Target, TargetAnalysis, TargetLookupRequest, TargetLookupResponse, TargetMergePatch, TargetPost } from '../models'; export interface ArchiveTargetRequest { targetId: string; archiveConfig: ArchiveConfig; } export interface CreateTargetRequest { targetFields: TargetPost; } export interface CreateTargetPreviewRequest { targetId: string; } export interface DeleteTargetRequest { targetId: string; } export interface DownloadTargetRequest { targetId: string; } export interface ForceUpdateTargetRequest { targetId: string; } export interface GetTargetRequest { targetId: string; } export interface GetTargetAnalysisRequest { targetId: string; } export interface GetTargetAnalysisReportRequest { targetId: string; } export interface GetTargetsRequest { ids?: Array; } export interface LookupOnTargetRequest { targetId: string; targetLookupRequest: TargetLookupRequest; } export interface UnarchiveTargetRequest { targetId: string; archiveConfig: ArchiveConfig; } export interface UpdateTargetRequest { targetId: string; targetMergePatch: TargetMergePatch; } /** * */ export declare class TargetsApi extends runtime.BaseAPI { /** * Archive a target * Archive a target */ archiveTargetRaw(requestParameters: ArchiveTargetRequest): Promise>; /** * Archive a target * Archive a target */ archiveTarget(targetId: string, archiveConfig: ArchiveConfig): Promise; /** * Add a new target. Targets are configuration for exporting data from Faraday, possibly to an external environment (with /connections). There are three types of targets:
Target typeDescriptionAPI requirement
PublicationFaraday hosts your predictions for convenient retrieval as needed.Specify a type of hosted_csv in options. Omit connection_id.
ReplicationFaraday copies your predictions to systems you control. You may then push them to third parties like Facebook, Google Ads, etc.Specify a valid connection_id and the corresponding type of the connection in options.
ManagedFaraday manages a push to third parties like Facebook, Google Ads, and more.Must be on an enterprise plan. Contact Customer Success to set up.
* Create target */ createTargetRaw(requestParameters: CreateTargetRequest): Promise>; /** * Add a new target. Targets are configuration for exporting data from Faraday, possibly to an external environment (with /connections). There are three types of targets:
Target typeDescriptionAPI requirement
PublicationFaraday hosts your predictions for convenient retrieval as needed.Specify a type of hosted_csv in options. Omit connection_id.
ReplicationFaraday copies your predictions to systems you control. You may then push them to third parties like Facebook, Google Ads, etc.Specify a valid connection_id and the corresponding type of the connection in options.
ManagedFaraday manages a push to third parties like Facebook, Google Ads, and more.Must be on an enterprise plan. Contact Customer Success to set up.
* Create target */ createTarget(targetFields: TargetPost): Promise; /** * Trigger a preview delivery (first 1000 results) of a target * Start a preview delivery */ createTargetPreviewRaw(requestParameters: CreateTargetPreviewRequest): Promise>; /** * Trigger a preview delivery (first 1000 results) of a target * Start a preview delivery */ createTargetPreview(targetId: string): Promise; /** * Delete a target * Delete a target */ deleteTargetRaw(requestParameters: DeleteTargetRequest): Promise>; /** * Delete a target * Delete a target */ deleteTarget(targetId: string): Promise; /** * Download the default output of a target */ downloadTargetRaw(requestParameters: DownloadTargetRequest): Promise>; /** * Download the default output of a target */ downloadTarget(targetId: 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. */ forceUpdateTargetRaw(requestParameters: ForceUpdateTargetRequest): 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. */ forceUpdateTarget(targetId: string): Promise; /** * Get details on a specific target * Retrieve a target */ getTargetRaw(requestParameters: GetTargetRequest): Promise>; /** * Get details on a specific target * Retrieve a target */ getTarget(targetId: string): Promise; /** * Get details on a target\'s analysis report for specific trait, attribute, and/or geography dimensions. * Retrieve a target\'s analysis */ getTargetAnalysisRaw(requestParameters: GetTargetAnalysisRequest): Promise>; /** * Get details on a target\'s analysis report for specific trait, attribute, and/or geography dimensions. * Retrieve a target\'s analysis */ getTargetAnalysis(targetId: string): Promise; /** * Gets a redirect URL to download a PDF report. * Retrieve target analysis report */ getTargetAnalysisReportRaw(requestParameters: GetTargetAnalysisReportRequest): Promise>; /** * Gets a redirect URL to download a PDF report. * Retrieve target analysis report */ getTargetAnalysisReport(targetId: string): Promise; /** * Get a list of targets defined on the account * List targets */ getTargetsRaw(requestParameters: GetTargetsRequest): Promise>>; /** * Get a list of targets defined on the account * List targets */ getTargets(ids?: Array): Promise>; /** * Use either PII or a spatial aggregate to retrieve the payload of a Lookup API target. See the Lookup API specification\'s [quickstart](https://faraday.ai/docs/features/lookup-api#retrieve-predictions) for more details, including examples. * Perform a lookup on the target, if its type is Lookup API. */ lookupOnTargetRaw(requestParameters: LookupOnTargetRequest): Promise>; /** * Use either PII or a spatial aggregate to retrieve the payload of a Lookup API target. See the Lookup API specification\'s [quickstart](https://faraday.ai/docs/features/lookup-api#retrieve-predictions) for more details, including examples. * Perform a lookup on the target, if its type is Lookup API. */ lookupOnTarget(targetId: string, targetLookupRequest: TargetLookupRequest): Promise; /** * Unarchive a target * Unarchive a target */ unarchiveTargetRaw(requestParameters: UnarchiveTargetRequest): Promise>; /** * Unarchive a target * Unarchive a target */ unarchiveTarget(targetId: string, archiveConfig: ArchiveConfig): Promise; /** * Update the configuration of a target. * Update a target */ updateTargetRaw(requestParameters: UpdateTargetRequest): Promise>; /** * Update the configuration of a target. * Update a target */ updateTarget(targetId: string, targetMergePatch: TargetMergePatch): Promise; }