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

Hestia Schema

import { JSON, JSONLD, NodeType, SchemaType } from './types';
import { Term } from './Term';
import { Actor } from './Actor';
import { TermTermType } from './Term';
/**
 * Contains all the TermTermType with override on the Organisation.
 * Note: it does not contain the default TermTermType on related Blank Nodes.
 */
export declare const organisationTermTermType: {
    country: TermTermType[];
    region: TermTermType[];
    all: TermTermType[];
};
/**
 * The organisation which manages the [Site](./Site).
 */
export declare class Organisation extends JSON<SchemaType.Organisation> {
    /**
    * The name of the Organisation.
    */
    name?: string;
    /**
    * A description of the Organisation.
    */
    description?: string;
    /**
    * A nested [GeoJSON](https://tools.ietf.org/html/rfc7946) object for the Organisation boundary of type 'FeatureCollection'.
    */
    boundary?: any;
    /**
    * The area of the Organisation in hectares.
    */
    area?: number;
    /**
    * The latitude of the Organisation (-90 to 90).
    */
    latitude?: number;
    /**
    * The longitude of the Organisation (-180 to 180).
    */
    longitude?: number;
    /**
    * The street address.
    */
    streetAddress?: string;
    /**
    * The city or town.
    */
    city?: string;
    /**
    * The most specific geographical region from the [Glossary](/glossary?termType=region).
    */
    region?: Term;
    /**
    * The country name from the [Glossary](/glossary?termType=region).
    */
    country?: Term;
    /**
    * The post office box number.
    */
    postOfficeBoxNumber?: string;
    /**
    * The postal code.
    */
    postalCode?: string;
    /**
    * A link to a website describing the Organisation.
    */
    website?: any;
    /**
    * The [Global Location Number](https://en.wikipedia.org/wiki/Global_Location_Number).
    */
    glnNumber?: string;
    /**
    * The start date of the Organisation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
    */
    startDate?: string;
    /**
    * The end date of the Organisation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
    */
    endDate?: string;
    /**
    * The identifier for these data in the source database.
    */
    originalId?: string;
    /**
    * The user who uploaded these data to Hestia.
    */
    uploadBy?: Actor;
    /**
    * The version of the schema when these data were created.
    */
    schemaVersion?: string;
    /**
    * If these data are private.
    */
    dataPrivate?: boolean;
}
/**
 * The organisation which manages the [Site](./Site).
 */
export interface IOrganisationJSONLD extends JSONLD<NodeType.Organisation> {
    /**
    * A description of the Organisation.
    */
    description?: string;
    /**
    * A nested [GeoJSON](https://tools.ietf.org/html/rfc7946) object for the Organisation boundary of type 'FeatureCollection'.
    */
    boundary?: any;
    /**
    * The area of the Organisation in hectares.
    */
    area?: number;
    /**
    * The latitude of the Organisation (-90 to 90).
    */
    latitude?: number;
    /**
    * The longitude of the Organisation (-180 to 180).
    */
    longitude?: number;
    /**
    * The street address.
    */
    streetAddress?: string;
    /**
    * The city or town.
    */
    city?: string;
    /**
    * The most specific geographical region from the [Glossary](/glossary?termType=region).
    */
    region?: Term;
    /**
    * The country name from the [Glossary](/glossary?termType=region).
    */
    country?: Term;
    /**
    * The post office box number.
    */
    postOfficeBoxNumber?: string;
    /**
    * The postal code.
    */
    postalCode?: string;
    /**
    * A link to a website describing the Organisation.
    */
    website?: any;
    /**
    * The [Global Location Number](https://en.wikipedia.org/wiki/Global_Location_Number).
    */
    glnNumber?: string;
    /**
    * The start date of the Organisation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
    */
    startDate?: string;
    /**
    * The end date of the Organisation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
    */
    endDate?: string;
    /**
    * The identifier for these data in the source database.
    */
    originalId?: string;
    /**
    * The user who uploaded these data to Hestia.
    */
    uploadBy?: Actor;
    /**
    * The version of the schema when these data were created.
    */
    schemaVersion?: string;
    /**
    * If these data are private.
    */
    dataPrivate?: boolean;
}