# OrganizationModulesCustomApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createCustomModule**](#createcustommodule) | **POST** /organization/modules/custom | Create a custom module|
|[**deleteCustomModule**](#deletecustommodule) | **DELETE** /organization/modules/custom/{moduleId} | Delete a custom module|
|[**getCustomModule**](#getcustommodule) | **GET** /organization/modules/custom/{moduleId} | Get a custom module|
|[**getCustomModules**](#getcustommodules) | **GET** /organization/modules/custom | List an organization\'s custom modules|
|[**updateCustomModule**](#updatecustommodule) | **PUT** /organization/modules/custom/{moduleId} | Update a custom module|

# **createCustomModule**
> CreateCustomModule200Response createCustomModule(customModuleCreateInputs)

Creates a new organization-defined custom module using the provided module fields, requires the update org permission, and invalidates the custom modules list and detail caches on success.

### Example

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

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

let customModuleCreateInputs: CustomModuleCreateInputs; //

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **customModuleCreateInputs** | **CustomModuleCreateInputs**|  | |


### Return type

**CreateCustomModule200Response**

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

# **deleteCustomModule**
> CreateAccountInvitations200Response deleteCustomModule()

Permanently deletes the organization\'s custom module identified by moduleId, requires the update org permission, and removes the module from the custom modules list and detail caches on success.

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **moduleId** | [**string**] | The module 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)

# **getCustomModule**
> CreateCustomModule200Response getCustomModule()

Returns the details of a single custom module (name, URL, icon, color, description, position, and enabled state) for the organization; requires org read permission.

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateCustomModule200Response**

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

# **getCustomModules**
> GetCustomModules200Response getCustomModules()

Returns a paginated list of the organization\'s custom modules (custom navigation links/apps with a name, URL, icon, and color), supporting search and ordering by sort order; requires org read permission.

### Example

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

const configuration = new Configuration();
const apiInstance = new OrganizationModulesCustomApi(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.getCustomModules(
    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

**GetCustomModules200Response**

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

# **updateCustomModule**
> CreateCustomModule200Response updateCustomModule(customModuleUpdateInputs)

Updates the fields of the organization\'s custom module identified by moduleId, requires the update org permission, and refreshes the custom modules list and detail caches on success.

### Example

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

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

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

const { status, data } = await apiInstance.updateCustomModule(
    moduleId,
    customModuleUpdateInputs
);
```

### Parameters

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


### Return type

**CreateCustomModule200Response**

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