/** * 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, Stream, StreamAnalysis, StreamMergePatch } from '../models'; export interface ArchiveStreamRequest { streamIdOrName: string; archiveConfig: ArchiveConfig; } export interface DeleteStreamRequest { streamIdOrName: string; } export interface FindOrCreateStreamRequest { streamName: string; } export interface ForceUpdateStreamRequest { streamIdOrName: string; } export interface GetStreamRequest { streamIdOrName: string; } export interface GetStreamAnalysisRequest { streamIdOrName: string; } export interface GetStreamsRequest { ids?: Array; } export interface UnarchiveStreamRequest { streamIdOrName: string; archiveConfig: ArchiveConfig; } export interface UpdateStreamRequest { streamIdOrName: string; streamFields: StreamMergePatch; } /** * */ export declare class StreamsApi extends runtime.BaseAPI { /** * Archive a stream * Archive a stream */ archiveStreamRaw(requestParameters: ArchiveStreamRequest): Promise>; /** * Archive a stream * Archive a stream */ archiveStream(streamIdOrName: string, archiveConfig: ArchiveConfig): Promise; /** * Delete a stream */ deleteStreamRaw(requestParameters: DeleteStreamRequest): Promise>; /** * Delete a stream */ deleteStream(streamIdOrName: string): Promise; /** * Look up (or create) an event stream by name. * Create a stream */ findOrCreateStreamRaw(requestParameters: FindOrCreateStreamRequest): Promise>; /** * Look up (or create) an event stream by name. * Create a stream */ findOrCreateStream(streamName: 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. */ forceUpdateStreamRaw(requestParameters: ForceUpdateStreamRequest): 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. */ forceUpdateStream(streamIdOrName: string): Promise; /** * Look up a specific event stream. * Retrieve a stream */ getStreamRaw(requestParameters: GetStreamRequest): Promise>; /** * Look up a specific event stream. * Retrieve a stream */ getStream(streamIdOrName: string): Promise; /** * Get the count of stream events emitted over a time period. */ getStreamAnalysisRaw(requestParameters: GetStreamAnalysisRequest): Promise>; /** * Get the count of stream events emitted over a time period. */ getStreamAnalysis(streamIdOrName: string): Promise; /** * List all streams present on the account * List streams */ getStreamsRaw(requestParameters: GetStreamsRequest): Promise>>; /** * List all streams present on the account * List streams */ getStreams(ids?: Array): Promise>; /** * Unarchive a stream * Unarchive a stream */ unarchiveStreamRaw(requestParameters: UnarchiveStreamRequest): Promise>; /** * Unarchive a stream * Unarchive a stream */ unarchiveStream(streamIdOrName: string, archiveConfig: ArchiveConfig): Promise; /** * Update the configuration of a stream * Update a stream */ updateStreamRaw(requestParameters: UpdateStreamRequest): Promise>; /** * Update the configuration of a stream * Update a stream */ updateStream(streamIdOrName: string, streamFields: StreamMergePatch): Promise; }