citeright-sdk-js
Version:
An SDK to connect to the CiteRight API.
94 lines (93 loc) • 2.72 kB
TypeScript
import { Citation } from './Citation';
import { Jurisdiction } from './Jurisdiction';
export declare class ItemDTO {
id: string;
/**
* Type of the item. eg: case or legislation.
*/
itemType: 'case' | 'legislation' | 'unrecognized';
/**
* URL, "the source" of the item text/data.
*/
url: string;
/**
* CanLii shortened-URL for this item.
*/
canLiiUrl: string;
timestampAccessed: Date;
/**
* Transient field. Marks the item as temporary (not persisted in the db).
* Usually this means the user created an item manually, for a document.
*/
temporary?: boolean;
edited?: boolean;
/**
* Synthetic field, consisting of caseName + "full citation"
* (either neutral citation or semi-official or unofficial)
*/
fullCitationHtml?: string;
/**
* Synthetic field, constisting of caseName + "full citation"
* (either neutral citation or semi-official or unofficial)
*/
fullCitationPlaintext?: string;
/**
* Case name, i.e. "Beals v. Saldanha"
*/
caseName: string;
/**
* Place of jurisdiction.
*/
jurisdiction: Jurisdiction[];
/**
* Jurisdiction court.
*/
court: string;
/**
* Place of hearing.
*/
place: string;
/**
* Court docket number.
*/
docketNumber: string;
reporterYearAsVolume: string;
reporterVolume: string;
reporter: string;
reporterFirstPage: string;
dateDecided: string;
datePublished: string;
dateFiling: string;
/** Citation to display in the UI, based on reference citation */
displayCitation: string;
referenceCitation: Citation;
otherCitations: Citation[];
/**
* In some cases, there might be a default short title for the item.
*/
defaultShortTitle: string;
/**
* Start of legislation enforcement. Format is YYYY-MM-DD.
*/
legislationInForceStart: string;
/**
* End of legislation enforcement. Format is YYYY-MM-DD.
*/
legislationInForceEnd: string;
/**
* One of PinpointType enums.
*/
pinpointType: string;
parserVersion: number;
parserName: string;
/**
* This is a globally unique identifier that helps us identify a case and it's source. The identifier
* is made up of a source and id. In the case of westlaw for example, WL:I10b717d4fcba63f0e0440003ba0d6c6d
* refers to Beals v. Saldanha as found on westlaw.com.
*/
vendorDocumentIdentifier: string;
/**
* The date at which this item was downloaded
*/
createdAt: string;
}