@studyportals/domain-client 7.0.1-beta.9 → 7.1.0

package/src/models/organisation-search-document/i-organisation-search-document.d.ts

@@ -0,0 +1,158 @@
+export interface IOrganisationSearchDocument {
+    /**
+     * Gets the ISO codes of all countries where the organisation has venues
+     *
+     * @return string[]
+     */
+    getCountryIsoCodesOfVenues(): string[];
+    /**
+     * Gets the ISO code of the main location of the organisation
+     *
+     * @return string
+     */
+    getCountryIsoCodeOfMainLocation(): string;
+    /**
+     * Returns the number of bachelors offered by the organisation
+     *
+     * @return number
+     */
+    getNumberOfProgrammesForBachelors(): number;
+    /**
+     * Returns the number of distance learning courses offered by the organisation
+     *
+     * @return number
+     */
+    getNumberOfProgrammesForDistanceLearning(): number;
+    /**
+     * Returns the number of masters offered by the organisation
+     *
+     * @return number
+     */
+    getNumberOfProgrammesForMasters(): number;
+    /**
+     * Returns the number of phds offered by the organisation
+     *
+     * @return number
+     */
+    getNumberOfProgrammesForPhd(): number;
+    /**
+     * Returns the number of short courses offered by the organisation
+     *
+     * @return number
+     */
+    getNumberOfProgrammesForShortCourses(): number;
+    /**
+     * Gets the ID of the organisation.
+     *
+     * @return number
+     */
+    getOrganisationId(): number;
+    /**
+     * Gets the premium type of the organisation
+     *
+     * @return string | null
+     */
+    getPremiumType(): string | null;
+    /**
+     * Checks whether the organisation has studies taught both online and on campus
+     *
+     * @return boolean
+     */
+    hasDeliveryMethodBlended(): boolean;
+    /**
+     * Checks whether the organisation has studies taught on campus
+     *
+     * @return boolean
+     */
+    hasDeliveryMethodOnCampus(): boolean;
+    /**
+     * Checks whether the organisation has studies taught online
+     *
+     * @return boolean
+     */
+    hasDeliveryMethodOnline(): boolean;
+    /**
+     * Gets the IDs of all areas where the organisation has venues
+     *
+     * @return number[]
+     */
+    identifyAreasOfVenues(): number[];
+    /**
+     * Gets the disciplines of Bachelors programmes taught at the organisation
+     *
+     * @return number[]
+     */
+    identifyDisciplinesForBachelors(): number[];
+    /**
+     * Gets the disciplines of Masters programmes taught at the organisation
+     *
+     * @return number[]
+     */
+    identifyDisciplinesForMasters(): number[];
+    /**
+     * Gets the disciplines of PhD programmes taught at the organisation
+     *
+     * @return number[]
+     */
+    identifyDisciplinesForPhd(): number[];
+    /**
+     * Gets the disciplines of short courses programmes taught at the organisation
+     *
+     * @return number[]
+     */
+    identifyDisciplinesForShortCourses(): number[];
+    /**
+     * Gets the IDs of all regions (continents) where the organisation has venues
+     *
+     * @return number[]
+     */
+    identifyRegionsOfVenues(): number[];
+    /**
+     * Returns true when the organisation does not have a parent organisation
+     *
+     * @return boolean
+     */
+    isMainOrganisation(): boolean;
+    /**
+     * Indicates whether the organisation is published or not
+     *
+     * @return boolean
+     */
+    isPublished(): boolean;
+    /**
+     * Gets the city IDs for Masters programmes offered by the organisation
+     *
+     * @return array<number>
+     */
+    getCityIdsForMasters(): number[];
+    /**
+     * Gets the city IDs for Bachelors programmes offered by the organisation
+     *
+     * @return array<number>
+     */
+    getCityIdsForBachelors(): number[];
+    /**
+     * Gets the city IDs for PhD programmes offered by the organisation
+     *
+     * @return array<number>
+     */
+    getCityIdsForPhd(): number[];
+    /**
+     * Gets the city IDs for Short Courses programmes offered by the organisation
+     *
+     * @return array<number>
+     */
+    getCityIdsForShortCourses(): number[];
+    /**
+     * Gets the city IDs for Distance Learning programmes offered by the organisation
+     *
+     * @return array<number>
+     */
+    getCityIdsForDistanceLearning(): number[];
+    /**
+     * Gets the virtual path for the organisation
+     *
+     * @return string
+     */
+    getVirtualPath(): string;
+}

