# Timeseries Function

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

## constructor


Constructor

### Parámetros

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


---
## delete()


Deletes the selected RuleConfiguration


### Retorna

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

{{% /notice %}}

---
## update()


Udpate a Rule


### Retorna

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

{{% /notice %}}

---
## withDescription(description)


Set the description attribute

### Parámetros

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

### Retorna

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

{{% /notice %}}

---
## withIdentifier(name)


Set the name for update attribute

### Parámetros

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

### Retorna

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

{{% /notice %}}

---
## withName(name)


Set the name attribute

### Parámetros

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

### Retorna

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

{{% /notice %}}

---
## withOrganization(organization)


Set the organization attribute

### Parámetros

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

### Retorna

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

{{% /notice %}}

---
## withReturnType(returnType)


Set the returnType attribute

### Parámetros

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

### Retorna

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

{{% /notice %}}

---
## withScript(script)


Set the script attribute

### Parámetros

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

### Retorna

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

{{% /notice %}}

---
## withValueTypes(valueTypes)


Set the valueTypes attribute

### Parámetros

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

### Retorna

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

{{% /notice %}}

---