@studyportals/domain-client 3.17.1 → 3.18.0

package/src/models/bestfit-programme/i-best-fit-programme.ts

@@ -0,0 +1,102 @@
+import { ICity, IEnglishRequirements, IGPARequirement, ILivingCost, ITuitionFee } from "../../..";
+
+export interface IBestFitProgramme {
+
+	/**
+	 * Average university ranking across multiple ranking institutes.
+	 *
+	 * @return number
+	 */
+	getAverageRankingPosition(): number;
+
+	canShowAverageRankingPosition(): boolean;
+
+	/**
+	 * City which programme is given in
+	 *
+	 * @return ICity
+	 */
+	getCity(): ICity;
+
+	/**
+	 * Get country id the programme is teached in
+	 *
+	 * @return number
+	 */
+	getCountryId(): number;
+
+	/**
+	 * Discipline ids which the program is linked to.
+	 *
+	 * @return number[]
+	 */
+	getDisciplineIds(): number[];
+
+	canShowDisciplineIds(): boolean;
+
+	/**
+	 * English level requirements.
+	 *
+	 * @return IEnglishRequirements
+	 */
+	getEnglishRequirements(): IEnglishRequirements;
+
+	/**
+	 * GPA requirements
+	 *
+	 * @return IGPARequirement
+	 */
+	getGPA(): IGPARequirement;
+
+	canShowGPA(): boolean;
+
+	/**
+	 * Id of the programme.
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * Estimated living cost based on universities location.
+	 *
+	 * @return ILivingCost
+	 */
+	getLivingCost(): ILivingCost;
+
+	canShowLivingCost(): boolean;
+
+	/**
+	 * Minimum required education level
+	 *
+	 * @return string | null
+	 */
+	getRequiredEducationalLevel(): string | null;
+
+	canShowRequiredEducationalLevel(): boolean;
+
+	/**
+	 * The programmes tuition fees
+	 *
+	 * @return ITuitionFee[]
+	 */
+	getTuitionFees(): ITuitionFee[];
+
+	canShowTuitionFees(): boolean;
+
+	/**
+	 * Amount of years required as work experience
+	 *
+	 * @return number
+	 */
+	getWorkExperienceYears(): number;
+
+	canShowWorkExperienceYears(): boolean;
+
+	/**
+	 * Indicates whenever a programme is fully online or not
+	 *
+	 * @return boolean
+	 */
+	isFullyOnline(): boolean;
+}

package/src/models/bestfit-programme/i-city.ts

@@ -0,0 +1,16 @@
+export interface ICity {
+
+	/**
+	 * Get city id
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * Get city name
+	 *
+	 * @return string
+	 */
+	getName(): string;
+}

package/src/models/bestfit-programme/i-living-cost.ts

@@ -0,0 +1,23 @@
+export interface ILivingCost {
+
+	/**
+	 * Get the applicable currency.
+	 *
+	 * @return string
+	 */
+	getCurrency(): string;
+
+	/**
+	 * Get the maximum living cost in the provided currency.
+	 *
+	 * @return number
+	 */
+	getMax(): number;
+
+	/**
+	 * Get the minimum living cost in the provided currency.
+	 *
+	 * @return number
+	 */
+	getMin(): number;
+}

package/src/models/common/i-city.ts

@@ -0,0 +1,16 @@
+export interface ICity {
+
+	/**
+	 * Get city id
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * Get city name
+	 *
+	 * @return string
+	 */
+	getName(): string;
+}

package/src/models/common/i-country.ts

@@ -0,0 +1,23 @@
+export interface ICountry {
+
+	/**
+	 * Get country iso code
+	 *
+	 * @return string
+	 */
+	getISOCode(): string;
+
+	/**
+	 * Get country id
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * Get country name
+	 *
+	 * @return string
+	 */
+	getName(): string;
+}

package/src/models/common/i-english-requirements.ts

@@ -0,0 +1,56 @@
+export interface IEnglishRequirements {
+
+	/**
+	 * Required score for Cambridge english
+	 *
+	 * @return number
+	 */
+	getCambridgeEnglish(): number;
+
+	canShowCambridgeEnglish(): boolean;
+
+	/**
+	 * Required score for Duolingo
+	 *
+	 * @return number
+	 */
+	getDuolingo(): number;
+
+	canShowDuolingo(): boolean;
+
+	/**
+	 * Required score for IELTS tests
+	 *
+	 * @return number
+	 */
+	getIELTS(): number;
+
+	canShowIELTS(): boolean;
+
+	/**
+	 * Required score for PTE
+	 *
+	 * @return number
+	 */
+	getPTE(): number;
+
+	canShowPTE(): boolean;
+
+	/**
+	 * Required score for TOEFL internet
+	 *
+	 * @return number
+	 */
+	getTOEFLInternet(): number;
+
+	canShowTOEFLInternet(): boolean;
+
+	/**
+	 * Required score for TOEFL paper
+	 *
+	 * @return number
+	 */
+	getTOEFLPaper(): number;
+
+	canShowTOEFLPaper(): boolean;
+}

