@vectorize-io/vectorize-client/dist/apis/ConnectorsApi.d.ts

Client for the Vectorize API

/**
 * Vectorize API (Beta)
 * API for Vectorize services
 *
 * The version of the OpenAPI document: 0.0.1
 *
 *
 * 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 type { AIPlatform, AddUserFromSourceConnectorResponse, AddUserToSourceConnectorRequest, CreateAIPlatformConnector, CreateAIPlatformConnectorResponse, CreateDestinationConnector, CreateDestinationConnectorResponse, CreateSourceConnector, CreateSourceConnectorResponse, DeleteAIPlatformConnectorResponse, DeleteDestinationConnectorResponse, DeleteSourceConnectorResponse, DestinationConnector, GetAIPlatformConnectors200Response, GetDestinationConnectors200Response, GetSourceConnectors200Response, RemoveUserFromSourceConnectorRequest, RemoveUserFromSourceConnectorResponse, SourceConnector, UpdateAIPlatformConnectorRequest, UpdateAIPlatformConnectorResponse, UpdateDestinationConnectorRequest, UpdateDestinationConnectorResponse, UpdateSourceConnectorRequest, UpdateSourceConnectorResponse, UpdateUserInSourceConnectorRequest, UpdateUserInSourceConnectorResponse } from '../models/index';
export interface AddUserToSourceConnectorOperationRequest {
    organization: string;
    sourceConnectorId: string;
    addUserToSourceConnectorRequest: AddUserToSourceConnectorRequest;
}
export interface CreateAIPlatformConnectorRequest {
    organization: string;
    createAIPlatformConnector: Array<CreateAIPlatformConnector>;
}
export interface CreateDestinationConnectorRequest {
    organization: string;
    createDestinationConnector: Array<CreateDestinationConnector>;
}
export interface CreateSourceConnectorRequest {
    organization: string;
    createSourceConnector: Array<CreateSourceConnector>;
}
export interface DeleteAIPlatformRequest {
    organization: string;
    aiplatformId: string;
}
export interface DeleteDestinationConnectorRequest {
    organization: string;
    destinationConnectorId: string;
}
export interface DeleteSourceConnectorRequest {
    organization: string;
    sourceConnectorId: string;
}
export interface DeleteUserFromSourceConnectorRequest {
    organization: string;
    sourceConnectorId: string;
    removeUserFromSourceConnectorRequest: RemoveUserFromSourceConnectorRequest;
}
export interface GetAIPlatformConnectorRequest {
    organization: string;
    aiplatformId: string;
}
export interface GetAIPlatformConnectorsRequest {
    organization: string;
}
export interface GetDestinationConnectorRequest {
    organization: string;
    destinationConnectorId: string;
}
export interface GetDestinationConnectorsRequest {
    organization: string;
}
export interface GetSourceConnectorRequest {
    organization: string;
    sourceConnectorId: string;
}
export interface GetSourceConnectorsRequest {
    organization: string;
}
export interface UpdateAIPlatformConnectorOperationRequest {
    organization: string;
    aiplatformId: string;
    updateAIPlatformConnectorRequest: UpdateAIPlatformConnectorRequest;
}
export interface UpdateDestinationConnectorOperationRequest {
    organization: string;
    destinationConnectorId: string;
    updateDestinationConnectorRequest: UpdateDestinationConnectorRequest;
}
export interface UpdateSourceConnectorOperationRequest {
    organization: string;
    sourceConnectorId: string;
    updateSourceConnectorRequest: UpdateSourceConnectorRequest;
}
export interface UpdateUserInSourceConnectorOperationRequest {
    organization: string;
    sourceConnectorId: string;
    updateUserInSourceConnectorRequest: UpdateUserInSourceConnectorRequest;
}
/**
 *
 */
