Class FilesApi

Hierarchy (View Summary)

BaseAPI
- FilesApi

Index

Constructors

Properties

Methods

isJsonMime request startFileUpload startFileUploadRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

`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

startFileUpload

startFileUpload(
requestParameters: StartFileUploadOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<StartFileUploadResponse>
Upload a generic file to the platform
Parameters
- requestParameters: StartFileUploadOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<StartFileUploadResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/FilesApi.ts:87

startFileUploadRaw

startFileUploadRaw(
requestParameters: StartFileUploadOperationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<StartFileUploadResponse>>
Upload a generic file to the platform
Parameters
- requestParameters: StartFileUploadOperationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<StartFileUploadResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/FilesApi.ts:44

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