@studyportals/domain-client 6.0.0 → 6.1.0-beta.0

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-review-rating.ts

@@ -0,0 +1,30 @@
+export interface IReviewRating {
+
+	/**
+	 * The average rating of the reviews on 10-point scale.
+	 *
+	 * @return number
+	 */
+	getAverage(): number;
+
+	/**
+	 * The number of reviews that contributed to the average rating.
+	 *
+	 * @return number
+	 */
+	getQuantity(): number;
+
+	/**
+	 * Checks if the rating has enough reviews to be considered valid.
+	 *
+	 * @return boolean
+	 */
+	hasEnoughQuantity(): boolean;
+
+	/**
+	 * Gets the average star rating based on the average score on 5-point scale.
+	 *
+	 * @return number
+	 */
+	getAverageStarRating(): number;
+}

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/copilot-country/copilot-country-client.ts

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

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

@@ -0,0 +1,46 @@
+import { ICopilotRankingCard } from "./i-copilot-ranking-card";
+
+export interface ICopilotCountry {
+
+	/**
+	 * How to apply in country x text
+	 *
+	 * @return string | null
+	 */
+	getHowToApplyText(): string | null;
+
+	/**
+	 * Id of the country.
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * ISO code ALPHA-2
+	 *
+	 * @return string
+	 */
+	getIsoCode(): string;
+
+	/**
+	 * Country title
+	 *
+	 * @return string
+	 */
+	getTitle(): string;
+
+	/**
+	 * Why study in country x text
+	 *
+	 * @return string | null
+	 */
+	getWhyText(): string | null;
+
+	/**
+	 * Top universities of the country
+	 *
+	 * @return ICopilotRankingCard[] | null
+	 */
+	getTopUniversities(): ICopilotRankingCard[] | null;
+}

package/src/models/copilot-country/i-copilot-ranking-card.ts

@@ -0,0 +1,39 @@
+export interface ICopilotRankingCard {
+	/**
+	 * Get the organisation id.
+	 *
+	 * @return number
+	 */
+	getOrganisationId(): number;
+	/**
+	 * Get the organisation name.
+	 *
+	 * @return string | null
+	 */
+	getOrganisationName(): string | null;
+	/**
+	 * Get the organisation homepage link.
+	 *
+	 * @return string | null
+	 */
+	getOrganisationPageUrl(): string | null;
+	/**
+	 * Get the organisation logo url.
+	 *
+	 * @return string | null
+	 */
+	getOrganisationLogoUrl(): string | null;
+	/**
+	 * Verifies if the organisation's logo can be displayed.
+	 *
+	 * @return boolean
+	 */
+	hasOrganisationLogo(): boolean;
+
+	/**
+	 * Retrieves the ranking position for the organisation in the Studyportals ranking in the country of the university.
+	 *
+	 * @return number | null
+	 */
+	getPositionInCountry(): number | null;
+}

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

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

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

@@ -0,0 +1,147 @@
+import { IEnglishRequirements, IGPARequirement, IGeoTargetingValues, IInternalLink, ILink, ILivingCost, ITiming, ITuitionValues } from "../../..";
+
+export interface ICopilotProgramme {
+
+	/**
+	 * Get country the programme is taught in
+	 *
+	 * @return number[]
+	 */
+	getCountryIds(): number[];
+
+	/**
+	 * Get country iso codes the programme is taught in
+	 *
+	 * @return string[]
+	 */
+	getCountryIsoCodes(): string[];
+
+	/**
+	 * Get discipline ids attached to this programme
+	 *
+	 * @return number[]
+	 */
+	getDisciplineIds(): number[];
+
+	/**
+	 * Education level
+	 *
+	 * @return string
+	 */
+	getEducationalLevel(): string;
+
+	/**
+	 * English level requirements.
+	 *
+	 * @return IEnglishRequirements
+	 */
+	getEnglishRequirements(): IEnglishRequirements;
+
+	/**
+	 * GPA Requirements
+	 *
+	 * @return IGPARequirement | null
+	 */
+	getGPA(): IGPARequirement | null;
+
+	getGeneralRequirements(): string | null;
+
+	/**
+	 * Get geotargetting settings for the programme
+	 *
+	 * @return IGeoTargetingValues
+	 */
+	getGeoTargetingValues(): IGeoTargetingValues;
+
+	getGlobalUniversityRanking(): string | null;
+
+	/**
+	 * Id of the programme.
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * The programmes estimated living cost
+	 *
+	 * @return ILivingCost | null
+	 */
+	getLivingCost(): ILivingCost | 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;
+
+	/**
+	 * Summary of the programme.
+	 *
+	 * @return string
+	 */
+	getSummary(): string;
+
+	/**
+	 * Get all start dates
+	 *
+	 * @return ITiming[]
+	 */
+	getTimings(): ITiming[];
+
+	/**
+	 * Title of the programme.
+	 *
+	 * @return string
+	 */
+	getTitle(): string;
+
+	/**
+	 * The programmes tuition fees
+	 *
+	 * @return ITuitionValues | null
+	 */
+	getTuitionValues(): ITuitionValues | null;
+
+	/**
+	 * University id
+	 *
+	 * @return number
+	 */
+	getUniversityId(): number;
+
+	/**
+	 * Get a link to the programme's university page.
+	 *
+	 * The link contains the page path as url and the university name as the
+	 * link description.
+	 *
+	 * @return ILink
+	 */
+	getUniversityLink(): ILink;
+
+	/**
+	 * University title
+	 *
+	 * @return string
+	 */
+	getUniversityTitle(): string;
+
+	/**
+	 * Work experience requirements in years
+	 *
+	 * @return number | null
+	 */
+	getWorkExperienceYears(): number | null;
+
+	/**
+	 * Is programme public
+	 *
+	 * @return boolean
+	 */
+	isPublic(): boolean;
+}

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

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

