# OrganizationSideeffectsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createOrganizationSideEffect**](#createorganizationsideeffect) | **POST** /organization/sideEffects | Create an automation side effect|
|[**deleteOrganizationSideEffect**](#deleteorganizationsideeffect) | **DELETE** /organization/sideEffects/{sideEffectId} | Delete an automation side effect|
|[**getOrganizationSideEffect**](#getorganizationsideeffect) | **GET** /organization/sideEffects/{sideEffectId} | Get an organization side effect|
|[**getOrganizationSideEffects**](#getorganizationsideeffects) | **GET** /organization/sideEffects | List an organization\'s side effects|

# **createOrganizationSideEffect**
> CreateOrganizationSideEffect200Response createOrganizationSideEffect(createOrganizationSideEffectRequest)

Creates a side effect that automatically performs an action (such as adding a member to a tier or sending a webhook) when a specified trigger occurs (such as a new account tier or a checked-in event pass), requiring update permission on the resources associated with the chosen trigger and action types.

### Example

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

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

let createOrganizationSideEffectRequest: CreateOrganizationSideEffectRequest; //

const { status, data } = await apiInstance.createOrganizationSideEffect(
    createOrganizationSideEffectRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **createOrganizationSideEffectRequest** | **CreateOrganizationSideEffectRequest**|  | |


### Return type

**CreateOrganizationSideEffect200Response**

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

# **deleteOrganizationSideEffect**
> CreateOrganizationSideEffect200Response deleteOrganizationSideEffect()

Permanently removes the side effect identified by sideEffectId, requiring update permission on the resource associated with that side effect\'s trigger type.

### Example

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

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

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

const { status, data } = await apiInstance.deleteOrganizationSideEffect(
    sideEffectId
);
```

### Parameters

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


### Return type

**CreateOrganizationSideEffect200Response**

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

# **getOrganizationSideEffect**
> CreateOrganizationSideEffect200Response getOrganizationSideEffect()

Returns the details of a single automation side effect (a trigger-to-action rule, e.g. new pass of pass type joins a group) configured for the organization, identified by side effect ID.

### Example

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

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

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

const { status, data } = await apiInstance.getOrganizationSideEffect(
    sideEffectId
);
```

### Parameters

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


### Return type

**CreateOrganizationSideEffect200Response**

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

# **getOrganizationSideEffects**
> GetOrganizationSideEffects200Response getOrganizationSideEffects()

Returns a paginated list of automation side effects (trigger-to-action rules, e.g. a new pass of a pass type adding someone to a group) configured for the organization, filterable by trigger type and trigger ID; the required trigger type determines the permission checked (e.g. \"update\" on \"events\" or \"accounts\").

### Example

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

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

let triggerType: SideEffectTriggerType; //Filter by triggerType (optional) (default to undefined)
let triggerId: string; //Filter by triggerId (optional) (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.getOrganizationSideEffects(
    triggerType,
    triggerId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **triggerType** | **SideEffectTriggerType** | Filter by triggerType | (optional) defaults to undefined|
| **triggerId** | [**string**] | Filter by triggerId | (optional) 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

**GetOrganizationSideEffects200Response**

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