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

# Common

[**@smokeballdev/smokeball-client-sdk**](./../../../../README)

***

# Interface: Api

The entry point for communication with Smokeball.

## Properties

### auth

> **auth**: [`Api`](./../../auth/interfaces/Api)

#### Returns

the auth api.

***

### communicate

> **communicate**: [`Api`](./../../communicate/interfaces/Api)

#### Returns

the communicate api.

***

### contacts

> **contacts**: [`Api`](./../../contacts/interfaces/Api)

#### Returns

the contacts api.

***

### context

> **context**: [`Context`](./Context)

#### Returns

the context associated to the current session.

***

### correspondence

> **correspondence**: [`Api`](./../../correspondence/interfaces/Api)

#### Returns

the correspondence api.

***

### events

> **events**: [`Api`](./../../events/interfaces/Api)

#### Returns

the events api.

***

### expenses

> **expenses**: [`Api`](./../../expenses/interfaces/Api)

#### Returns

the expenses api.

***

### files

> **files**: [`Api`](./../../files/interfaces/Api)

#### Returns

the files api.

***

### firm

> **firm**: [`Api`](./../../firm/interfaces/Api)

#### Returns

the firm api.

***

### forms

> **forms**: [`Api`](./../../forms/interfaces/Api)

#### Returns

the form api.

***

### host

> **host**: [`Api`](./../../host/interfaces/Api)

#### Returns

the host api.

***

### integratedSearch

> **integratedSearch**: [`Api`](./../../integratedSearch/interfaces/Api)

#### Returns

the integrated search api.

***

### layouts

> **layouts**: [`Api`](./../../layouts/interfaces/Api)

#### Returns

the layouts api.

***

### matterItems

> **matterItems**: [`Api`](./../../matterItems/interfaces/Api)

#### Returns

the matter items api.

***

### matters

> **matters**: [`Api`](./../../matters/interfaces/Api)

#### Returns

the matters api.

***

### matterTypes

> **matterTypes**: [`Api`](./../../matterTypes/interfaces/Api)

#### Returns

the matter types api.

***

### memos

> **memos**: [`Api`](./../../memos/interfaces/Api)

#### Returns

the memos api.

***

### relationships

> **relationships**: [`Api`](./../../relationships/interfaces/Api)

#### Returns

the relationships api.

***

### roles

> **roles**: [`Api`](./../../roles/interfaces/Api)

#### Returns

the roles api.

***

### staff

> **staff**: [`Api`](./../../staff/interfaces/Api)

#### Returns

the staff api.

***

### subTasks

> **subTasks**: [`Api`](./../../subTasks/interfaces/Api)

#### Returns

the subTasks api.

***

### tasks

> **tasks**: [`Api`](./../../tasks/interfaces/Api)

#### Returns

the tasks api.

***

### version?

> `optional` **version**: `string`

#### Returns

the version of @smokeballdev/smokeball-client-sdk

## Methods

### init()

> **init**(`request?`): `Promise`\<`void`>

Initializes a session for communication with Smokeball. Also sets the session context.

The matterId is set in the context when initialized in a matter window.

#### Parameters

##### request?

[`InitRequest`](./InitRequest)

#### Returns

`Promise`\<`void`>