added new values for related identifier relationships

added new contributor types for Crossref
updated hidden_flag to boolean type
modified CHANGELOG

Signed-off-by: Neal Ensor <ensorn@osti.gov>

Author: nensor

CHANGELOG.md

@@ -36,3 +36,32 @@
 - update requirements to include requests-toolbelt properly, and indicate python >=3.9 versioning
 - remove deprecated/legacy product types from Record definition
 - modified Person requirements to reflect only type and last_name requirements
+
+## 0.3.7 - 11/7/2024
+- maintenance/bugfixes publishing release
+
+## 0.3.8 - 1/8/2025
+- change hidden_flag to boolean
+- adding new relation types for RelatedIdentifier:
+  - BasedOnData
+  - Finances
+  - HasComment
+  - HasDerivation
+  - HasReply
+  - IsBasedOn
+  - IsBasisFor
+  - IsCommentOn
+  - IsDataBasisFor
+  - IsFinancedBy
+  - IsRelatedMaterial
+  - IsReplyTo
+  - IsReviewOf
+- adding new contributor types for Person:
+  - Chair
+  - Reader
+  - Reviewer
+  - ReviewAssistant
+  - ReviewerExternal
+  - StatsReviewer
+  - Translator
+

elinkapi_test.py

@@ -29,7 +29,6 @@
    ],
    "orcid": "0000000155554447",
    "phone": "Optional",
-   "role": "PRIMARY",
    "affiliations": [
     { "name": "Optional" }
    ]

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "elinkapi"
-version = "0.3.7" 
+version = "0.3.8" 
 authors = [
   { name="Jacob Samar", email="samarj@osti.gov" },
   { name="Neal Ensor", email="ensorn@osti.gov" }

src/elinkapi/organization.py

@@ -77,6 +77,12 @@ def validate_ror_id(cls, value: str) -> str:
     Add an identifier to this Organization.
     """
     def add(self, item: Identifier):
+        if self.type is not None and self.type != Organization.Type.SPONSOR:
+            raise ValueError ("Only sponsoring organizations may specify identifiers.")
+        
+        if item.type not in [Identifier.Type.AWARD_DOI, Identifier.Type.CONTRACT_NUMBER, Identifier.Type.DOE_CONTRACT_NUMBER]:
+            raise ValueError ("Organization identifier type is not allowed.")
+        
         if self.identifiers is None:
             self.identifiers=[]
         self.identifiers.append(item)

src/elinkapi/person.py

@@ -16,6 +16,13 @@ class Type(Enum):
         BUSINESS_OFFICIAL="SBIZ_BO"
         PRINCIPAL_INVESTIGATOR="SBIZ_PI"
     class Contribution(Enum):
+        Chair="Chair"
+        Reader="Reader"
+        Reviewer="Reviewer"
+        ReviewAssistant="ReviewAssistant"
+        ReviewerExternal="ReviewerExternal"
+        StatsReviewer="StatsReviewer"
+        Translator="Translator"
         DataCollector="DataCollector"
         DataCurator="DataCurator"
         DataManager="DataManager"

src/elinkapi/record.py

@@ -232,5 +232,5 @@ class RecordResponse(Record):
     date_metadata_updated: datetime.datetime = None
     date_submitted_to_osti_first: datetime.datetime = None
     date_submitted_to_osti_last: datetime.datetime = None
-    hidden_flag: str = None
+    hidden_flag: bool = False
     media: list[MediaInfo] = None

src/elinkapi/related_identifier.py

@@ -25,6 +25,20 @@ class Type(Enum):
         ARXIV="arXiv"
         ARK="ARK"
     class Relation(Enum):
+        BasedOnData="BasedOnData"
+        Finances="Finances"
+        HasComment="HasComment"
+        HasDerivation="HasDerivation"
+        HasReply="HasReply"
+        HasReview="HasReview"
+        IsBasedOn="IsBasedOn"
+        IsBasisFor="IsBasisFor"
+        IsCommentOn="IsCommentOn"
+        IsDataBasisFor="IsDataBasisFor"
+        IsFinancedBy="IsFinancedBy"
+        IsRelatedMaterial="IsRelatedMaterial"
+        IsReployTo="IsReplyTo"
+        IsReviewOf="IsReviewOf"
         IsDescribed_by="IsDescribedBy" 
         Describes="Describes" 
         HasVersion="HasVersion"