# Collection

## Extends

- `Collection`

### payload

```ts
payload: Collection;
```

The underlying payload data for this resource

#### Inherited from

```ts
Bkper.Collection.payload
```

### getBooks()

```ts
getBooks(): Book[];
```

#### Returns

`Book`[]

All Books of this collection.

#### Inherited from

```ts
Bkper.Collection.getBooks
```

***

### getId()

```ts
getId(): string;
```

#### Returns

`string`

The id of this Collection

#### Inherited from

```ts
Bkper.Collection.getId
```

***

### getName()

```ts
getName(): string;
```

#### Returns

`string`

The name of this Collection

#### Inherited from

```ts
Bkper.Collection.getName
```

***

### json()

```ts
json(): Collection;
```

Gets an immutable copy of the JSON payload for this resource.

#### Returns

`Collection`

An immutable copy of the json payload

#### Inherited from

```ts
Bkper.Collection.json
```

***

### setName()

```ts
setName(name): Collection;
```

Sets the name of the Collection.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `name` | `string` |

#### Returns

`Collection`

This Collection, for chainning.

#### Inherited from

```ts
Bkper.Collection.setName
```

***

### update()

```ts
update(): Collection;
```

Performs update Collection, applying pending changes.

#### Returns

`Collection`

The updated Collection object

#### Inherited from

```ts
Bkper.Collection.update
```