# SettingsApi

All URIs are relative to *http://localhost:8081*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**get1**](#get1) | **GET** /api/v1/settings/ai/preferences | The caller\&#39;s smart-filing preferences|
|[**getSettings1**](#getsettings1) | **GET** /api/v1/settings | Get user\&#39;s settings|
|[**save**](#save) | **PUT** /api/v1/settings/ai/preferences | Save the caller\&#39;s smart-filing preferences|

# **get1**
> AiPreferencesView get1()


### Example

```typescript
import {
    SettingsApi,
    Configuration
} from '@openfilz-sdk/typescript';

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

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

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


### Return type

**AiPreferencesView**

### Authorization

[keycloak_auth](../README.md#keycloak_auth)

### HTTP request headers

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


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

[[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)

# **getSettings1**
> Settings getSettings1()

Retrieve user\'s settings : global settings and user\'s preferences. The category labels (aiInsightsCategoryLabels) are in the Accept-Language language, English when it is not supported.

### Example

```typescript
import {
    SettingsApi,
    Configuration
} from '@openfilz-sdk/typescript';

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

let acceptLanguage: string; // (optional) (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|


### Return type

**Settings**

### Authorization

[keycloak_auth](../README.md#keycloak_auth)

### HTTP request headers

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


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

[[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)

# **save**
> AiPreferencesView save(saveAiPreferencesRequest)

A null field leaves the current value unchanged. inbox=true creates the caller\'s Inbox folder at their root on demand (named from Accept-Language, else the deployment\'s default language); inbox=false forgets it without deleting the folder. 400 when the Inbox is not offered.

### Example

```typescript
import {
    SettingsApi,
    Configuration,
    SaveAiPreferencesRequest
} from '@openfilz-sdk/typescript';

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

let saveAiPreferencesRequest: SaveAiPreferencesRequest; //
let acceptLanguage: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.save(
    saveAiPreferencesRequest,
    acceptLanguage
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **saveAiPreferencesRequest** | **SaveAiPreferencesRequest**|  | |
| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|


### Return type

**AiPreferencesView**

### Authorization

[keycloak_auth](../README.md#keycloak_auth)

### HTTP request headers

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


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

[[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)

