Skip to content

Commit 8c66e14

Browse files
committed
update changelog and useCase.md
1 parent 8ac4f89 commit 8c66e14

2 files changed

Lines changed: 40 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
88

99
### Added
1010

11+
- Guestbooks: Added `downloadGuestbookResponsesByDataverseId` and `downloadGuestbookResponsesOfAGuestbook` use cases and repository support for exporting guestbook responses as raw CSV content.
1112
- Guestbooks: Added optional `includeStats` support to `getGuestbooksByCollectionId`, returning `usageCount` and `responseCount` when requested.
1213

1314
### Changed

docs/useCases.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2951,6 +2951,45 @@ getGuestbooksByCollectionId
29512951

29522952
_See [use case](../src/guestbooks/domain/useCases/GetGuestbooksByCollectionId.ts) implementation_.
29532953

2954+
#### Download Guestbook Responses By Dataverse Id
2955+
2956+
Downloads all guestbook responses for a dataverse collection and returns the raw response body, typically CSV content.
2957+
2958+
##### Example call:
2959+
2960+
```typescript
2961+
import { downloadGuestbookResponsesByDataverseId } from '@iqss/dataverse-client-javascript'
2962+
2963+
const dataverseId = 'root'
2964+
2965+
downloadGuestbookResponsesByDataverseId.execute(dataverseId).then((csvResponse: string) => {
2966+
/* ... */
2967+
})
2968+
```
2969+
2970+
_See [use case](../src/guestbooks/domain/useCases/DownloadGuestbookResponsesByDataverseId.ts) implementation_.
2971+
2972+
#### Download Guestbook Responses Of A Guestbook
2973+
2974+
Downloads guestbook responses for one guestbook in a dataverse collection and returns the raw response body, typically CSV content.
2975+
2976+
##### Example call:
2977+
2978+
```typescript
2979+
import { downloadGuestbookResponsesOfAGuestbook } from '@iqss/dataverse-client-javascript'
2980+
2981+
const dataverseId = 'root'
2982+
const guestbookId = 123
2983+
2984+
downloadGuestbookResponsesOfAGuestbook
2985+
.execute(dataverseId, guestbookId)
2986+
.then((csvResponse: string) => {
2987+
/* ... */
2988+
})
2989+
```
2990+
2991+
_See [use case](../src/guestbooks/domain/useCases/DownloadGuestbookResponsesOfAGuestbook.ts) implementation_.
2992+
29542993
### Guestbooks Write Use Cases
29552994

29562995
#### Create a Guestbook

0 commit comments

Comments
 (0)