package/src/models/organisation-search-document/i-organisation-search-document.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/organisation-search-document/organisation-search-document-client.d.ts

@@ -0,0 +1,7 @@
+import { IOrganisationSearchDocument } from "../../..";
+import { ModelClient } from "../../model-client";
+export declare class OrganisationSearchDocumentClient extends ModelClient<IOrganisationSearchDocument> {
+    protected getModelName(): string;
+    protected getVersion(): string;
+    isPublic(): boolean;
+}

package/src/models/organisation-search-document/organisation-search-document-client.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganisationSearchDocumentClient = void 0;
+const model_client_1 = require("../../model-client");
+class OrganisationSearchDocumentClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'organisation-search-document';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.OrganisationSearchDocumentClient = OrganisationSearchDocumentClient;

package/src/models/programme-card/i-click-tracking-data.d.ts

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

package/src/models/programme-card/i-click-tracking-data.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,14 @@
+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-cover.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,20 @@
+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-deadline.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,40 @@
+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-duration.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,28 @@
+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-internal-link.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,22 @@
+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-link.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,14 @@
+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-logo.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/programme-card/i-optional-link.d.ts

@@ -0,0 +1,23 @@
+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-optional-link.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,212 @@
+import { ICover, IDuration, IEnglishRequirements, IGPARequirement, IInternalLink, ILink, ILivingCost, ILocation, ILogo, ITiming, ITrackedLink, ITracking, ITuitionFee } from "../../..";
+import { IReviewRating } from "../common/i-review-rating";
+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;
+    /**
+     * @return number[] | null
+     */
+    getDisciplineIds(): number[] | null;
+    /**
+     * Get duration of the programme.
+     *
+     * @return IDuration
+     */
+    getDuration(): IDuration;
+    canShowDuration(): boolean;
+    getEnglishRequirements(): IEnglishRequirements | null;
+    getGPA(): IGPARequirement | null;
+    /**
+     * Get the programme id.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Get the programme level.
+     *
+     * @return string
+     */
+    getLevel(): string;
+    getLivingCost(): ILivingCost | null;
+    /**
+     * 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 global position percentage in Meta Ranking
+     *
+     * @return string | null
+     */
+    getUniversityGlobalPositionPercentage(): string | null;
+    /**
+     * 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;
+    getWorkExperienceYears(): number | null;
+    getEcts(): number | null;
+    /**
+     * 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;
+    /**
+     * The last time the programme has been updated and verified
+     *
+     * @return Date
+     */
+    getLastUpdated(): Date;
+    /**
+     * Get the programme's campaign type
+     *
+     * @return number
+     */
+    getCampaignType(): number | null;
+    /**
+     * Get the review rating of the programme.
+     *
+     * @return IReviewRating | null
+     */
+    getReviewRating(): IReviewRating | null;
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/programme-card/i-start-date.d.ts

@@ -0,0 +1,33 @@
+import { IDeadline } from "../../..";
+export interface IStartDate {
+    /**
+     * Get the date the programme starts on.
+     *
+     * @return Date
+     */
+    getDate(): Date;
+    /**
+     * Get a list of deadlines that apply to this start date.
+     *
+     * Note: In case of extendable start dates, all information in the
+     * Deadline objects has already been extended to the first available start
+     * date.
+     *
+     * @return IDeadline[]
+     * @throws PropertyNotAvailableException
+     */
+    getDeadlines(): IDeadline[];
+    canShowDeadlines(): boolean;
+    /**
+     * True if you can apply at any time for this programme (rolling admission)
+     *
+     * @return boolean
+     */
+    isApplyingAnytime(): boolean;
+    /**
+     * True if the start date has passed (you can't start at this date anymore).
+     *
+     * @return boolean
+     */
+    isPassed(): boolean;
+}

package/src/models/programme-card/i-start-date.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });