Class SettingsApi

SettingsApi - object-oriented interface

Export

SettingsApi

Hierarchy

BaseAPI
- SettingsApi

Index

Constructors

constructor

new SettingsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): SettingsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SettingsApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

settingsControllerDelete

settingsControllerDelete(
    key: string,
    gameServerId?: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_SETTINGS
OperationId: SettingsControllerDelete
Parameters
- key: string
- OptionalgameServerId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Throws
Memberof
SettingsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:27771

settingsControllerGet

settingsControllerGet(
    keys?: SettingsControllerGetKeysEnum[],
    gameServerId?: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SettingsOutputArrayDTOAPI, any>>
OperationId: SettingsControllerGet
Parameters
- Optionalkeys: SettingsControllerGetKeysEnum[]
- OptionalgameServerId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SettingsOutputArrayDTOAPI, any>>
Throws
Memberof
SettingsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:27786

settingsControllerGetOne

settingsControllerGetOne(
    key: string,
    gameServerId?: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SettingsOutputDTOAPI, any>>
OperationId: SettingsControllerGetOne
Parameters
- key: string
- OptionalgameServerId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SettingsOutputDTOAPI, any>>
Throws
Memberof
SettingsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:27805

settingsControllerSet

settingsControllerSet(
    key: string,
    settingsSetDTO?: SettingsSetDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SettingsOutputDTOAPI, any>>
Required permissions: MANAGE_SETTINGS
OperationId: SettingsControllerSet
Parameters
- key: string
- OptionalsettingsSetDTO: SettingsSetDTO
  SettingsSetDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SettingsOutputDTOAPI, any>>
Throws
Memberof
SettingsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:27820

Class SettingsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SettingsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

settingsControllerDelete

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Throws

Memberof

settingsControllerGet

Parameters

Returns Promise<AxiosResponse<SettingsOutputArrayDTOAPI, any>>

Throws

Memberof

settingsControllerGetOne

Parameters

Returns Promise<AxiosResponse<SettingsOutputDTOAPI, any>>

Throws

Memberof

settingsControllerSet

Parameters

Returns Promise<AxiosResponse<SettingsOutputDTOAPI, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration