> ## Documentation Index
> Fetch the complete documentation index at: https://terminal49.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Class: ContainerManager

> ContainerManager reference for the Terminal49 TypeScript SDK, used to list containers, fetch container details, and retrieve raw and mapped transport events.

# Class: ContainerManager

## Extends

* [`BaseManager`](/docs/sdk/reference/client/managers/classes/BaseManager)

## Constructors

### Constructor

> **new ContainerManager**(`transport`, `defaultFormat?`): `ContainerManager`

#### Parameters

| Parameter       | Type                                                                         | Default value |
| --------------- | ---------------------------------------------------------------------------- | ------------- |
| `transport`     | [`Transport`](/docs/sdk/reference/client/transport/classes/Transport)             | `undefined`   |
| `defaultFormat` | [`ResponseFormat`](/docs/sdk/reference/types/options/type-aliases/ResponseFormat) | `'raw'`       |

#### Returns

`ContainerManager`

#### Inherited from

[`BaseManager`](/docs/sdk/reference/client/managers/classes/BaseManager).[`constructor`](/docs/sdk/reference/client/managers/classes/BaseManager#constructor)

## Methods

### events()

> **events**(`id`, `options?`): `Promise`\<`any`>

#### Parameters

| Parameter  | Type                                                                 |
| ---------- | -------------------------------------------------------------------- |
| `id`       | `string`                                                             |
| `options?` | [`CallOptions`](/docs/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### get()

> **get**(`id`, `include?`, `options?`): `Promise`\<`any`>

#### Parameters

| Parameter  | Type                                                                                                                                                        |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`       | `string`                                                                                                                                                    |
| `include`  | [`IncludeParam`](/docs/sdk/reference/types/options/type-aliases/IncludeParam)\<[`ContainerInclude`](/docs/sdk/reference/types/options/type-aliases/ContainerInclude)> |
| `options?` | [`CallOptions`](/docs/sdk/reference/types/options/interfaces/CallOptions)                                                                                        |

#### Returns

`Promise`\<`any`>

***

### iterate()

> **iterate**(`filters?`, `options?`): `AsyncGenerator`\<[`Container`](/docs/sdk/reference/types/models/interfaces/Container), `void`, `unknown`>

#### Parameters

| Parameter  | Type                                                                                                                                                                                                                                                                                  |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filters`  | \{ `carrier?`: `string`; `include?`: [`IncludeParam`](/docs/sdk/reference/types/options/type-aliases/IncludeParam)\<[`ContainerInclude`](/docs/sdk/reference/types/options/type-aliases/ContainerInclude)>; `port?`: `string`; `status?`: `string`; `updatedAfter?`: `string`; } \| `undefined` |
| `options?` | `Omit`\<[`ListOptions`](/docs/sdk/reference/types/options/interfaces/ListOptions), `"page"`>                                                                                                                                                                                               |

#### Returns

`AsyncGenerator`\<[`Container`](/docs/sdk/reference/types/models/interfaces/Container), `void`, `unknown`>

***

### list()

> **list**(`filters?`, `options?`): `Promise`\<`any`>

#### Parameters

| Parameter               | Type                                                                                                                                                                                                                                                                   |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filters`               | \{ `carrier?`: `string`; `include?`: [`IncludeParam`](/docs/sdk/reference/types/options/type-aliases/IncludeParam)\<[`ContainerInclude`](/docs/sdk/reference/types/options/type-aliases/ContainerInclude)>; `port?`: `string`; `status?`: `string`; `updatedAfter?`: `string`; } |
| `filters.carrier?`      | `string`                                                                                                                                                                                                                                                               |
| `filters.include?`      | [`IncludeParam`](/docs/sdk/reference/types/options/type-aliases/IncludeParam)\<[`ContainerInclude`](/docs/sdk/reference/types/options/type-aliases/ContainerInclude)>                                                                                                            |
| `filters.port?`         | `string`                                                                                                                                                                                                                                                               |
| `filters.status?`       | `string`                                                                                                                                                                                                                                                               |
| `filters.updatedAfter?` | `string`                                                                                                                                                                                                                                                               |
| `options?`              | [`ListOptions`](/docs/sdk/reference/types/options/interfaces/ListOptions)                                                                                                                                                                                                   |

#### Returns

`Promise`\<`any`>

***

### rawEvents()

> **rawEvents**(`id`, `options?`): `Promise`\<`any`>

#### Parameters

| Parameter  | Type                                                                 |
| ---------- | -------------------------------------------------------------------- |
| `id`       | `string`                                                             |
| `options?` | [`CallOptions`](/docs/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### refresh()

> **refresh**(`id`, `options?`): `Promise`\<`any`>

#### Parameters

| Parameter  | Type                                                                 |
| ---------- | -------------------------------------------------------------------- |
| `id`       | `string`                                                             |
| `options?` | [`CallOptions`](/docs/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### route()

> **route**(`id`, `options?`): `Promise`\<`any`>

#### Parameters

| Parameter  | Type                                                                 |
| ---------- | -------------------------------------------------------------------- |
| `id`       | `string`                                                             |
| `options?` | [`CallOptions`](/docs/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>