Class UploadsApi

Hierarchy (View Summary)

BaseAPI
- UploadsApi

Index

Constructors

Properties

Methods

deleteFileFromConnector deleteFileFromConnectorRaw getUploadFilesFromConnector getUploadFilesFromConnectorRaw isJsonMime request startFileUploadToConnector startFileUploadToConnectorRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

deleteFileFromConnector

deleteFileFromConnector(
requestParameters: DeleteFileFromConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<DeleteFileResponse>
Delete a file from a file upload connector
Parameters
- requestParameters: DeleteFileFromConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<DeleteFileResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/UploadsApi.ts:101

deleteFileFromConnectorRaw

deleteFileFromConnectorRaw(
requestParameters: DeleteFileFromConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<DeleteFileResponse>>
Delete a file from a file upload connector
Parameters
- requestParameters: DeleteFileFromConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<DeleteFileResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/UploadsApi.ts:61

getUploadFilesFromConnector

getUploadFilesFromConnector(
requestParameters: GetUploadFilesFromConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<GetUploadFilesResponse>
Get uploaded files from a file upload connector
Parameters
- requestParameters: GetUploadFilesFromConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<GetUploadFilesResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/UploadsApi.ts:149

getUploadFilesFromConnectorRaw

getUploadFilesFromConnectorRaw(
requestParameters: GetUploadFilesFromConnectorRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<GetUploadFilesResponse>>
Get uploaded files from a file upload connector
Parameters
- requestParameters: GetUploadFilesFromConnectorRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<GetUploadFilesResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/UploadsApi.ts:109

`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

startFileUploadToConnector

startFileUploadToConnector(
requestParameters: StartFileUploadToConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<StartFileUploadToConnectorResponse>
Upload a file to a file upload connector
Parameters
- requestParameters: StartFileUploadToConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<StartFileUploadToConnectorResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/UploadsApi.ts:207

startFileUploadToConnectorRaw

startFileUploadToConnectorRaw(
requestParameters: StartFileUploadToConnectorOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<StartFileUploadToConnectorResponse>>
Upload a file to a file upload connector
Parameters
- requestParameters: StartFileUploadToConnectorOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<StartFileUploadToConnectorResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/UploadsApi.ts:157

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 UploadsApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UploadsApi

Properties

Protectedconfiguration

Methods

deleteFileFromConnector

Parameters

Returns Promise<DeleteFileResponse>

deleteFileFromConnectorRaw

Parameters

Returns Promise<ApiResponse<DeleteFileResponse>>

getUploadFilesFromConnector

Parameters

Returns Promise<GetUploadFilesResponse>

getUploadFilesFromConnectorRaw

Parameters

Returns Promise<ApiResponse<GetUploadFilesResponse>>

ProtectedisJsonMime

Parameters

Returns boolean

Protectedrequest

Parameters

Returns Promise<Response>

startFileUploadToConnector

Parameters

Returns Promise<StartFileUploadToConnectorResponse>

startFileUploadToConnectorRaw

Parameters

Returns Promise<ApiResponse<StartFileUploadToConnectorResponse>>

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