Class SourceConnectorsApi

Hierarchy (View Summary)

BaseAPI
- SourceConnectorsApi

Constructors

constructor

new SourceConnectorsApi(configuration?: Configuration): SourceConnectorsApi
Parameters
- configuration: Configuration = DefaultConfig
Returns SourceConnectorsApi
Inherited from BaseAPI.constructor
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:97

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

addUserToSourceConnector

addUserToSourceConnector(
requestParameters: AddUserToSourceConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<AddUserFromSourceConnectorResponse>
Add a user to a source connector Add a user to a source connector
Parameters
- requestParameters: AddUserToSourceConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<AddUserFromSourceConnectorResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/SourceConnectorsApi.ts:169

addUserToSourceConnectorRaw

addUserToSourceConnectorRaw(
requestParameters: AddUserToSourceConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<AddUserFromSourceConnectorResponse>>
Add a user to a source connector Add a user to a source connector
Parameters
- requestParameters: AddUserToSourceConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<AddUserFromSourceConnectorResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/SourceConnectorsApi.ts:118

createSourceConnector

createSourceConnector(
requestParameters: CreateSourceConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<CreateSourceConnectorResponse>
Creates a new source connector for data ingestion. The specific configuration fields required depend on the connector type selected. Create a new source connector
Parameters
- requestParameters: CreateSourceConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<CreateSourceConnectorResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/SourceConnectorsApi.ts:226

createSourceConnectorRaw

createSourceConnectorRaw(
requestParameters: CreateSourceConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<CreateSourceConnectorResponse>>
Creates a new source connector for data ingestion. The specific configuration fields required depend on the connector type selected. Create a new source connector
Parameters
- requestParameters: CreateSourceConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<CreateSourceConnectorResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/SourceConnectorsApi.ts:178

deleteSourceConnector

deleteSourceConnector(
requestParameters: DeleteSourceConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<DeleteSourceConnectorResponse>
Delete a source connector Delete a source connector
Parameters
- requestParameters: DeleteSourceConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<DeleteSourceConnectorResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/SourceConnectorsApi.ts:276

getSourceConnector

getSourceConnector(
requestParameters: GetSourceConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<SourceConnector>
Get a source connector Get a source connector
Parameters
- requestParameters: GetSourceConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<SourceConnector>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/SourceConnectorsApi.ts:386

getSourceConnectorRaw

getSourceConnectorRaw(
requestParameters: GetSourceConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<SourceConnector>>
Get a source connector Get a source connector
Parameters
- requestParameters: GetSourceConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<SourceConnector>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/SourceConnectorsApi.ts:345

getSourceConnectors

getSourceConnectors(
requestParameters: GetSourceConnectorsRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<GetSourceConnectors200Response>
Get all existing source connectors Get all existing source connectors
Parameters
- requestParameters: GetSourceConnectorsRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<GetSourceConnectors200Response>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/SourceConnectorsApi.ts:433

getSourceConnectorsRaw

getSourceConnectorsRaw(
requestParameters: GetSourceConnectorsRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<GetSourceConnectors200Response>>
Get all existing source connectors Get all existing source connectors
Parameters
- requestParameters: GetSourceConnectorsRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<GetSourceConnectors200Response>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/SourceConnectorsApi.ts:395

`Protected`isJsonMime

isJsonMime(mime: string): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:127

`Protected`request

request(
context: RequestOpts,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<Response>
Parameters
- context: RequestOpts
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:134

updateSourceConnector

updateSourceConnector(
requestParameters: UpdateSourceConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<UpdateSourceConnectorResponse>
Update a source connector Update a source connector
Parameters
- requestParameters: UpdateSourceConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<UpdateSourceConnectorResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/SourceConnectorsApi.ts:493

updateSourceConnectorRaw

updateSourceConnectorRaw(
requestParameters: UpdateSourceConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<UpdateSourceConnectorResponse>>
Update a source connector Update a source connector
Parameters
- requestParameters: UpdateSourceConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<UpdateSourceConnectorResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/SourceConnectorsApi.ts:442

updateUserInSourceConnector

updateUserInSourceConnector(
requestParameters: UpdateUserInSourceConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<UpdateUserInSourceConnectorResponse>
Update a source connector user Update a source connector user
Parameters
- requestParameters: UpdateUserInSourceConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<UpdateUserInSourceConnectorResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/SourceConnectorsApi.ts:553

updateUserInSourceConnectorRaw

updateUserInSourceConnectorRaw(
requestParameters: UpdateUserInSourceConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<UpdateUserInSourceConnectorResponse>>
Update a source connector user Update a source connector user
Parameters
- requestParameters: UpdateUserInSourceConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<UpdateUserInSourceConnectorResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/SourceConnectorsApi.ts:502

withMiddleware

withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:101

withPostMiddleware

withPostMiddleware<T extends BaseAPI>(
    this: T,
    ...postMiddlewares: (
        (context: ResponseContext) => Promise<void | Response>
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:112

withPreMiddleware

withPreMiddleware<T extends BaseAPI>(
    this: T,
    ...preMiddlewares: (
        (context: RequestContext) => Promise<void | FetchParams>
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/runtime.ts:107

Class SourceConnectorsApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SourceConnectorsApi

Properties

Protectedconfiguration

Methods

addUserToSourceConnector

Parameters

Returns Promise<AddUserFromSourceConnectorResponse>

addUserToSourceConnectorRaw

Parameters

Returns Promise<ApiResponse<AddUserFromSourceConnectorResponse>>

createSourceConnector

Parameters

Returns Promise<CreateSourceConnectorResponse>

createSourceConnectorRaw

Parameters

Returns Promise<ApiResponse<CreateSourceConnectorResponse>>

deleteSourceConnector

Parameters

Returns Promise<DeleteSourceConnectorResponse>

deleteSourceConnectorRaw

Parameters

Returns Promise<ApiResponse<DeleteSourceConnectorResponse>>

deleteUserFromSourceConnector

Parameters

Returns Promise<RemoveUserFromSourceConnectorResponse>

deleteUserFromSourceConnectorRaw

Parameters

Returns Promise<ApiResponse<RemoveUserFromSourceConnectorResponse>>

getSourceConnector

Parameters

Returns Promise<SourceConnector>

getSourceConnectorRaw

Parameters

Returns Promise<ApiResponse<SourceConnector>>

getSourceConnectors

Parameters

Returns Promise<GetSourceConnectors200Response>

getSourceConnectorsRaw

Parameters

Returns Promise<ApiResponse<GetSourceConnectors200Response>>

ProtectedisJsonMime

Parameters

Returns boolean

Protectedrequest

Parameters

Returns Promise<Response>

updateSourceConnector

Parameters

Returns Promise<UpdateSourceConnectorResponse>

updateSourceConnectorRaw

Parameters

Returns Promise<ApiResponse<UpdateSourceConnectorResponse>>

updateUserInSourceConnector

Parameters

Returns Promise<UpdateUserInSourceConnectorResponse>

updateUserInSourceConnectorRaw

Parameters

Returns Promise<ApiResponse<UpdateUserInSourceConnectorResponse>>

withMiddleware

Type Parameters

Parameters

Returns T

withPostMiddleware

Type Parameters

Parameters

Returns T

withPreMiddleware

Type Parameters

Parameters

Returns T

Settings

`Protected`configuration

`Protected`isJsonMime

`Protected`request