Class DestinationConnectorsApi

Hierarchy (View Summary)

BaseAPI
- DestinationConnectorsApi

Index

Constructors

Properties

Methods

createDestinationConnector createDestinationConnectorRaw deleteDestinationConnector deleteDestinationConnectorRaw getDestinationConnector getDestinationConnectorRaw getDestinationConnectors getDestinationConnectorsRaw isJsonMime request updateDestinationConnector updateDestinationConnectorRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

createDestinationConnector

createDestinationConnector(
requestParameters: CreateDestinationConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<CreateDestinationConnectorResponse>
Creates a new destination connector for data storage. The specific configuration fields required depend on the connector type selected. Create a new destination connector
Parameters
- requestParameters: CreateDestinationConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<CreateDestinationConnectorResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/DestinationConnectorsApi.ts:130

createDestinationConnectorRaw

createDestinationConnectorRaw(
requestParameters: CreateDestinationConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<CreateDestinationConnectorResponse>>
Creates a new destination connector for data storage. The specific configuration fields required depend on the connector type selected. Create a new destination connector
Parameters
- requestParameters: CreateDestinationConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<CreateDestinationConnectorResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/DestinationConnectorsApi.ts:82

deleteDestinationConnector

deleteDestinationConnector(
requestParameters: DeleteDestinationConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<DeleteDestinationConnectorResponse>
Delete a destination connector Delete a destination connector
Parameters
- requestParameters: DeleteDestinationConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<DeleteDestinationConnectorResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/DestinationConnectorsApi.ts:180

deleteDestinationConnectorRaw

deleteDestinationConnectorRaw(
requestParameters: DeleteDestinationConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<DeleteDestinationConnectorResponse>>
Delete a destination connector Delete a destination connector
Parameters
- requestParameters: DeleteDestinationConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<DeleteDestinationConnectorResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/DestinationConnectorsApi.ts:139

getDestinationConnector

getDestinationConnector(
requestParameters: GetDestinationConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<DestinationConnector>
Get a destination connector Get a destination connector
Parameters
- requestParameters: GetDestinationConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<DestinationConnector>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/DestinationConnectorsApi.ts:230

getDestinationConnectorRaw

getDestinationConnectorRaw(
requestParameters: GetDestinationConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<DestinationConnector>>
Get a destination connector Get a destination connector
Parameters
- requestParameters: GetDestinationConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<DestinationConnector>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/DestinationConnectorsApi.ts:189

getDestinationConnectors

getDestinationConnectors(
requestParameters: GetDestinationConnectorsRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<GetDestinationConnectors200Response>
Get all existing destination connectors Get all existing destination connectors
Parameters
- requestParameters: GetDestinationConnectorsRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<GetDestinationConnectors200Response>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/DestinationConnectorsApi.ts:277

getDestinationConnectorsRaw

getDestinationConnectorsRaw(
requestParameters: GetDestinationConnectorsRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<GetDestinationConnectors200Response>>
Get all existing destination connectors Get all existing destination connectors
Parameters
- requestParameters: GetDestinationConnectorsRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<GetDestinationConnectors200Response>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/DestinationConnectorsApi.ts:239

`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

updateDestinationConnector

updateDestinationConnector(
requestParameters: UpdateDestinationConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<UpdateDestinationConnectorResponse>
Update a destination connector Update a destination connector
Parameters
- requestParameters: UpdateDestinationConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<UpdateDestinationConnectorResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/DestinationConnectorsApi.ts:337

updateDestinationConnectorRaw

updateDestinationConnectorRaw(
requestParameters: UpdateDestinationConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<UpdateDestinationConnectorResponse>>
Update a destination connector Update a destination connector
Parameters
- requestParameters: UpdateDestinationConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<UpdateDestinationConnectorResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/DestinationConnectorsApi.ts:286

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 DestinationConnectorsApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DestinationConnectorsApi

Properties

Protectedconfiguration

Methods

createDestinationConnector

Parameters

Returns Promise<CreateDestinationConnectorResponse>

createDestinationConnectorRaw

Parameters

Returns Promise<ApiResponse<CreateDestinationConnectorResponse>>

deleteDestinationConnector

Parameters

Returns Promise<DeleteDestinationConnectorResponse>

deleteDestinationConnectorRaw

Parameters

Returns Promise<ApiResponse<DeleteDestinationConnectorResponse>>

getDestinationConnector

Parameters

Returns Promise<DestinationConnector>

getDestinationConnectorRaw

Parameters

Returns Promise<ApiResponse<DestinationConnector>>

getDestinationConnectors

Parameters

Returns Promise<GetDestinationConnectors200Response>

getDestinationConnectorsRaw

Parameters

Returns Promise<ApiResponse<GetDestinationConnectors200Response>>

ProtectedisJsonMime

Parameters

Returns boolean

Protectedrequest

Parameters

Returns Promise<Response>

updateDestinationConnector

Parameters

Returns Promise<UpdateDestinationConnectorResponse>

updateDestinationConnectorRaw

Parameters

Returns Promise<ApiResponse<UpdateDestinationConnectorResponse>>

withMiddleware

Type Parameters

Parameters

Returns T

withPostMiddleware

Type Parameters

Parameters

Returns T

withPreMiddleware

Type Parameters

Parameters

Returns T

Settings

On This Page

`Protected`configuration

`Protected`isJsonMime

`Protected`request