export declare class ConnectorsApi extends runtime.BaseAPI {
    /**
     * Add a user to a source connector
     */
    addUserToSourceConnectorRaw(requestParameters: AddUserToSourceConnectorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddUserFromSourceConnectorResponse>>;
    /**
     * Add a user to a source connector
     */
    addUserToSourceConnector(requestParameters: AddUserToSourceConnectorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddUserFromSourceConnectorResponse>;
    /**
     * Create a new AI Platform connector. Config values: Amazon Bedrock (BEDROCK):  Name (name): text, Access Key (access-key): text, Secret Key (key): text) | Google Vertex AI (VERTEX):  Name (name): text, Service Account Json (key): textarea, Region (region): text) | OpenAI (OPENAI):  Name (name): text, API Key (key): text) | Voyage AI (VOYAGE):  Name (name): text, API Key (key): text) | Built-in (VECTORIZE):  )
     */
    createAIPlatformConnectorRaw(requestParameters: CreateAIPlatformConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAIPlatformConnectorResponse>>;
    /**
     * Create a new AI Platform connector. Config values: Amazon Bedrock (BEDROCK):  Name (name): text, Access Key (access-key): text, Secret Key (key): text) | Google Vertex AI (VERTEX):  Name (name): text, Service Account Json (key): textarea, Region (region): text) | OpenAI (OPENAI):  Name (name): text, API Key (key): text) | Voyage AI (VOYAGE):  Name (name): text, API Key (key): text) | Built-in (VECTORIZE):  )
     */
    createAIPlatformConnector(requestParameters: CreateAIPlatformConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAIPlatformConnectorResponse>;
    /**
     * Create a new destination connector. Config values: Couchbase Capella (CAPELLA):  Name (name): text, Cluster Access Name (username): text, Cluster Access Password (password): text, Connection String (connection-string): text) | DataStax Astra (DATASTAX):  Name (name): text, API Endpoint (endpoint_secret): text, Application Token (token): text) | Elasticsearch (ELASTIC):  Name (name): text, Host (host): text, Port (port): text, API Key (api-key): text) | Pinecone (PINECONE):  Name (name): text, API Key (api-key): text) | SingleStore (SINGLESTORE):  Name (name): text, Host (host): text, Port (port): number, Database (database): text, Username (username): text, Password (password): text) | Milvus (MILVUS):  Name (name): text, Public Endpoint (url): text, Token (token): text, Username (username): text, Password (password): text) | PostgreSQL (POSTGRESQL):  Name (name): text, Host (host): text, Port (port): number, Database (database): text, Username (username): text, Password (password): text) | Qdrant (QDRANT):  Name (name): text, Host (host): text, API Key (api-key): text) | Supabase (SUPABASE):  Name (name): text, Host (host): text, Port (port): number, Database (database): text, Username (username): text, Password (password): text) | Weaviate (WEAVIATE):  Name (name): text, Endpoint (host): text, API Key (api-key): text) | Azure AI Search (AZUREAISEARCH):  Name (name): text, Azure AI Search Service Name (service-name): text, API Key (api-key): text) | Built-in (VECTORIZE):  ) | Chroma (CHROMA):  Name (name): text, API Key (apiKey): text) | MongoDB (MONGODB):  Name (name): text, API Key (apiKey): text)
     */
    createDestinationConnectorRaw(requestParameters: CreateDestinationConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateDestinationConnectorResponse>>;
    /**
     * Create a new destination connector. Config values: Couchbase Capella (CAPELLA):  Name (name): text, Cluster Access Name (username): text, Cluster Access Password (password): text, Connection String (connection-string): text) | DataStax Astra (DATASTAX):  Name (name): text, API Endpoint (endpoint_secret): text, Application Token (token): text) | Elasticsearch (ELASTIC):  Name (name): text, Host (host): text, Port (port): text, API Key (api-key): text) | Pinecone (PINECONE):  Name (name): text, API Key (api-key): text) | SingleStore (SINGLESTORE):  Name (name): text, Host (host): text, Port (port): number, Database (database): text, Username (username): text, Password (password): text) | Milvus (MILVUS):  Name (name): text, Public Endpoint (url): text, Token (token): text, Username (username): text, Password (password): text) | PostgreSQL (POSTGRESQL):  Name (name): text, Host (host): text, Port (port): number, Database (database): text, Username (username): text, Password (password): text) | Qdrant (QDRANT):  Name (name): text, Host (host): text, API Key (api-key): text) | Supabase (SUPABASE):  Name (name): text, Host (host): text, Port (port): number, Database (database): text, Username (username): text, Password (password): text) | Weaviate (WEAVIATE):  Name (name): text, Endpoint (host): text, API Key (api-key): text) | Azure AI Search (AZUREAISEARCH):  Name (name): text, Azure AI Search Service Name (service-name): text, API Key (api-key): text) | Built-in (VECTORIZE):  ) | Chroma (CHROMA):  Name (name): text, API Key (apiKey): text) | MongoDB (MONGODB):  Name (name): text, API Key (apiKey): text)
     */
    createDestinationConnector(requestParameters: CreateDestinationConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateDestinationConnectorResponse>;
    /**
     * Create a new source connector. Config values: Amazon S3 (AWS_S3):  Name (name): text, Access Key (access-key): text, Secret Key (secret-key): text, Bucket Name (bucket-name): text, Endpoint (endpoint): url, Region (region): text, Allow as archive destination (archiver): boolean) | Azure Blob Storage (AZURE_BLOB):  Name (name): text, Storage Account Name (storage-account-name): text, Storage Account Key (storage-account-key): text, Container (container): text, Endpoint (endpoint): url) | Confluence (CONFLUENCE):  Name (name): text, Username (username): text, API Token (api-token): text, Domain (domain): text) | Discord (DISCORD):  Name (name): text, Server ID (guild-id): text, Bot token (bot-token): text, Channel ID (channel-ids): array oftext) | Dropbox (DROPBOX):  Name (name): text) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH):  Name (name): text) | Google Drive (Service Account) (GOOGLE_DRIVE):  Name (name): text, Service Account JSON (service-account-json): textarea) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI):  Name (name): text) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM):  Name (name): text, OAuth2 Client Id (oauth2-client-id): text, OAuth2 Client Secret (oauth2-client-secret): text) | Firecrawl (FIRECRAWL):  Name (name): text, API Key (api-key): text) | GCP Cloud Storage (GCS):  Name (name): text, Service Account JSON (service-account-json): textarea, Bucket (bucket-name): text) | Intercom (INTERCOM):  Name (name): text, Access Token (intercomAccessToken): text) | OneDrive (ONE_DRIVE):  Name (name): text, Client Id (ms-client-id): text, Tenant Id (ms-tenant-id): text, Client Secret (ms-client-secret): text, Users (users): array oftext) | SharePoint (SHAREPOINT):  Name (name): text, Client Id (ms-client-id): text, Tenant Id (ms-tenant-id): text, Client Secret (ms-client-secret): text) | Web Crawler (WEB_CRAWLER):  Name (name): text, Seed URL(s) (seed-urls): array ofurl) | File Upload (FILE_UPLOAD):  Name (name): text)
     */
    createSourceConnectorRaw(requestParameters: CreateSourceConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateSourceConnectorResponse>>;
    /**
     * Create a new source connector. Config values: Amazon S3 (AWS_S3):  Name (name): text, Access Key (access-key): text, Secret Key (secret-key): text, Bucket Name (bucket-name): text, Endpoint (endpoint): url, Region (region): text, Allow as archive destination (archiver): boolean) | Azure Blob Storage (AZURE_BLOB):  Name (name): text, Storage Account Name (storage-account-name): text, Storage Account Key (storage-account-key): text, Container (container): text, Endpoint (endpoint): url) | Confluence (CONFLUENCE):  Name (name): text, Username (username): text, API Token (api-token): text, Domain (domain): text) | Discord (DISCORD):  Name (name): text, Server ID (guild-id): text, Bot token (bot-token): text, Channel ID (channel-ids): array oftext) | Dropbox (DROPBOX):  Name (name): text) | Google Drive OAuth (GOOGLE_DRIVE_OAUTH):  Name (name): text) | Google Drive (Service Account) (GOOGLE_DRIVE):  Name (name): text, Service Account JSON (service-account-json): textarea) | Google Drive Multi-User (Vectorize) (GOOGLE_DRIVE_OAUTH_MULTI):  Name (name): text) | Google Drive Multi-User (White Label) (GOOGLE_DRIVE_OAUTH_MULTI_CUSTOM):  Name (name): text, OAuth2 Client Id (oauth2-client-id): text, OAuth2 Client Secret (oauth2-client-secret): text) | Firecrawl (FIRECRAWL):  Name (name): text, API Key (api-key): text) | GCP Cloud Storage (GCS):  Name (name): text, Service Account JSON (service-account-json): textarea, Bucket (bucket-name): text) | Intercom (INTERCOM):  Name (name): text, Access Token (intercomAccessToken): text) | OneDrive (ONE_DRIVE):  Name (name): text, Client Id (ms-client-id): text, Tenant Id (ms-tenant-id): text, Client Secret (ms-client-secret): text, Users (users): array oftext) | SharePoint (SHAREPOINT):  Name (name): text, Client Id (ms-client-id): text, Tenant Id (ms-tenant-id): text, Client Secret (ms-client-secret): text) | Web Crawler (WEB_CRAWLER):  Name (name): text, Seed URL(s) (seed-urls): array ofurl) | File Upload (FILE_UPLOAD):  Name (name): text)
     */
    createSourceConnector(requestParameters: CreateSourceConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateSourceConnectorResponse>;
    /**
     * Delete an AI platform connector
     */
    deleteAIPlatformRaw(requestParameters: DeleteAIPlatformRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteAIPlatformConnectorResponse>>;
    /**
     * Delete an AI platform connector
     */
    deleteAIPlatform(requestParameters: DeleteAIPlatformRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteAIPlatformConnectorResponse>;
    /**
     * Delete a destination connector
     */
    deleteDestinationConnectorRaw(requestParameters: DeleteDestinationConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteDestinationConnectorResponse>>;
    /**
     * Delete a destination connector
     */
    deleteDestinationConnector(requestParameters: DeleteDestinationConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteDestinationConnectorResponse>;
    /**
     * Delete a source connector
     */
    deleteSourceConnectorRaw(requestParameters: DeleteSourceConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteSourceConnectorResponse>>;
    /**
     * Delete a source connector
     */
    deleteSourceConnector(requestParameters: DeleteSourceConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteSourceConnectorResponse>;
    /**
     * Delete a source connector user
     */
    deleteUserFromSourceConnectorRaw(requestParameters: DeleteUserFromSourceConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RemoveUserFromSourceConnectorResponse>>;
    /**
     * Delete a source connector user
     */
    deleteUserFromSourceConnector(requestParameters: DeleteUserFromSourceConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RemoveUserFromSourceConnectorResponse>;
    /**
     * Get an AI platform connector
     */
    getAIPlatformConnectorRaw(requestParameters: GetAIPlatformConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AIPlatform>>;
    /**
     * Get an AI platform connector
     */
    getAIPlatformConnector(requestParameters: GetAIPlatformConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AIPlatform>;
    /**
     * Get all existing AI Platform connectors
     */
    getAIPlatformConnectorsRaw(requestParameters: GetAIPlatformConnectorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAIPlatformConnectors200Response>>;
    /**
     * Get all existing AI Platform connectors
     */
    getAIPlatformConnectors(requestParameters: GetAIPlatformConnectorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAIPlatformConnectors200Response>;
    /**
     * Get a destination connector
     */
    getDestinationConnectorRaw(requestParameters: GetDestinationConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DestinationConnector>>;
    /**
     * Get a destination connector
     */
    getDestinationConnector(requestParameters: GetDestinationConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DestinationConnector>;
    /**
     * Get all existing destination connectors
     */
    getDestinationConnectorsRaw(requestParameters: GetDestinationConnectorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDestinationConnectors200Response>>;
    /**
     * Get all existing destination connectors
     */
    getDestinationConnectors(requestParameters: GetDestinationConnectorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDestinationConnectors200Response>;
    /**
     * Get a source connector
     */
    getSourceConnectorRaw(requestParameters: GetSourceConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SourceConnector>>;
    /**
     * Get a source connector
     */
    getSourceConnector(requestParameters: GetSourceConnectorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SourceConnector>;
    /**
     * Get all existing source connectors
     */
    getSourceConnectorsRaw(requestParameters: GetSourceConnectorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSourceConnectors200Response>>;
    /**
     * Get all existing source connectors
     */
    getSourceConnectors(requestParameters: GetSourceConnectorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSourceConnectors200Response>;
    /**
     * Update an AI Platform connector
     */
    updateAIPlatformConnectorRaw(requestParameters: UpdateAIPlatformConnectorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateAIPlatformConnectorResponse>>;
    /**
     * Update an AI Platform connector
     */
    updateAIPlatformConnector(requestParameters: UpdateAIPlatformConnectorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateAIPlatformConnectorResponse>;
    /**
     * Update a destination connector
     */
    updateDestinationConnectorRaw(requestParameters: UpdateDestinationConnectorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateDestinationConnectorResponse>>;
    /**
     * Update a destination connector
     */
    updateDestinationConnector(requestParameters: UpdateDestinationConnectorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateDestinationConnectorResponse>;
    /**
     * Update a source connector
     */
    updateSourceConnectorRaw(requestParameters: UpdateSourceConnectorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateSourceConnectorResponse>>;
    /**
     * Update a source connector
     */
    updateSourceConnector(requestParameters: UpdateSourceConnectorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateSourceConnectorResponse>;
    /**
     * Update a source connector user
     */
    updateUserInSourceConnectorRaw(requestParameters: UpdateUserInSourceConnectorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateUserInSourceConnectorResponse>>;
    /**
     * Update a source connector user
     */
    updateUserInSourceConnector(requestParameters: UpdateUserInSourceConnectorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateUserInSourceConnectorResponse>;
}