# OrganizationModulesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getOrganizationModule**](#getorganizationmodule) | **GET** /organization/modules/{moduleType} | Get an organization module\'s configuration|
|[**getOrganizationModules**](#getorganizationmodules) | **GET** /organization/modules | List an organization\'s module configurations|
|[**updateOrganizationModule**](#updateorganizationmodule) | **PUT** /organization/modules/{moduleType} | Update an organization module\'s settings|

# **getOrganizationModule**
> GetOrganizationModule200Response getOrganizationModule()

Returns the enablement configuration for a single feature module type on the organization (enabled state, tier restrictions, auth requirement), defaulting to enabled if no record exists yet; requires org read permission.

### Example

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

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

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

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

### Parameters

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


### Return type

**GetOrganizationModule200Response**

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

# **getOrganizationModules**
> GetOrganizationModules200Response getOrganizationModules()

Returns the enablement configuration for every feature module type on the organization, filling in default values (enabled, no tier restrictions) for module types that have no explicit record yet; requires org read permission.

### Example

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

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

**GetOrganizationModules200Response**

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

# **updateOrganizationModule**
> GetOrganizationModule200Response updateOrganizationModule(organizationModuleUpdateInputs)

Updates the configuration (such as enabled state, requireAuth, or editable tiers) of a given organization module type for the current organization, requiring update permission on the org resource.

### Example

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

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

let moduleType: string; //The moduleType identifier (default to undefined)
let organizationModuleUpdateInputs: OrganizationModuleUpdateInputs; //

const { status, data } = await apiInstance.updateOrganizationModule(
    moduleType,
    organizationModuleUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **organizationModuleUpdateInputs** | **OrganizationModuleUpdateInputs**|  | |
| **moduleType** | [**string**] | The moduleType identifier | defaults to undefined|


### Return type

**GetOrganizationModule200Response**

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