> ## 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.

# Firm

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

***

# Interface: Api

Entry point for firm to Smokeball.

## Methods

### get()

> **get**(): `Promise`\<[`Firm`](./Firm)>

Gets the firm associated with the current context.

#### Returns

`Promise`\<[`Firm`](./Firm)>

the firm associated with the current context.

#### Example

```
// Returns the firm associated with the current context.
const firm = await sdk.firm.get();
```

***

### observe()

> **observe**(`callback`): `void`

Creates a subscription for the firm associated with the current context.

Only one subscription will be made per session. Regardless of how many times this function is called, the last registered callback will be used.

#### Parameters

##### callback

(`firm`) => `void`

the function to execute when a change is made to firm(s) in Smokeball.

#### Returns

`void`

#### Example

```
sdk.firm.observe(firm => {
  // Perform syncing code here.
});
```

***

### update()

> **update**(`request`): `Promise`\<[`Firm`](./Firm)>

Updates the firm associated with the current context.

#### Parameters

##### request

[`UpdateFirmRequest`](./UpdateFirmRequest)

the update request.

#### Returns

`Promise`\<[`Firm`](./Firm)>

#### Example

```
const request: UpdateFirmRequest = {
 // Specify the fields to update here.
};
const firm = await sdk.firm.update(request);
```