# App

## Extends

- `App`

### apiVersion?

```ts
optional apiVersion: "v0" | "v1" | "v2" | "v3" | "v4" | "v5";
```

The API version of the event payload

#### Inherited from

```ts
bkper.App.apiVersion
```

***

### clientId?

```ts
optional clientId: string;
```

The Google OAuth Client ID

#### Inherited from

```ts
bkper.App.clientId
```

***

### clientSecret?

```ts
optional clientSecret: string;
```

The Google OAuth Client Secret

#### Inherited from

```ts
bkper.App.clientSecret
```

***

### connectable?

```ts
optional connectable: boolean;
```

Whether this app is connectable by a user

#### Inherited from

```ts
bkper.App.connectable
```

***

### deprecated?

```ts
optional deprecated: boolean;
```

Whether the app is deprecated

#### Inherited from

```ts
bkper.App.deprecated
```

***

### description?

```ts
optional description: string;
```

The App description

#### Inherited from

```ts
bkper.App.description
```

***

### developers?

```ts
optional developers: string;
```

The developers (usernames and domain patterns), comma or space separated

#### Inherited from

```ts
bkper.App.developers
```

***

### events?

```ts
optional events: (
  | "FILE_CREATED"
  | "FILE_UPDATED"
  | "FILE_DELETED"
  | "TRANSACTION_CREATED"
  | "TRANSACTION_UPDATED"
  | "TRANSACTION_DELETED"
  | "TRANSACTION_POSTED"
  | "TRANSACTION_CHECKED"
  | "TRANSACTION_UNCHECKED"
  | "TRANSACTION_RESTORED"
  | "ACCOUNT_CREATED"
  | "ACCOUNT_UPDATED"
  | "ACCOUNT_DELETED"
  | "QUERY_CREATED"
  | "QUERY_UPDATED"
  | "QUERY_DELETED"
  | "GROUP_CREATED"
  | "GROUP_UPDATED"
  | "GROUP_DELETED"
  | "COMMENT_CREATED"
  | "COMMENT_DELETED"
  | "COLLABORATOR_ADDED"
  | "COLLABORATOR_UPDATED"
  | "COLLABORATOR_REMOVED"
  | "INTEGRATION_CREATED"
  | "INTEGRATION_UPDATED"
  | "INTEGRATION_DELETED"
  | "BOOK_CREATED"
  | "BOOK_AUDITED"
  | "BOOK_UPDATED"
  | "BOOK_DELETED")[];
```

Event types the App listen to

#### Inherited from

```ts
bkper.App.events
```

***

### filePatterns?

```ts
optional filePatterns: string[];
```

File patterns the App handles - wildcard accepted. E.g. *.pdf, *-bank.csv

#### Inherited from

```ts
bkper.App.filePatterns
```

***

### id?

```ts
optional id: string;
```

The unique agent id of the App - this can't be changed after created

#### Inherited from

```ts
bkper.App.id
```

***

### installable?

```ts
optional installable: boolean;
```

Whether this app is installable in a book

#### Inherited from

```ts
bkper.App.installable
```

***

### logoUrl?

```ts
optional logoUrl: string;
```

The App logo url

#### Inherited from

```ts
bkper.App.logoUrl
```

***

### logoUrlDark?

```ts
optional logoUrlDark: string;
```

The App logo url in dark mode

#### Inherited from

```ts
bkper.App.logoUrlDark
```

***

### menuOpenMode?

```ts
optional menuOpenMode: "SIDEBAR" | "EXPANDED" | "NEW_TAB";
```

How the app menu opens. Default to SIDEBAR

#### Inherited from

```ts
bkper.App.menuOpenMode
```

***

### menuPopupHeight?

```ts
optional menuPopupHeight: string;
```

Deprecated

#### Inherited from

```ts
bkper.App.menuPopupHeight
```

***

### menuPopupWidth?

```ts
optional menuPopupWidth: string;
```

Deprecated

#### Inherited from

```ts
bkper.App.menuPopupWidth
```

***

### menuText?

```ts
optional menuText: string;
```

The contex menu text - default to the App name

#### Inherited from

```ts
bkper.App.menuText
```

***

### menuUrl?

```ts
optional menuUrl: string;
```

The context menu url

#### Inherited from

```ts
bkper.App.menuUrl
```

***

### menuUrlDev?

```ts
optional menuUrlDev: string;
```

The context menu url in dev mode

#### Inherited from

```ts
bkper.App.menuUrlDev
```

***

### name?

```ts
optional name: string;
```

The App name

#### Inherited from

```ts
bkper.App.name
```

***

### ownerEmail?

```ts
optional ownerEmail: string;
```

The owner user email

#### Inherited from

```ts
bkper.App.ownerEmail
```

***

### ownerId?

```ts
optional ownerId: string;
```

The owner user id

#### Inherited from

```ts
bkper.App.ownerId
```

***

### ownerLogoUrl?

```ts
optional ownerLogoUrl: string;
```

The owner company logo url

#### Inherited from

```ts
bkper.App.ownerLogoUrl
```

***

### ownerName?

```ts
optional ownerName: string;
```

The owner company name

#### Inherited from

```ts
bkper.App.ownerName
```

***

### ownerWebsite?

```ts
optional ownerWebsite: string;
```

The owner company website url

#### Inherited from

```ts
bkper.App.ownerWebsite
```

***

### propertiesSchema?

```ts
optional propertiesSchema: AppPropertiesSchema;
```

#### Inherited from

```ts
bkper.App.propertiesSchema
```

***

### published?

```ts
optional published: boolean;
```

Whether this app is already published

#### Inherited from

```ts
bkper.App.published
```

***

### readme?

```ts
optional readme: string;
```

The readme.md file as string

#### Inherited from

```ts
bkper.App.readme
```

***

### readmeMd?

```ts
optional readmeMd: string;
```

The readme.md file as raw markdown string

#### Inherited from

```ts
bkper.App.readmeMd
```

***

### repoPrivate?

```ts
optional repoPrivate: boolean;
```

Whether the code repository is private

#### Inherited from

```ts
bkper.App.repoPrivate
```

***

### repoUrl?

```ts
optional repoUrl: string;
```

The code repository url

#### Inherited from

```ts
bkper.App.repoUrl
```

***

### scopes?

```ts
optional scopes: string[];
```

The Google OAuth Scopes used by the app

#### Inherited from

```ts
bkper.App.scopes
```

***

### users?

```ts
optional users: string;
```

The users (usernames and domain patterns) to enable the App while not yet published

#### Inherited from

```ts
bkper.App.users
```

***

### webhookUrl?

```ts
optional webhookUrl: string;
```

The Webhook endpoint URL to listen for book events

#### Inherited from

```ts
bkper.App.webhookUrl
```

***

### webhookUrlDev?

```ts
optional webhookUrlDev: string;
```

The Webhook endpoint URL to listen for book events in dev mode

#### Inherited from

```ts
bkper.App.webhookUrlDev
```

***

### website?

```ts
optional website: string;
```

The App website url

#### Inherited from

```ts
bkper.App.website
```