@hestia-earth/schema/Actor.d.ts

Hestia Schema

import { JSON, JSONLD, NodeType, SchemaType } from './types';
import { Term } from './Term';
import { TermTermType } from './Term';
/**
 * Contains all the TermTermType with override on the Actor.
 * Note: it does not contain the default TermTermType on related Blank Nodes.
 */
export declare const actorTermTermType: {
    country: TermTermType[];
    all: TermTermType[];
};
/**
 * A person or institution.
 */
export declare class Actor extends JSON<SchemaType.Actor> {
    /**
    * An automatically generated field made up of: firstName initial, lastName, primaryInstitution. If the Actor is an institution, the lastName only.
    */
    name?: string;
    /**
    * The Actor's first name.
    */
    firstName?: string;
    /**
    * The Actor's last name or the name of the institution.
    */
    lastName?: string;
    /**
    * The Actor's [ORCiD](https://orcid.org/) identifier.
    */
    orcid?: string;
    /**
    * The Actor's [Scopus](https://www.scopus.com/) identifier.
    */
    scopusID?: string;
    /**
    * The Actor's primary institution.
    */
    primaryInstitution?: string;
    /**
    * A city or town.
    */
    city?: string;
    /**
    * The country name from the [Glossary](/glossary?termType=region), following [GADM](https://gadm.org/) naming conventions.
    */
    country?: Term;
    /**
    * The email address of the Actor.
    */
    email?: string;
    /**
    * A link to a website describing the Actor.
    */
    website?: any;
    /**
    * The identifier for these data in the source database (e.g. if the data were converted from openLCA or ecoinvent, the id field from that database).
    */
    originalId?: string;
    /**
    * The version of the schema when these data were created.
    */
    schemaVersion?: string;
    /**
    * If these data are private.
    */
    dataPrivate?: boolean;
}
/**
 * A person or institution.
 */
export interface IActorJSONLD extends JSONLD<NodeType.Actor> {
    /**
    * The Actor's first name.
    */
    firstName?: string;
    /**
    * The Actor's last name or the name of the institution.
    */
    lastName?: string;
    /**
    * The Actor's [ORCiD](https://orcid.org/) identifier.
    */
    orcid?: string;
    /**
    * The Actor's [Scopus](https://www.scopus.com/) identifier.
    */
    scopusID?: string;
    /**
    * The Actor's primary institution.
    */
    primaryInstitution?: string;
    /**
    * A city or town.
    */
    city?: string;
    /**
    * The country name from the [Glossary](/glossary?termType=region), following [GADM](https://gadm.org/) naming conventions.
    */
    country?: Term;
    /**
    * The email address of the Actor.
    */
    email?: string;
    /**
    * A link to a website describing the Actor.
    */
    website?: any;
    /**
    * The identifier for these data in the source database (e.g. if the data were converted from openLCA or ecoinvent, the id field from that database).
    */
    originalId?: string;
    /**
    * The version of the schema when these data were created.
    */
    schemaVersion?: string;
    /**
    * If these data are private.
    */
    dataPrivate?: boolean;
}