Class WorkspacesApi

Hierarchy (View Summary)

BaseAPI
- WorkspacesApi

Index

Constructors

Properties

Methods

getWorkspaceById getWorkspaceByIdRaw getWorkspaces getWorkspacesRaw isJsonMime request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

getWorkspaceById

getWorkspaceById(
requestParameters: GetWorkspaceByIdRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<GetWorkspaceByIdResponse>
Returns details of a specific workspace within the organization Get a specific workspace by ID
Parameters
- requestParameters: GetWorkspaceByIdRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<GetWorkspaceByIdResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/WorkspacesApi.ts:92

getWorkspaceByIdRaw

getWorkspaceByIdRaw(
requestParameters: GetWorkspaceByIdRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<GetWorkspaceByIdResponse>>
Returns details of a specific workspace within the organization Get a specific workspace by ID
Parameters
- requestParameters: GetWorkspaceByIdRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<GetWorkspaceByIdResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/WorkspacesApi.ts:51

getWorkspaces

getWorkspaces(
requestParameters: GetWorkspacesRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<GetWorkspacesResponse>
Returns all workspaces that belong to the specified organization with pagination support Get all workspaces in an organization
Parameters
- requestParameters: GetWorkspacesRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<GetWorkspacesResponse>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/WorkspacesApi.ts:143

getWorkspacesRaw

getWorkspacesRaw(
requestParameters: GetWorkspacesRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<GetWorkspacesResponse>>
Returns all workspaces that belong to the specified organization with pagination support Get all workspaces in an organization
Parameters
- requestParameters: GetWorkspacesRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<GetWorkspacesResponse>>
- Defined in work/vectorize-clients/vectorize-clients/src/ts/src/apis/WorkspacesApi.ts:101

`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

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 WorkspacesApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WorkspacesApi

Properties

Protectedconfiguration

Methods

getWorkspaceById

Parameters

Returns Promise<GetWorkspaceByIdResponse>

getWorkspaceByIdRaw

Parameters

Returns Promise<ApiResponse<GetWorkspaceByIdResponse>>

getWorkspaces

Parameters

Returns Promise<GetWorkspacesResponse>

getWorkspacesRaw

Parameters

Returns Promise<ApiResponse<GetWorkspacesResponse>>

ProtectedisJsonMime

Parameters

Returns boolean

Protectedrequest

Parameters

Returns Promise<Response>

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