# OrganizationModulesSettingsTranslationsApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteOrganizationModuleSettingsTranslation**](#deleteorganizationmodulesettingstranslation) | **DELETE** /organization/module-settings/translations/{locale} | Delete a module settings translation|
|[**getOrganizationModuleSettingsTranslation**](#getorganizationmodulesettingstranslation) | **GET** /organization/module-settings/translations/{locale} | Get a module settings translation|
|[**getOrganizationModuleSettingsTranslations**](#getorganizationmodulesettingstranslations) | **GET** /organization/module-settings/translations | List an organization\'s module settings translations|
|[**updateOrganizationModuleSettingsTranslation**](#updateorganizationmodulesettingstranslation) | **PUT** /organization/module-settings/translations/{locale} | Create or update a module settings translation|

# **deleteOrganizationModuleSettingsTranslation**
> SyncAccounts200Response deleteOrganizationModuleSettingsTranslation()

Deletes the organization\'s module settings translation for the given locale, requires the update org permission, and invalidates the translations list and that locale\'s cached entry on success.

### Example

```typescript
import {
    OrganizationModulesSettingsTranslationsApi,
    Configuration
} from '@connectedxm/admin-sdk';

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

let locale: string; //The locale identifier (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **locale** | [**string**] | The locale identifier | defaults to undefined|


### Return type

**SyncAccounts200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

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


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

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

# **getOrganizationModuleSettingsTranslation**
> GetOrganizationModuleSettingsTranslation200Response getOrganizationModuleSettingsTranslation()

Returns the organization\'s module settings translation (e.g. localized support auto-resolve message) for the specified locale; requires org read permission.

### Example

```typescript
import {
    OrganizationModulesSettingsTranslationsApi,
    Configuration
} from '@connectedxm/admin-sdk';

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

let locale: string; //The locale identifier (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **locale** | [**string**] | The locale identifier | defaults to undefined|


### Return type

**GetOrganizationModuleSettingsTranslation200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

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


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

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

# **getOrganizationModuleSettingsTranslations**
> GetOrganizationModuleSettingsTranslations200Response getOrganizationModuleSettingsTranslations()

Returns a paginated list of the organization\'s module settings translations across locales, supporting search and ordering; requires org read permission.

### Example

```typescript
import {
    OrganizationModulesSettingsTranslationsApi,
    Configuration
} from '@connectedxm/admin-sdk';

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

let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getOrganizationModuleSettingsTranslations(
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetOrganizationModuleSettingsTranslations200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

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


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

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

# **updateOrganizationModuleSettingsTranslation**
> SyncAccounts200Response updateOrganizationModuleSettingsTranslation(organizationModuleSettingsTranslationUpdateInputs)

Upserts the organization\'s module settings translation for the given locale with the provided fields, requires the update org permission, and refreshes the translations list and that locale\'s cached entry on success.

### Example

```typescript
import {
    OrganizationModulesSettingsTranslationsApi,
    Configuration,
    OrganizationModuleSettingsTranslationUpdateInputs
} from '@connectedxm/admin-sdk';

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

let locale: string; //The locale identifier (default to undefined)
let organizationModuleSettingsTranslationUpdateInputs: OrganizationModuleSettingsTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateOrganizationModuleSettingsTranslation(
    locale,
    organizationModuleSettingsTranslationUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **organizationModuleSettingsTranslationUpdateInputs** | **OrganizationModuleSettingsTranslationUpdateInputs**|  | |
| **locale** | [**string**] | The locale identifier | defaults to undefined|


### Return type

**SyncAccounts200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

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


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

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