Skip to content

Commit 7a73b1c

Browse files
committed
update CHANGELOG.md and useCases.md
1 parent faade42 commit 7a73b1c

2 files changed

Lines changed: 84 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
1515
- New Use Case: [Create a Template](./docs/useCases.md#create-a-template) under Templates.
1616
- New Use Case: [Get a Template](./docs/useCases.md#get-a-template) under Templates.
1717
- New Use Case: [Delete a Template](./docs/useCases.md#delete-a-template) under Templates.
18+
- New Use Case: [Update Template Metadata](./docs/useCases.md#update-template-metadata) under Templates.
19+
- New Use Case: [Update Template License Terms](./docs/useCases.md#update-template-license-terms) under Templates.
20+
- New Use Case: [Update Template Terms Of Access](./docs/useCases.md#update-template-terms-of-access) under Templates.
1821
- New Use Case: [Update Terms of Access](./docs/useCases.md#update-terms-of-access).
1922

2023
### Changed

docs/useCases.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ The different use cases currently available in the package are classified below,
3232
- [Templates write use cases](#templates-write-use-cases)
3333
- [Create a Template](#create-a-template)
3434
- [Delete a Template](#delete-a-template)
35+
- [Update Template Metadata](#update-template-metadata)
36+
- [Update Template License Terms](#update-template-license-terms)
37+
- [Update Template Terms Of Access](#update-template-terms-of-access)
3538
- [Datasets](#Datasets)
3639
- [Datasets read use cases](#datasets-read-use-cases)
3740
- [Get a Dataset](#get-a-dataset)
@@ -669,6 +672,84 @@ await deleteTemplate.execute(templateId)
669672

670673
_See [use case](../src/templates/domain/useCases/DeleteTemplate.ts)_ definition.
671674

675+
#### Update Template Metadata
676+
677+
Updates template metadata fields and instructions for a template id.
678+
679+
##### Example call:
680+
681+
```typescript
682+
import { updateTemplateMetadata } from '@iqss/dataverse-client-javascript'
683+
import { UpdateTemplateMetadataDTO } from '@iqss/dataverse-client-javascript'
684+
685+
const templateId = 12345
686+
const replace = true
687+
688+
const payload: UpdateTemplateMetadataDTO = {
689+
name: 'Dataverse template updated',
690+
fields: [
691+
{
692+
typeName: 'author',
693+
typeClass: 'compound',
694+
multiple: true,
695+
value: [
696+
{
697+
authorName: { typeName: 'authorName', value: 'Belicheck, Bill' },
698+
authorAffiliation: { typeName: 'authorIdentifierScheme', value: 'ORCID' }
699+
}
700+
]
701+
}
702+
],
703+
instructions: [{ instructionField: 'author', instructionText: 'Updated instructions' }]
704+
}
705+
706+
await updateTemplateMetadata.execute(templateId, payload, replace)
707+
```
708+
709+
_See [use case](../src/templates/domain/useCases/UpdateTemplateMetadata.ts) definition_.
710+
711+
#### Update Template License Terms
712+
713+
Updates either the license name or custom terms of use for a template id.
714+
715+
##### Example call:
716+
717+
```typescript
718+
import { updateTemplateLicenseTerms } from '@iqss/dataverse-client-javascript'
719+
import { UpdateTemplateLicenseTermsDTO } from '@iqss/dataverse-client-javascript'
720+
721+
const templateId = 12345
722+
723+
const payload: UpdateTemplateLicenseTermsDTO = {
724+
customTerms: {
725+
termsOfUse: 'Updated template terms of use'
726+
}
727+
}
728+
729+
await updateTemplateLicenseTerms.execute(templateId, payload)
730+
```
731+
732+
_See [use case](../src/templates/domain/useCases/UpdateTemplateLicenseTerms.ts) definitition_.
733+
734+
#### Update Template Terms Of Access
735+
736+
Updates terms of access for a template id.
737+
738+
##### Example call:
739+
740+
```typescript
741+
import { updateTemplateTermsOfAccess } from '@iqss/dataverse-client-javascript'
742+
743+
const templateId = 12345
744+
745+
await updateTemplateTermsOfAccess.execute(templateId, {
746+
fileAccessRequest: true,
747+
termsOfAccessForRestrictedFiles: 'Restricted access only'
748+
})
749+
```
750+
751+
_See [use case](../src/templates/domain/useCases/UpdateTemplateTermsOfAccess.ts) definition_.
752+
672753
## Datasets
673754

674755
### Datasets Read Use Cases

0 commit comments

Comments
 (0)