@smokeballdev/smokeball-client-sdk

---

​

Interface: Api

The entry point for communication with Smokeball.

​

Properties

​

auth

auth: Api

​

Returns

the auth api.

---

​

communicate

communicate: Api

​

Returns

the communicate api.

---

​

contacts

contacts: Api

​

Returns

the contacts api.

---

​

context

context: Context

​

Returns

the context associated to the current session.

---

​

correspondence

correspondence: Api

​

Returns

the correspondence api.

---

​

expenses

expenses: Api

​

Returns

the expenses api.

---

​

files

files: Api

​

Returns

the files api.

---

​

firm

firm: Api

​

Returns

the firm api.

---

​

forms

forms: Api

​

Returns

the form api.

---

​

host

host: Api

​

Returns

the host api.

---

​

layouts

layouts: Api

​

Returns

the layouts api.

---

​

matterItems

matterItems: Api

​

Returns

the matter items api.

---

​

matters

matters: Api

​

Returns

the matters api.

---

​

matterTypes

matterTypes: Api

​

Returns

the matter types api.

---

​

memos

memos: Api

​

Returns

the memos api.

---

​

relationships

relationships: Api

​

Returns

the relationships api.

---

​

roles

roles: Api

​

Returns

the roles api.

---

​

staff

staff: Api

​

Returns

the staff api.

---

​

subTasks

subTasks: Api

​

Returns

the subTasks api.

---

​

tasks

tasks: 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

​

Returns

Promise<void>