@studyportals/domain-client 3.31.0 → 3.32.0-1

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

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

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=i-internal-link.js.map

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

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

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=i-logo.js.map

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

@@ -1,50 +1,50 @@
-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;
-}
+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/common/i-tuition-fee.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=i-tuition-fee.js.map

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

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

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

@@ -1,17 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CompareProgrammeClient = void 0;
-const model_client_1 = require("../../model-client");
-class CompareProgrammeClient extends model_client_1.ModelClient {
-    getModelName() {
-        return 'compare-programme';
-    }
-    getVersion() {
-        return 'v1';
-    }
-    isPublic() {
-        return false;
-    }
-}
-exports.CompareProgrammeClient = CompareProgrammeClient;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompareProgrammeClient = void 0;
+const model_client_1 = require("../../model-client");
+class CompareProgrammeClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'compare-programme';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.CompareProgrammeClient = CompareProgrammeClient;
 //# sourceMappingURL=compare-programme-client.js.map

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

@@ -1,108 +1,108 @@
-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;
-}
+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/compare-programme/i-compare-programme.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=i-compare-programme.js.map

package/src/models/compare-programme/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/compare-programme/i-deadline.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-deadline.js.map

package/src/models/compare-programme/i-deadline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-deadline.js","sourceRoot":"","sources":["../../../../src/models/compare-programme/i-deadline.ts"],"names":[],"mappings":""}

package/src/models/compare-programme/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/compare-programme/i-duration.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-duration.js.map

package/src/models/compare-programme/i-duration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-duration.js","sourceRoot":"","sources":["../../../../src/models/compare-programme/i-duration.ts"],"names":[],"mappings":""}

package/src/models/compare-programme/i-english-requirements.d.ts

@@ -0,0 +1,44 @@
+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/compare-programme/i-english-requirements.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-english-requirements.js.map

package/src/models/compare-programme/i-english-requirements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-english-requirements.js","sourceRoot":"","sources":["../../../../src/models/compare-programme/i-english-requirements.ts"],"names":[],"mappings":""}

package/src/models/compare-programme/i-g-p-a-requirement.d.ts

@@ -0,0 +1,20 @@
+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/compare-programme/i-g-p-a-requirement.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-g-p-a-requirement.js.map

package/src/models/compare-programme/i-g-p-a-requirement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-g-p-a-requirement.js","sourceRoot":"","sources":["../../../../src/models/compare-programme/i-g-p-a-requirement.ts"],"names":[],"mappings":""}