# OrganizationModulesCustomTranslationsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteCustomModuleTranslation**](#deletecustommoduletranslation) | **DELETE** /organization/modules/custom/{moduleId}/translations/{locale} | Delete a custom module translation|
|[**getCustomModuleTranslation**](#getcustommoduletranslation) | **GET** /organization/modules/custom/{moduleId}/translations/{locale} | Get a custom module\'s translation for a locale|
|[**getCustomModuleTranslations**](#getcustommoduletranslations) | **GET** /organization/modules/custom/{moduleId}/translations | List a custom module\'s translations|
|[**updateCustomModuleTranslation**](#updatecustommoduletranslation) | **PUT** /organization/modules/custom/{moduleId}/translations/{locale} | Update a custom module translation|

# **deleteCustomModuleTranslation**
> CreateAccountInvitations200Response deleteCustomModuleTranslation()

Deletes the translation for the given locale on the specified custom module, and requires the \"update\" permission on \"org\".

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateAccountInvitations200Response**

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

# **getCustomModuleTranslation**
> GetCustomModuleTranslation200Response getCustomModuleTranslation()

Returns the translated strings for a custom module in a specific locale, identified by module ID and locale code; requires read access to the organization.

### Example

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

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

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

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

### Parameters

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


### Return type

**GetCustomModuleTranslation200Response**

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

# **getCustomModuleTranslations**
> GetCustomModuleTranslations200Response getCustomModuleTranslations()

Returns a paginated list of locale translations for the specified custom module, supporting search and ordering; requires org read permission.

### Example

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

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

let moduleId: string; //The module identifier (default to undefined)
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.getCustomModuleTranslations(
    moduleId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **moduleId** | [**string**] | The module identifier | defaults to undefined|
| **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

**GetCustomModuleTranslations200Response**

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

# **updateCustomModuleTranslation**
> GetCustomModuleTranslation200Response updateCustomModuleTranslation(customModuleTranslationUpdateInputs)

Creates or updates the translated content (e.g. name) for a custom module in the given locale, upserting the record if it doesn\'t already exist, and requires the \"update\" permission on \"org\".

### Example

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

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

let moduleId: string; //The module identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let customModuleTranslationUpdateInputs: CustomModuleTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateCustomModuleTranslation(
    moduleId,
    locale,
    customModuleTranslationUpdateInputs
);
```

### Parameters

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


### Return type

**GetCustomModuleTranslation200Response**

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