Function SettingsApiFactory

Returns {
    settingsControllerDelete(
        key: string,
        gameServerId?: string,
        options?: any,
    ): AxiosPromise<APIOutput>;
    settingsControllerGet(
        keys?: SettingsControllerGetKeysEnum[],
        gameServerId?: string,
        options?: any,
    ): AxiosPromise<SettingsOutputArrayDTOAPI>;
    settingsControllerGetOne(
        key: string,
        gameServerId?: string,
        options?: any,
    ): AxiosPromise<SettingsOutputDTOAPI>;
    settingsControllerSet(
        key: string,
        settingsSetDTO?: SettingsSetDTO,
        options?: any,
    ): AxiosPromise<SettingsOutputDTOAPI>;
}

• settingsControllerDelete: function

  • settingsControllerDelete(
        key: string,
        gameServerId?: string,
        options?: any,
    ): AxiosPromise<APIOutput>

    Required permissions: MANAGE_SETTINGS
    OperationId: SettingsControllerDelete

    Parameters

    • key: string
    • OptionalgameServerId: string
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• settingsControllerGet: function

  • settingsControllerGet(
        keys?: SettingsControllerGetKeysEnum[],
        gameServerId?: string,
        options?: any,
    ): AxiosPromise<SettingsOutputArrayDTOAPI>

    
    OperationId: SettingsControllerGet

    Parameters

    • Optionalkeys: SettingsControllerGetKeysEnum[]
    • OptionalgameServerId: string
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<SettingsOutputArrayDTOAPI>

    Throws

• settingsControllerGetOne: function

  • settingsControllerGetOne(
        key: string,
        gameServerId?: string,
        options?: any,
    ): AxiosPromise<SettingsOutputDTOAPI>

    
    OperationId: SettingsControllerGetOne

    Parameters

    • key: string
    • OptionalgameServerId: string
    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<SettingsOutputDTOAPI>

    Throws

• settingsControllerSet: function

  • settingsControllerSet(
        key: string,
        settingsSetDTO?: SettingsSetDTO,
        options?: any,
    ): AxiosPromise<SettingsOutputDTOAPI>

    Required permissions: MANAGE_SETTINGS
    OperationId: SettingsControllerSet

    Parameters

    • key: string
    • OptionalsettingsSetDTO: SettingsSetDTO

      SettingsSetDTO

    • Optionaloptions: any

      Override http request option.

    Returns AxiosPromise<SettingsOutputDTOAPI>

    Throws