# OrganizationModulesTiersApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addOrganizationModuleEditableTier**](#addorganizationmoduleeditabletier) | **POST** /organization/modules/{moduleType}/editableTiers/{tierId} | Add an editable tier to a module|
|[**addOrganizationModuleEnabledTier**](#addorganizationmoduleenabledtier) | **POST** /organization/modules/{moduleType}/enabledTiers/{tierId} | Add an enabled tier to a module|
|[**getOrganizationModuleEditableTiers**](#getorganizationmoduleeditabletiers) | **GET** /organization/modules/{moduleType}/editableTiers | List a module\'s editable account tiers|
|[**getOrganizationModuleEnabledTiers**](#getorganizationmoduleenabledtiers) | **GET** /organization/modules/{moduleType}/enabledTiers | List a module\'s enabled account tiers|
|[**removeOrganizationModuleEditableTier**](#removeorganizationmoduleeditabletier) | **DELETE** /organization/modules/{moduleType}/editableTiers/{tierId} | Remove an editable tier from a module|
|[**removeOrganizationModuleEnabledTier**](#removeorganizationmoduleenabledtier) | **DELETE** /organization/modules/{moduleType}/enabledTiers/{tierId} | Remove an enabled tier from a module|

# **addOrganizationModuleEditableTier**
> GetOrganizationModule200Response addOrganizationModuleEditableTier()

Grants the specified account tier permission to edit the given organization module type, requires the update org permission, and invalidates the modules list and that module\'s cached detail on success.

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **moduleType** | [**string**] | The moduleType identifier | defaults to undefined|
| **tierId** | [**string**] | The tier 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)

# **addOrganizationModuleEnabledTier**
> GetOrganizationModule200Response addOrganizationModuleEnabledTier()

Grants the specified account tier access to use the given organization module type, requires the update org permission, and invalidates the modules list and that module\'s cached detail on success.

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **moduleType** | [**string**] | The moduleType identifier | defaults to undefined|
| **tierId** | [**string**] | The tier 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)

# **getOrganizationModuleEditableTiers**
> GetAccountTiers200Response getOrganizationModuleEditableTiers()

Returns the account tiers that are allowed to edit content for the specified organization module type; requires org read permission.

### Example

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

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

let moduleType: string; //The moduleType 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.getOrganizationModuleEditableTiers(
    moduleType,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

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

**GetAccountTiers200Response**

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

# **getOrganizationModuleEnabledTiers**
> GetAccountTiers200Response getOrganizationModuleEnabledTiers()

Returns the account tiers for which the specified organization module type is enabled; requires org read permission.

### Example

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

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

let moduleType: string; //The moduleType 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.getOrganizationModuleEnabledTiers(
    moduleType,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

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

**GetAccountTiers200Response**

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

# **removeOrganizationModuleEditableTier**
> GetOrganizationModule200Response removeOrganizationModuleEditableTier()

Revokes the specified account tier\'s permission to edit the given organization module type, requires the update org permission, and invalidates the modules list and that module\'s cached detail on success.

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **moduleType** | [**string**] | The moduleType identifier | defaults to undefined|
| **tierId** | [**string**] | The tier 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)

# **removeOrganizationModuleEnabledTier**
> GetOrganizationModule200Response removeOrganizationModuleEnabledTier()

Revokes the specified account tier\'s access to use the given organization module type, requires the update org permission, and invalidates the modules list and that module\'s cached detail on success.

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **moduleType** | [**string**] | The moduleType identifier | defaults to undefined|
| **tierId** | [**string**] | The tier 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)