@studyportals/domain-client 3.18.0 → 3.19.0

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

@@ -1,16 +0,0 @@
-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

@@ -1,62 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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;
-	}
-}

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

@@ -1,122 +0,0 @@
-import { ICountry, IEnglishRequirements, IInternalLink, ILogo, ITuitionFee } from "../../..";
-
-export interface IDotDigitalProgramme {
-
-	/**
-	 * 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;
-
-	/**
-	 * 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/dotdigital-programme/i-internal-link.ts

@@ -1,32 +0,0 @@
-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/programme-card/i-click-tracking-data.ts

@@ -1,8 +0,0 @@
-export interface IClickTrackingData {
-
-	getAction(): string;
-
-	getCategory(): string;
-
-	getLabel(): string;
-}

package/src/models/programme-card/i-cover.ts

@@ -1,16 +0,0 @@
-export interface ICover {
-
-	/**
-	 * Get the file ID of the cover (as known in the system)
-	 *
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * Get the source URL for the cover.
-	 *
-	 * @return string
-	 */
-	getSource(): string;
-}

package/src/models/programme-card/i-deadline.ts

@@ -1,23 +0,0 @@
-export interface IDeadline {
-
-	/**
-	 * Get the date this deadline expires on.
-	 *
-	 * @return Date
-	 */
-	getDate(): Date;
-
-	/**
-	 * Get the deadline type (e.g. general, national, eea, etc).
-	 *
-	 * @return string
-	 */
-	getType(): string;
-
-	/**
-	 * True if the deadline has passed (e.g. you can't apply anymore).
-	 *
-	 * @return boolean
-	 */
-	isPassed(): boolean;
-}

package/src/models/programme-card/i-duration.ts

@@ -1,46 +0,0 @@
-export interface IDuration {
-
-	/**
-	 * Get the amount of periods the programme takes to complete.
-	 *
-	 * Note: Durations of more than 70 days (with period === 'days') are
-	 * automatically calculated back to an amount of months.
-	 *
-	 * @return number
-	 */
-	getAmount(): number;
-
-	/**
-	 * Get an optional textual description of the duration.
-	 *
-	 * @return string
-	 * @throws PropertyNotAvailableException
-	 */
-	getDescription(): string;
-
-	canShowDescription(): boolean;
-
-	/**
-	 * Get the original duration amount before any calculations.
-	 *
-	 * @return number
-	 */
-	getOriginalDuration(): number;
-
-	/**
-	 * Get the original duration period before any calculations.
-	 *
-	 * @return string
-	 */
-	getOriginalPeriod(): string;
-
-	/**
-	 * Get the period this duration is provided in (days or months).
-	 *
-	 * Note: Durations of more than 70 days (with period === 'days') are
-	 * automatically calculated back to an amount of months.
-	 *
-	 * @return string
-	 */
-	getPeriod(): string;
-}

package/src/models/programme-card/i-internal-link.ts

@@ -1,32 +0,0 @@
-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/programme-card/i-link.ts

