cberg/src/docs/SettingsApi.md

Node.js Client for the Codeberg API

# SettingsApi

All URIs are relative to */api/v1*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getGeneralAPISettings**](#getgeneralapisettings) | **GET** /settings/api | Get instance\'s global settings for api|
|[**getGeneralAttachmentSettings**](#getgeneralattachmentsettings) | **GET** /settings/attachment | Get instance\'s global settings for Attachment|
|[**getGeneralRepositorySettings**](#getgeneralrepositorysettings) | **GET** /settings/repository | Get instance\'s global settings for repositories|
|[**getGeneralUISettings**](#getgeneraluisettings) | **GET** /settings/ui | Get instance\'s global settings for ui|

# **getGeneralAPISettings**
> GeneralAPISettings getGeneralAPISettings()


### Example

```typescript
import {
    SettingsApi,
    Configuration
} from 'berg';

const configuration = new Configuration();
const apiInstance = new SettingsApi(configuration);

const { status, data } = await apiInstance.getGeneralAPISettings();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**GeneralAPISettings**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | GeneralAPISettings |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getGeneralAttachmentSettings**
> GeneralAttachmentSettings getGeneralAttachmentSettings()


### Example

```typescript
import {
    SettingsApi,
    Configuration
} from 'berg';

const configuration = new Configuration();
const apiInstance = new SettingsApi(configuration);

const { status, data } = await apiInstance.getGeneralAttachmentSettings();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**GeneralAttachmentSettings**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | GeneralAttachmentSettings |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getGeneralRepositorySettings**
> GeneralRepoSettings getGeneralRepositorySettings()


### Example

```typescript
import {
    SettingsApi,
    Configuration
} from 'berg';

const configuration = new Configuration();
const apiInstance = new SettingsApi(configuration);

const { status, data } = await apiInstance.getGeneralRepositorySettings();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**GeneralRepoSettings**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | GeneralRepoSettings |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getGeneralUISettings**
> GeneralUISettings getGeneralUISettings()


### Example

```typescript
import {
    SettingsApi,
    Configuration
} from 'berg';

const configuration = new Configuration();
const apiInstance = new SettingsApi(configuration);

const { status, data } = await apiInstance.getGeneralUISettings();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**GeneralUISettings**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | GeneralUISettings |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)