package/src/models/common/i-g-p-a-requirement.ts

@@ -0,0 +1,23 @@
+export interface IGPARequirement {
+
+	/**
+	 * The used GPA scale for this requirement
+	 *
+	 * @return string
+	 */
+	getScale(): string;
+
+	/**
+	 * Required minimum score.
+	 *
+	 * @return string
+	 */
+	getScore(): string;
+
+	/**
+	 * Is GPA recommended or required.
+	 *
+	 * @return boolean
+	 */
+	isRequired(): boolean;
+}

package/src/models/common/i-internal-link.ts

@@ -0,0 +1,32 @@
+export interface IInternalLink {
+
+	/**
+	 * Get an optional text describing the link (typically <a>-tags contents).
+	 *
+	 * @return string
+	 * @throws PropertyNotAvailableException
+	 */
+	getDescription(): string;
+
+	canShowDescription(): boolean;
+
+	/**
+	 * Returns on which portal a this link should link towards.
+	 *
+	 * @return string
+	 */
+	getPortalType(): string;
+
+	/**
+	 * Get the url to refer to.
+	 *
+	 * Note that the url provided is always a relative URL. A base URL is needed
+	 * to make it a full valid path.
+	 * The only exception is when an external link is provided (meaning, outside
+	 * of StudyPortals-maintained domains). In this case a full url will be
+	 * provided.
+	 *
+	 * @return string
+	 */
+	getUrl(): string;
+}

package/src/models/common/i-logo.ts

@@ -0,0 +1,16 @@
+export interface ILogo {
+
+	/**
+	 * Get the file ID of the logo.
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * Get the imgix URL of the logo.
+	 *
+	 * @return string
+	 */
+	getSource(): string;
+}

package/src/models/common/i-tuition-fee.ts

@@ -0,0 +1,57 @@
+export interface ITuitionFee {
+
+	/**
+	 * Get the tuition amount per unit in the provided currency.
+	 *
+	 * Note: all transformable units will be converted to yearly amounts. This
+	 * includes per semester and full programme tuition fees.
+	 *
+	 * @return number
+	 */
+	getAmount(): number;
+
+	/**
+	 * Get the applicable currency.
+	 *
+	 * @return string
+	 */
+	getCurrency(): string;
+
+	/**
+	 * Get the original tuition amount before any transformation step.
+	 *
+	 * @return number
+	 */
+	getOriginalAmount(): number;
+
+	/**
+	 * Get the original tuition unit before any transformation step.
+	 *
+	 * @return string
+	 */
+	getOriginalUnit(): string;
+
+	/**
+	 * Get targeted audience (national, international, eea, etc).
+	 *
+	 * @return string
+	 */
+	getTarget(): string;
+
+	/**
+	 * Get the unit the tuition fee applies for.
+	 *
+	 * Note: all transformable units will be converted to 'year'. This means
+	 * this value will be either 'year', 'module' or 'credit'.
+	 *
+	 * @return string
+	 */
+	getUnit(): string;
+
+	/**
+	 * True if the study is free for this target audience.
+	 *
+	 * @return boolean
+	 */
+	isFree(): boolean;
+}

package/src/models/compare-programme/compare-programme-client.ts

@@ -0,0 +1,16 @@
+import { ICompareProgramme } from "../../..";
+import { ModelClient } from "../../model-client";
+
+export class CompareProgrammeClient extends ModelClient<ICompareProgramme> {
+	protected getModelName(): string {
+		return 'compare-programme';
+	}
+
+	protected getVersion(): string {
+		return 'v1';
+	}
+
+	public isPublic(): boolean {
+		return false;
+	}
+}

package/src/models/compare-programme/i-compare-programme.ts