@@ -1,25 +0,0 @@
-export interface ILink {
-
-	/**
-	 * Get an optional text describing the link (typically <a>-tags contents).
-	 *
-	 * @return string
-	 * @throws PropertyNotAvailableException
-	 */
-	getDescription(): string;
-
-	canShowDescription(): boolean;
-
-	/**
-	 * 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/programme-card/i-location.ts

@@ -1,22 +0,0 @@
-import { IOptionalLink } from "../../..";
-
-export interface ILocation {
-
-	getArea(): IOptionalLink;
-
-	canShowArea(): boolean;
-
-	getAreaId(): number;
-
-	getCity(): IOptionalLink;
-
-	getCityId(): number;
-
-	getCountry(): IOptionalLink;
-
-	getCountryId(): number;
-
-	getCountryIso(): string;
-
-	hasAreaId(): boolean;
-}

package/src/models/programme-card/i-logo.ts

@@ -1,16 +0,0 @@
-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/programme-card/i-optional-link.ts

@@ -1,27 +0,0 @@
-export interface IOptionalLink {
-
-	/**
-	 * Get an optional text describing the link (typically <a>-tags contents).
-	 *
-	 * @return string
-	 * @throws PropertyNotAvailableException
-	 */
-	getDescription(): string;
-
-	canShowDescription(): boolean;
-
-	/**
-	 * 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;
-
-	canShowUrl(): boolean;
-}

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

@@ -1,212 +0,0 @@
-import { ICover, IDuration, IInternalLink, ILink, ILocation, ILogo, ITiming, ITrackedLink, ITracking, ITuitionFee } from "../../..";
-
-export interface IProgrammeCard {
-
-	/**
-	 * ISO code of the country the programme is taught.
-	 * Formatted in UPPERCASE
-	 *
-	 * @return string | null
-	 */
-	getCountryIsoCode(): string | null;
-
-	/**
-	 * Get the Cover of the programme if available.
-	 *
-	 * @return ICover
-	 */
-	getCover(): ICover;
-
-	canShowCover(): boolean;
-
-	/**
-	 * Get the degree name of the programme.
-	 *
-	 * @return string
-	 */
-	getDegree(): string;
-
-	/**
-	 * Get duration of the programme.
-	 *
-	 * @return IDuration
-	 */
-	getDuration(): IDuration;
-
-	canShowDuration(): boolean;
-
-	/**
-	 * Get the programme id.
-	 *
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * Get the programme level.
-	 *
-	 * @return string
-	 */
-	getLevel(): string;
-
-	/**
-	 * Get the locaiton the programme is located in.
-	 *
-	 * Uses the country based on the programmes venues.
-	 *
-	 * @return ILocation
-	 */
-	getLocation(): ILocation;
-
-	canShowLocation(): boolean;
-
-	/**
-	 * Get the location text the programme is located in
-	 *
-	 * Uses the country based on the programmes venues and isFullyOnline state
-	 *
-	 * @return string | null
-	 */
-	getLocationText(): string | null;
-
-	/**
-	 * Get the Logo of the programme if available.
-	 *
-	 * @return ILogo
-	 */
-	getLogo(): ILogo;
-
-	canShowLogo(): boolean;
-
-	/**
-	 * Returns premium type
-	 * Such as Super premium, premium, light, etc..
-	 *
-	 * @return string
-	 */
-	getPremiumType(): string;
-
-	/**
-	 * 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;
-
-	/**
-	 * Get programme's referral link
-	 *
-	 * @return ITrackedLink
-	 */
-	getReferralLink(): ITrackedLink;
-
-	canShowReferralLink(): boolean;
-
-	/**
-	 * Get the summary of the programme.
-	 *
-	 * @return string
-	 */
-	getSummary(): string;
-
-	/**
-	 * Get all start dates
-	 *
-	 * @return ITiming[]
-	 */
-	getTimings(): ITiming[];
-
-	canShowTimings(): boolean;
-
-	/**
-	 * Get the programme title.
-	 *
-	 * @return string
-	 */
-	getTitle(): string;
-
-	/**
-	 * Get the tracking information needed to track the impression on the card.
-	 *
-	 * @return ITracking
-	 */
-	getTracking(): ITracking;
-
-	/**
-	 * Get all tuition fees of the programme.
-	 *
-	 * @return ITuitionFee[]
-	 */
-	getTuitionFees(): ITuitionFee[];
-
-	canShowTuitionFees(): boolean;
-
-	/**
-	 * Get the programme's 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;
-
-	/**
-	 * If a program is both on campus and online
-	 *
-	 * @return boolean
-	 */
-	isBlended(): boolean;
-
-	/**
-	 * If a program is given in fulltime
-	 *
-	 * @return boolean
-	 */
-	isFullTime(): boolean;
-
-	/**
-	 * If a program can only be taught online or not
-	 *
-	 * @return boolean
-	 */
-	isFullyOnline(): boolean;
-
-	/**
-	 * If a program is taught on campus
-	 *
-	 * @return boolean
-	 */
-	isOnCampus(): boolean;
-
-	/**
-	 * If a program can be taught online
-	 *
-	 * @return boolean
-	 */
-	isOnline(): boolean;
-
-	/**
-	 * If a program is given in parttime
-	 *
-	 * @return boolean
-	 */
-	isPartTime(): boolean;
-
-	/**
-	 * Public status of the programme.
-	 *
-	 * @return boolean
-	 */
-	isPublic(): boolean;
-}