GroupApi

GroupApi - object-oriented interface

Export

GroupApi

Extends

  • BaseAPI

Constructors

new GroupApi()

new GroupApi(configuration?, basePath?, axios?): GroupApi

Parameters

configuration?

basePath?

string = BASE_PATH

axios?

AxiosInstance = globalAxios

Returns

Inherited from

BaseAPI.constructor

Properties

axios

protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios


basePath

protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath


configuration

protected configuration: undefined | Configuration

Inherited from

BaseAPI.configuration

Methods

apiV1GroupByNameGet()

apiV1GroupByNameGet(name, options?): Promise<AxiosResponse<GroupResponseDTO>>

Parameters

name

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<GroupResponseDTO>>

Throws

Memberof

GroupApi


apiV1GroupDefaultGet()

apiV1GroupDefaultGet(options?): Promise<AxiosResponse<string>>

Parameters

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<string>>

Throws

Memberof

GroupApi


apiV1GroupGet()

apiV1GroupGet(skip?, take?, includeTemporary?, options?): Promise<AxiosResponse<GroupResponseDTO[]>>

Parameters

skip?

number

take?

number

includeTemporary?

boolean

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<GroupResponseDTO[]>>

Throws

Memberof

GroupApi


apiV1GroupIdDelete()

apiV1GroupIdDelete(id, options?): Promise<AxiosResponse<void>>

Parameters

id

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<void>>

Throws

Memberof

GroupApi


apiV1GroupIdGet()

apiV1GroupIdGet(id, options?): Promise<AxiosResponse<GroupResponseDTO>>

Parameters

id

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<GroupResponseDTO>>

Throws

Memberof

GroupApi


apiV1GroupIdPatch()

apiV1GroupIdPatch(id, groupPatchDTO?, options?): Promise<AxiosResponse<GroupResponseDTO>>

Parameters

id

string

groupPatchDTO?

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<GroupResponseDTO>>

Throws

Memberof

GroupApi


apiV1GroupPost()

apiV1GroupPost(groupRequestDTO?, options?): Promise<AxiosResponse<GroupResponseDTO>>

Parameters

groupRequestDTO?

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<GroupResponseDTO>>

Throws

Memberof

GroupApi


apiV1GroupTemporaryPost()

apiV1GroupTemporaryPost(groupTemporaryCreateRequestDTO?, options?): Promise<AxiosResponse<GroupResponseDTO>>

Parameters

groupTemporaryCreateRequestDTO?

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<GroupResponseDTO>>

Throws

Memberof

GroupApi

Found a mistake? Let us know.

Enroll in beta

Request invite to our private Beta program for developers to join the waitlist. No spam, we promise.