# Rule Configurations

This is a base object that contains all you can do about RulesConfigurations.

## constructor


Constructor

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **Reference** | `InternalOpenGateAPI` | ❌ | to the API object. |


---
## create()


Create a new Rule


### Retorna

{{% notice tip %}}
**Tipo:** `Promise`
<br>

{{% /notice %}}

---
## delete()


Deletes the selected RuleConfiguration


### Retorna

{{% notice tip %}}
**Tipo:** `Promise`
<br>

{{% /notice %}}

---
## update()


Udpate a Rule


### Retorna

{{% notice tip %}}
**Tipo:** `Promise`
<br>

{{% /notice %}}

---
## updateParameters(newParameters)


Udpate a Rule

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **newParameters** | `*` | ❌ |  |

### Retorna

{{% notice tip %}}
**Tipo:** `Promise`
<br>

{{% /notice %}}

---
## withActions(actions)


Allows the modification of the actions

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **actions** | `object` | ❌ |  |

### Retorna

{{% notice tip %}}
**Tipo:** `_RuleCondition`
<br>

{{% /notice %}}

---
## withActionsDelay(actionsDelay)


Set the actions delay attribute

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **actionsDelay** | `number` | ❌ |  |

### Retorna

{{% notice tip %}}
**Tipo:** `RulesConfigurations`
<br>

{{% /notice %}}

---
## withActive(active)


Set the active attribute

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **active** | `boolean` | ❌ |  |

### Retorna

{{% notice tip %}}
**Tipo:** `RulesConfigurations`
<br>

{{% /notice %}}

---
## withChannel(channel)


Set the channel attribute

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **channel** | `string` | ❌ | required field |

### Retorna

{{% notice tip %}}
**Tipo:** `RulesConfigurations`
<br>

{{% /notice %}}

---
## withCondition(conditionFilter)


Allows the modification of a condition

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **conditionFilter** | `string` | ❌ |  |

### Retorna

{{% notice tip %}}
**Tipo:** `_RuleCondition`
<br>

{{% /notice %}}

---
## withDescription(description)


Set the description attribute

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **description** | `string` | ❌ |  |

### Retorna

{{% notice tip %}}
**Tipo:** `RulesConfigurations`
<br>

{{% /notice %}}

---
## withIdentifier(identifier)


Set the identifier attribute

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **identifier** | `string` | ❌ | required field |

### Retorna

{{% notice tip %}}
**Tipo:** `RulesConfigurations`
<br>

{{% /notice %}}

---
## withJavascript(javascript)


Set the javascript attribute

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **javascript** | `string` | ❌ |  |

### Retorna

{{% notice tip %}}
**Tipo:** `RulesConfigurations`
<br>

{{% /notice %}}

---
## withMode(mode)


Set the mode attribute

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **mode** | `string` | ❌ |  |

### Retorna

{{% notice tip %}}
**Tipo:** `RulesConfigurations`
<br>

{{% /notice %}}

---
## withName(name)


Set the name attribute

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **name** | `string` | ❌ | required field |

### Retorna

{{% notice tip %}}
**Tipo:** `RulesConfigurations`
<br>

{{% /notice %}}

---
## withOrganization(organization)


Set the organization attribute

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **organization** | `string` | ❌ | required field |

### Retorna

{{% notice tip %}}
**Tipo:** `RulesConfigurations`
<br>

{{% /notice %}}

---
## withParameters(parameters)


Allows the modification of the actions

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **parameters** | `array` | ❌ |  |

### Retorna

{{% notice tip %}}
**Tipo:** `_RuleCondition`
<br>

{{% /notice %}}

---
## withType(type)


Set the type attribute

### Parámetros

| Nombre | Tipo | Opcional | Descripción |
| :--- | :--- | :---: | :--- |
| **type** | `string` | ❌ |  |

### Retorna

{{% notice tip %}}
**Tipo:** `RulesConfigurations`
<br>

{{% /notice %}}

---