# Collections SDK Methods

> The soat.collections methods of the SOAT TypeScript SDK for the Collections module, each linked to its REST operation.

# Collections

SDK methods for the Collections module, accessed via `soat.collections`. See the [Collections module docs](/docs/modules/collections) for permissions and data model, and each method's REST page for the full request/response schema.

### `soat.collections.listCollections()`

List collections

- Method: `GET`
- Path: `/api/v1/collections`

```ts
await soat.collections.listCollections({
  query: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/collections/list-collections)

### `soat.collections.createCollection()`

Create a collection

- Method: `POST`
- Path: `/api/v1/collections`

```ts
await soat.collections.createCollection({
  body: { name, /* + optional */ },
});
```

→ [Request & response schema](/docs/api/collections/create-collection)

### `soat.collections.getCollection()`

Get a collection

- Method: `GET`
- Path: `/api/v1/collections/{collection_id}`

```ts
await soat.collections.getCollection({
  path: { collection_id },
});
```

→ [Request & response schema](/docs/api/collections/get-collection)

### `soat.collections.updateCollection()`

Update a collection

- Method: `PATCH`
- Path: `/api/v1/collections/{collection_id}`

```ts
await soat.collections.updateCollection({
  path: { collection_id },
  body: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/collections/update-collection)

### `soat.collections.deleteCollection()`

Delete a collection

- Method: `DELETE`
- Path: `/api/v1/collections/{collection_id}`

```ts
await soat.collections.deleteCollection({
  path: { collection_id },
});
```

→ [Request & response schema](/docs/api/collections/delete-collection)

### `soat.collections.listCollectionItems()`

List items

- Method: `GET`
- Path: `/api/v1/collections/{collection_id}/items`

```ts
await soat.collections.listCollectionItems({
  path: { collection_id },
});
```

→ [Request & response schema](/docs/api/collections/list-collection-items)

### `soat.collections.getCollectionItem()`

Get an item

- Method: `GET`
- Path: `/api/v1/collections/{collection_id}/items/{key}`

```ts
await soat.collections.getCollectionItem({
  path: { collection_id, key },
});
```

→ [Request & response schema](/docs/api/collections/get-collection-item)

### `soat.collections.putCollectionItem()`

Create or replace an item

- Method: `PUT`
- Path: `/api/v1/collections/{collection_id}/items/{key}`

```ts
await soat.collections.putCollectionItem({
  path: { collection_id, key },
  body: { data, /* + optional */ },
});
```

→ [Request & response schema](/docs/api/collections/put-collection-item)

### `soat.collections.updateCollectionItem()`

Update an item

- Method: `PATCH`
- Path: `/api/v1/collections/{collection_id}/items/{key}`

```ts
await soat.collections.updateCollectionItem({
  path: { collection_id, key },
  body: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/collections/update-collection-item)

### `soat.collections.deleteCollectionItem()`

Delete an item

- Method: `DELETE`
- Path: `/api/v1/collections/{collection_id}/items/{key}`

```ts
await soat.collections.deleteCollectionItem({
  path: { collection_id, key },
});
```

→ [Request & response schema](/docs/api/collections/delete-collection-item)

### `soat.collections.getCollectionItemTags()`

Get item tags

- Method: `GET`
- Path: `/api/v1/collections/{collection_id}/items/{key}/tags`

```ts
await soat.collections.getCollectionItemTags({
  path: { collection_id, key },
});
```

→ [Request & response schema](/docs/api/collections/get-collection-item-tags)

### `soat.collections.replaceCollectionItemTags()`

Replace item tags

- Method: `PUT`
- Path: `/api/v1/collections/{collection_id}/items/{key}/tags`

```ts
await soat.collections.replaceCollectionItemTags({
  path: { collection_id, key },
  body,
});
```

→ [Request & response schema](/docs/api/collections/replace-collection-item-tags)

### `soat.collections.mergeCollectionItemTags()`

Merge item tags

- Method: `PATCH`
- Path: `/api/v1/collections/{collection_id}/items/{key}/tags`

```ts
await soat.collections.mergeCollectionItemTags({
  path: { collection_id, key },
  body,
});
```

→ [Request & response schema](/docs/api/collections/merge-collection-item-tags)
