Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SettingsApi

SettingsApi - object-oriented interface

export

Hierarchy

  • BaseAPI
    • SettingsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns SettingsApi

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: Configuration

Methods

getGeneralAPISettings

  • getGeneralAPISettings(options?: AxiosRequestConfig): Promise<AxiosResponse<GeneralAPISettings>>
  • summary

    Get instance's global settings for api

    throws

    {RequiredError}

    memberof

    SettingsApi

    Parameters

    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<GeneralAPISettings>>

getGeneralAttachmentSettings

  • summary

    Get instance's global settings for Attachment

    throws

    {RequiredError}

    memberof

    SettingsApi

    Parameters

    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<GeneralAttachmentSettings>>

getGeneralRepositorySettings

  • getGeneralRepositorySettings(options?: AxiosRequestConfig): Promise<AxiosResponse<GeneralRepoSettings>>
  • summary

    Get instance's global settings for repositories

    throws

    {RequiredError}

    memberof

    SettingsApi

    Parameters

    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<GeneralRepoSettings>>

getGeneralUISettings

  • getGeneralUISettings(options?: AxiosRequestConfig): Promise<AxiosResponse<GeneralUISettings>>
  • summary

    Get instance's global settings for ui

    throws

    {RequiredError}

    memberof

    SettingsApi

    Parameters

    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<GeneralUISettings>>

Generated using TypeDoc