@@ -0,0 +1,126 @@
+import { IDuration, IEnglishRequirements, IGPARequirement, IInternalLink, ILink, ILivingCost, ILocation, ITiming, ITuitionFee } from "../../..";
+
+export interface ICompareProgramme {
+
+	/**
+	 * Degree of programme
+	 *
+	 * @return string
+	 */
+	getDegree(): string;
+
+	/**
+	 * Duration of the programme
+	 *
+	 * @return IDuration | null
+	 */
+	getDuration(): IDuration | null;
+
+	/**
+	 * English level requirements.
+	 *
+	 * @return IEnglishRequirements
+	 */
+	getEnglishRequirements(): IEnglishRequirements;
+
+	/**
+	 * GPA requirements
+	 *
+	 * @return IGPARequirement | null
+	 */
+	getGPA(): IGPARequirement | null;
+
+	/**
+	 * Id of the programme.
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * Estimated living cost based on universities' location.
+	 *
+	 * @return ILivingCost | null
+	 */
+	getLivingCost(): ILivingCost | null;
+
+	/**
+	 * Indicates where a programme is taught
+	 *
+	 * @return ILocation | null
+	 */
+	getLocation(): ILocation | null;
+
+	/**
+	 * Get a link to the programme page.
+	 *
+	 * The link contains the page path as url and the programme name as the
+	 * link description.
+	 *
+	 * @return IInternalLink
+	 */
+	getProgrammeLink(): IInternalLink;
+
+	/**
+	 * The universities review quantity
+	 *
+	 * @return number | null
+	 */
+	getReviewQuantity(): number | null;
+
+	/**
+	 * The universities review rating
+	 *
+	 * @return number | null
+	 */
+	getReviewRating(): number | null;
+
+	/**
+	 * Get all start dates
+	 *
+	 * @return ITiming[]
+	 */
+	getTimings(): ITiming[];
+
+	/**
+	 * Title of the programme.
+	 *
+	 * @return string
+	 */
+	getTitle(): string;
+
+	/**
+	 * The programmes tuition fees
+	 *
+	 * @return ITuitionFee[]
+	 */
+	getTuitionFees(): ITuitionFee[];
+
+	/**
+	 * Returns a link to the university
+	 *
+	 * @return ILink
+	 */
+	getUniversityLink(): ILink;
+
+	/**
+	 * Amount of years required as work experience
+	 *
+	 * @return number | null
+	 */
+	getWorkExperienceYears(): number | null;
+
+	/**
+	 * Indicates whenever a programme is fully online or not
+	 *
+	 * @return boolean
+	 */
+	isFullyOnline(): boolean;
+
+	/**
+	 * Is programme public
+	 *
+	 * @return boolean
+	 */
+	isPublic(): boolean;
+}

package/src/models/dotdigital-organisation/dotdigital-organisation-client.ts

@@ -0,0 +1,16 @@
+import { IDotDigitalOrganisation } from "../../..";
+import { ModelClient } from "../../model-client";
+
+export class DotdigitalOrganisationClient extends ModelClient<IDotDigitalOrganisation> {
+	protected getModelName(): string {
+		return 'dotdigital-organisation';
+	}
+
+	protected getVersion(): string {
+		return 'v1';
+	}
+
+	public isPublic(): boolean {
+		return false;
+	}
+}

package/src/models/dotdigital-organisation/i-dot-digital-organisation.ts

@@ -0,0 +1,62 @@
+import { ICity, ICountry, IReview } from "../../..";
+
+export interface IDotDigitalOrganisation {
+
+	getAboutCareer(): string | null;
+
+	getAboutEducation(): string | null;
+
+	getAboutHistory(): string | null;
+
+	getAboutResearch(): string | null;
+
+	getAcademicStaff(): number | null;
+
+	getAmountOfProgrammes(): number;
+
+	getAverageStudentRating(): number | null;
+
+	getCity(): ICity;
+
+	getCountry(): ICountry;
+
+	getCoverUrl(): string | null;
+
+	getFemaleStudents(): number | null;
+
+	getId(): number;
+
+	getLogoUrl(): string | null;
+
+	getName(): string | null;
+
+	getOrganisationUrl(): string;
+
+	/**
+	 * @return string[] | null
+	 */
+	getReasons(): string[] | null;
+
+	/**
+	 * @return IReview[]
+	 */
+	getReviews(): IReview[];
+
+	getServicesHousing(): string | null;
+
+	getServicesICT(): string | null;
+
+	getServicesLibrary(): string | null;
+
+	getServicesMedical(): string | null;
+
+	getServicesStudent(): string | null;
+
+	getStudentLifeCampus(): string | null;
+
+	getStudentLifeSport(): string | null;
+
+	getStudents(): number | null;
+
+	getStudentsInternational(): number | null;
+}

package/src/models/dotdigital-organisation/i-review.ts

@@ -0,0 +1,12 @@
+export interface IReview {
+
+	getEndDate(): Date | null;
+
+	getRating(): number;
+
+	getReview(): string | null;
+
+	getStartDate(): Date | null;
+
+	getTitle(): string | null;
+}

package/src/models/dotdigital-programme/dotdigital-programme-client.ts

@@ -0,0 +1,16 @@
+import { IDotDigitalProgramme } from "../../..";
+import { ModelClient } from "../../model-client";
+
+export class DotdigitalProgrammeClient extends ModelClient<IDotDigitalProgramme> {
+	protected getModelName(): string {
+		return 'dotdigital-programme';
+	}
+
+	protected getVersion(): string {
+		return 'v1';
+	}
+
+	public isPublic(): boolean {
+		return false;
+	}
+}