Function SettingsApiAxiosParamCreator

SettingsApi - axios parameter creator

Export

  • SettingsApiAxiosParamCreator(configuration?): {
        settingsControllerDelete: ((key: string, gameServerId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        settingsControllerGet: ((keys?: SettingsControllerGetKeysEnum[], gameServerId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        settingsControllerGetOne: ((key: string, gameServerId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        settingsControllerSet: ((key: string, settingsSetDTO?: SettingsSetDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        settingsControllerDelete: ((key: string, gameServerId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        settingsControllerGet: ((keys?: SettingsControllerGetKeysEnum[], gameServerId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        settingsControllerGetOne: ((key: string, gameServerId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        settingsControllerSet: ((key: string, settingsSetDTO?: SettingsSetDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • settingsControllerDelete: ((key: string, gameServerId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_SETTINGS

      Summary

      Delete

      Throws

        • (key, gameServerId?, options?): Promise<RequestArgs>

        • Parameters

          • key: string
          • OptionalgameServerId: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • settingsControllerGet: ((keys?: SettingsControllerGetKeysEnum[], gameServerId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Get

      Throws

        • (keys?, gameServerId?, options?): Promise<RequestArgs>

        • Parameters

          • Optionalkeys: SettingsControllerGetKeysEnum[]
          • OptionalgameServerId: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • settingsControllerGetOne: ((key: string, gameServerId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Get one

      Throws

        • (key, gameServerId?, options?): Promise<RequestArgs>

        • Parameters

          • key: string
          • OptionalgameServerId: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • settingsControllerSet: ((key: string, settingsSetDTO?: SettingsSetDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_SETTINGS

      Summary

      Set

      Throws

        • (key, settingsSetDTO?, options?): Promise<RequestArgs>

        • Parameters

          • key: string
          • OptionalsettingsSetDTO: SettingsSetDTO

            SettingsSetDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility