@luomus/laji-schema 2.0.25 → 2.0.27

package/dist/dto/SpecimenTransaction.dto.ts

@@ -82,15 +82,15 @@ export class SpecimenTransaction {
    */
   collectionID?: string;
   /**
-   * Select the correspondent organization from a list. If not found on the list, you need to add the new organization first.
+   * Select the counterparty organisation from a list. If not found on the list, you need to add the new organisation first.
    */
   correspondentOrganization?: string;
   /**
-   * Name of the corresponding person. If the transaction goes to a private person, write their postal address here.
+   * Name of the counterparty person. If the transaction goes to a private person, write their postal address here.
    */
   correspondentPerson?: string;
   /**
-   * Receicing researcher in the correspondent organisation for outgoing transactions.
+   * For outgoing transactions the receiving researcher in the counterparty organisation.
    */
   correspondentResearcher?: string;
   damagedCount?: number;
@@ -100,7 +100,7 @@ export class SpecimenTransaction {
    */
   dueDate?: string;
   /**
-   * Sender's ID for the transaction.
+   * Counterparty's ID for the transaction.
    */
   externalID?: string;
   /**
@@ -108,7 +108,7 @@ export class SpecimenTransaction {
    */
   geneticResourceAcquisitionCountry?: string;
   /**
-   * Date when the genetic resource or traditional knowledge was aqcuired.
+   * Date when the genetic resource or traditional knowledge was acquired.
    */
   geneticResourceAcquisitionDate?: string;
   /**
@@ -127,6 +127,9 @@ export class SpecimenTransaction {
    * Choose the type of the genetic resource for statistical and reporting purposes.
    */
   geneticResourceType?: GeneticResourceTypeEnum;
+  /**
+   * Harmonized System code for the customs
+   */
   harmonizedSystemCode?: string;
   /**
    * Whether the resource has an IRCC number or not. If not, more information needs to be filled in.
@@ -141,7 +144,7 @@ export class SpecimenTransaction {
    */
   incomingReturned?: string;
   /**
-   * Private remarks that are shown only in Kotka and not to the corresponding organisation.
+   * Private remarks that are shown only in Kotka and not to the counterparty organisation.
    */
   internalRemarks?: string;
   /**
@@ -152,9 +155,12 @@ export class SpecimenTransaction {
    * Person handling the transaction at local Kotka institution.
    */
   localHandler?: string;
+  /**
+   * Contact email for the person handling the transaction in our museum.
+   */
   localHandlerEmail?: string;
   /**
-   * Person responsible for the transaction in our museum/local Kotka institution
+   * Person responsible for the transaction in our museum/local Kotka institution.
    */
   localPerson?: string;
   /**
@@ -162,7 +168,7 @@ export class SpecimenTransaction {
    */
   localPersonEmail?: string;
   /**
-   * For incoming loans, name of the researcher receiving the loan at our local institution.
+   * For incoming transactions, name of the researcher receiving the loan at our museum/ local Kotka institution.
    */
   localResearcher?: string;
   /**
@@ -176,24 +182,24 @@ export class SpecimenTransaction {
    */
   numberOfParcels?: string;
   /**
-   * Date when the outgoing loan was returned to us
+   * Date when the outgoing loan was returned to us.
    */
   outgoingReturned?: string;
   /**
-   * When the transaction was sent out from us
+   * When the ougoing transaction was sent out from us.
    */
   outgoingSent?: string;
   permits?: Permit[];
   /**
-   * Remarks that are shown to both parties of the transaction.
+   * Remarks that are shown to both parties of the transaction on transaction PDFs.
    */
   publicRemarks?: string;
   /**
-   * When signed loan receipt was received from the loanee
+   * When signed transaction receipt was received (outgoing) or sent (incoming).
    */
   receiptReturned?: string;
   /**
-   * When loan request was received here.
+   * When transaction request was received here.
    */
   requestReceived?: string;
   /**
@@ -203,7 +209,7 @@ export class SpecimenTransaction {
   returnedCount?: number;
   returnedIDs?: string[];
   /**
-   * Whether the transaction is closed, outstanding or in process.
+   * Whether the transaction is closed, outstanding, in process or still on loan..
    */
   status?: StatusEnum;
   transactionEvents?: SpecimenTransactionEvent[];

package/dist/dto/SpecimenTransactionEvent.dto.ts

@@ -12,8 +12,20 @@ export class SpecimenTransactionEvent {
   "@context"?: string;
   id?: string;
   "@type"?: string;
+  /**
+   * Date when the transaction event occurred.
+   */
   eventDate: string;
+  /**
+   * Name of the person who handled the transaction event.
+   */
   eventHandler: string;
+  /**
+   * More information about the transactions event. You can e.g. list the specimens included in the event in this field.
+   */
   eventNotes: string;
+  /**
+   * Type of the transaction event. Return for e.g. partial returns and addition e.g. for when more specimens are added to the transaction later.
+   */
   eventType: EventTypeEnum;
 }

package/dist/types/classes/SpecimenTransaction.d.ts

@@ -76,15 +76,15 @@ export declare class SpecimenTransaction {
      */
     collectionID?: string;
     /**
-     * Select the correspondent organization from a list. If not found on the list, you need to add the new organization first.
+     * Select the counterparty organisation from a list. If not found on the list, you need to add the new organisation first.
      */
     correspondentOrganization?: string;
     /**
-     * Name of the corresponding person. If the transaction goes to a private person, write their postal address here.
+     * Name of the counterparty person. If the transaction goes to a private person, write their postal address here.
      */
     correspondentPerson?: string;
     /**
-     * Receicing researcher in the correspondent organisation for outgoing transactions.
+     * For outgoing transactions the receiving researcher in the counterparty organisation.
      */
     correspondentResearcher?: string;
     damagedCount?: number;
@@ -94,7 +94,7 @@ export declare class SpecimenTransaction {
      */
     dueDate?: string;
     /**
-     * Sender's ID for the transaction.
+     * Counterparty's ID for the transaction.
      */
     externalID?: string;
     /**
@@ -102,7 +102,7 @@ export declare class SpecimenTransaction {
      */
     geneticResourceAcquisitionCountry?: string;
     /**
-     * Date when the genetic resource or traditional knowledge was aqcuired.
+     * Date when the genetic resource or traditional knowledge was acquired.
      */
     geneticResourceAcquisitionDate?: string;
     /**
@@ -121,6 +121,9 @@ export declare class SpecimenTransaction {
      * Choose the type of the genetic resource for statistical and reporting purposes.
      */
     geneticResourceType?: GeneticResourceTypeEnum;
+    /**
+     * Harmonized System code for the customs
+     */
     harmonizedSystemCode?: string;
     /**
      * Whether the resource has an IRCC number or not. If not, more information needs to be filled in.
@@ -135,7 +138,7 @@ export declare class SpecimenTransaction {
      */
     incomingReturned?: string;
     /**
-     * Private remarks that are shown only in Kotka and not to the corresponding organisation.
+     * Private remarks that are shown only in Kotka and not to the counterparty organisation.
      */
     internalRemarks?: string;
     /**
@@ -146,9 +149,12 @@ export declare class SpecimenTransaction {
      * Person handling the transaction at local Kotka institution.
      */
     localHandler?: string;
+    /**
+     * Contact email for the person handling the transaction in our museum.
+     */
     localHandlerEmail?: string;
     /**
-     * Person responsible for the transaction in our museum/local Kotka institution
+     * Person responsible for the transaction in our museum/local Kotka institution.
      */
     localPerson?: string;
     /**
@@ -156,7 +162,7 @@ export declare class SpecimenTransaction {
      */
     localPersonEmail?: string;
     /**
-     * For incoming loans, name of the researcher receiving the loan at our local institution.
+     * For incoming transactions, name of the researcher receiving the loan at our museum/ local Kotka institution.
      */
     localResearcher?: string;
     /**
@@ -170,24 +176,24 @@ export declare class SpecimenTransaction {
      */
     numberOfParcels?: string;
     /**
-     * Date when the outgoing loan was returned to us
+     * Date when the outgoing loan was returned to us.
      */
     outgoingReturned?: string;
     /**
-     * When the transaction was sent out from us
+     * When the ougoing transaction was sent out from us.
      */
     outgoingSent?: string;
     permits?: Permit[];
     /**
-     * Remarks that are shown to both parties of the transaction.
+     * Remarks that are shown to both parties of the transaction on transaction PDFs.
      */
     publicRemarks?: string;
     /**
-     * When signed loan receipt was received from the loanee
+     * When signed transaction receipt was received (outgoing) or sent (incoming).
      */
     receiptReturned?: string;
     /**
-     * When loan request was received here.
+     * When transaction request was received here.
      */
     requestReceived?: string;
     /**
@@ -197,7 +203,7 @@ export declare class SpecimenTransaction {
     returnedCount?: number;
     returnedIDs?: string[];
     /**
-     * Whether the transaction is closed, outstanding or in process.
+     * Whether the transaction is closed, outstanding, in process or still on loan..
      */
     status?: StatusEnum;
     transactionEvents?: SpecimenTransactionEvent[];

package/dist/types/classes/SpecimenTransactionEvent.d.ts

@@ -6,8 +6,20 @@ export declare class SpecimenTransactionEvent {
     "@context"?: string;
     id?: string;
     "@type"?: string;
+    /**
+     * Date when the transaction event occurred.
+     */
     eventDate: string;
+    /**
+     * Name of the person who handled the transaction event.
+     */
     eventHandler: string;
+    /**
+     * More information about the transactions event. You can e.g. list the specimens included in the event in this field.
+     */
     eventNotes: string;
+    /**
+     * Type of the transaction event. Return for e.g. partial returns and addition e.g. for when more specimens are added to the transaction later.
+     */
     eventType: EventTypeEnum;
 }

package/dist/types/models/SpecimenTransaction.d.ts

@@ -27,15 +27,15 @@ export interface SpecimenTransaction {
      */
     collectionID?: string;
     /**
-     * Select the correspondent organization from a list. If not found on the list, you need to add the new organization first.
+     * Select the counterparty organisation from a list. If not found on the list, you need to add the new organisation first.
      */
     correspondentOrganization?: string;
     /**
-     * Name of the corresponding person. If the transaction goes to a private person, write their postal address here.
+     * Name of the counterparty person. If the transaction goes to a private person, write their postal address here.
      */
     correspondentPerson?: string;
     /**
-     * Receicing researcher in the correspondent organisation for outgoing transactions.
+     * For outgoing transactions the receiving researcher in the counterparty organisation.
      */
     correspondentResearcher?: string;
     damagedCount?: number;
@@ -45,7 +45,7 @@ export interface SpecimenTransaction {
      */
     dueDate?: string;
     /**
-     * Sender's ID for the transaction.
+     * Counterparty's ID for the transaction.
      */
     externalID?: string;
     /**
@@ -53,7 +53,7 @@ export interface SpecimenTransaction {
      */
     geneticResourceAcquisitionCountry?: string;
     /**
-     * Date when the genetic resource or traditional knowledge was aqcuired.
+     * Date when the genetic resource or traditional knowledge was acquired.
      */
     geneticResourceAcquisitionDate?: string;
     /**
@@ -72,6 +72,9 @@ export interface SpecimenTransaction {
      * Choose the type of the genetic resource for statistical and reporting purposes.
      */
     geneticResourceType?: GeneticResourceTypeEnum;
+    /**
+     * Harmonized System code for the customs
+     */
     harmonizedSystemCode?: string;
     /**
      * Whether the resource has an IRCC number or not. If not, more information needs to be filled in.
@@ -86,7 +89,7 @@ export interface SpecimenTransaction {
      */
     incomingReturned?: string;
     /**
-     * Private remarks that are shown only in Kotka and not to the corresponding organisation.
+     * Private remarks that are shown only in Kotka and not to the counterparty organisation.
      */
     internalRemarks?: string;
     /**
@@ -97,9 +100,12 @@ export interface SpecimenTransaction {
      * Person handling the transaction at local Kotka institution.
      */
     localHandler?: string;
+    /**
+     * Contact email for the person handling the transaction in our museum.
+     */
     localHandlerEmail?: string;
     /**
-     * Person responsible for the transaction in our museum/local Kotka institution
+     * Person responsible for the transaction in our museum/local Kotka institution.
      */
     localPerson?: string;
     /**
@@ -107,7 +113,7 @@ export interface SpecimenTransaction {
      */
     localPersonEmail?: string;
     /**
-     * For incoming loans, name of the researcher receiving the loan at our local institution.
+     * For incoming transactions, name of the researcher receiving the loan at our museum/ local Kotka institution.
      */
     localResearcher?: string;
     /**
@@ -121,24 +127,24 @@ export interface SpecimenTransaction {
      */
     numberOfParcels?: string;
     /**
-     * Date when the outgoing loan was returned to us
+     * Date when the outgoing loan was returned to us.
      */
     outgoingReturned?: string;
     /**
-     * When the transaction was sent out from us
+     * When the ougoing transaction was sent out from us.
      */
     outgoingSent?: string;
     permits?: Permit[];
     /**
-     * Remarks that are shown to both parties of the transaction.
+     * Remarks that are shown to both parties of the transaction on transaction PDFs.
      */
     publicRemarks?: string;
     /**
-     * When signed loan receipt was received from the loanee
+     * When signed transaction receipt was received (outgoing) or sent (incoming).
      */
     receiptReturned?: string;
     /**
-     * When loan request was received here.
+     * When transaction request was received here.
      */
     requestReceived?: string;
     /**
@@ -148,7 +154,7 @@ export interface SpecimenTransaction {
     returnedCount?: number;
     returnedIDs?: string[];
     /**
-     * Whether the transaction is closed, outstanding or in process.
+     * Whether the transaction is closed, outstanding, in process or still on loan..
      */
     status?: StatusEnum;
     transactionEvents?: SpecimenTransactionEvent[];

package/dist/types/models/SpecimenTransactionEvent.d.ts

@@ -3,8 +3,20 @@ export interface SpecimenTransactionEvent {
     "@context"?: string;
     id?: string;
     "@type"?: string;
+    /**
+     * Date when the transaction event occurred.
+     */
     eventDate: string;
+    /**
+     * Name of the person who handled the transaction event.
+     */
     eventHandler: string;
+    /**
+     * More information about the transactions event. You can e.g. list the specimens included in the event in this field.
+     */
     eventNotes: string;
+    /**
+     * Type of the transaction event. Return for e.g. partial returns and addition e.g. for when more specimens are added to the transaction later.
+     */
     eventType: EventTypeEnum;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luomus/laji-schema",
-  "version": "2.0.25",
+  "version": "2.0.27",
   "description": "Common autogenerated Typescript interfaces and classes for the schemas used by LUOMUS.",
   "license": "MIT",
   "scripts": {