package/src/models/customerio-organisation/i-customer-io-organisation.ts

@@ -0,0 +1,62 @@
+import { ICity, ICountry, IReview } from "../../..";
+
+export interface ICustomerIOOrganisation {
+
+	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/customerio-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/customerio-programme/customerio-programme-client.ts

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

package/src/models/customerio-programme/i-customer-io-programme.ts

@@ -0,0 +1,129 @@
+import { ICountry, IEnglishRequirements, IInternalLink, ILogo, ITiming, ITuitionFee } from "../../..";
+
+export interface ICustomerIOProgramme {
+
+	/**
+	 * Campaign type of the campaign the programme is attached to
+	 *
+	 * @return number
+	 */
+	getCampaignType(): number;
+
+	canShowCampaignType(): boolean;
+
+	/**
+	 * Get country the programme is teached in
+	 *
+	 * @return ICountry
+	 */
+	getCountry(): ICountry;
+
+	canShowCountry(): boolean;
+
+	/**
+	 * Get discipline ids attached to this programme
+	 *
+	 * @return number[]
+	 */
+	getDisciplineIds(): number[];
+
+	/**
+	 * Education level
+	 *
+	 * @return string
+	 */
+	getEducationalLevel(): string;
+
+	/**
+	 * English level requirements.
+	 *
+	 * @return IEnglishRequirements
+	 */
+	getEnglishRequirements(): IEnglishRequirements;
+
+	/**
+	 * Id of the programme.
+	 *
+	 * @return number
+	 */
+	getId(): number;
+
+	/**
+	 * The last time the programme has been updated and verified
+	 *
+	 * @return Date
+	 */
+	getLastUpdated(): Date;
+
+	/**
+	 * University logo url
+	 *
+	 * @return ILogo
+	 */
+	getLogo(): ILogo;
+
+	canShowLogo(): boolean;
+
+	/**
+	 * 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 rating
+	 *
+	 * @return number
+	 */
+	getReviewRating(): number;
+
+	canShowReviewRating(): boolean;
+
+	/**
+	 * Get all start dates
+	 *
+	 * @return ITiming[]
+	 */
+	getTimings(): ITiming[];
+
+	/**
+	 * Title of the programme.
+	 *
+	 * @return string
+	 */
+	getTitle(): string;
+
+	/**
+	 * The programmes tuition fees
+	 *
+	 * @return ITuitionFee[]
+	 */
+	getTuitionFees(): ITuitionFee[];
+
+	canShowTuitionFees(): boolean;
+
+	/**
+	 * University id
+	 *
+	 * @return number
+	 */
+	getUniversityId(): number;
+
+	/**
+	 * University title
+	 *
+	 * @return string
+	 */
+	getUniversityTitle(): string;
+
+	/**
+	 * Is programme public
+	 *
+	 * @return boolean
+	 */
+	isPublic(): boolean;
+}

package/src/models/customerio-programme/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;
+}