@studyportals/domain-client 3.31.0 → 3.32.0-1

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

@@ -1,82 +1,82 @@
-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;
-}
+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-best-fit-programme.js

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

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

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

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

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

package/src/models/bestfit-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/bestfit-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/bestfit-programme/i-english-requirements.js.map

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

package/src/models/bestfit-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/bestfit-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/bestfit-programme/i-g-p-a-requirement.js.map

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

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

@@ -1,20 +1,20 @@
-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;
-}
+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/bestfit-programme/i-living-cost.js

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

package/src/models/bestfit-programme/i-tuition-fee.d.ts

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

package/src/models/bestfit-programme/i-tuition-fee.js

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

package/src/models/bestfit-programme/i-tuition-fee.js.map

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

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

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

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

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

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

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

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

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

@@ -1,44 +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;
-}
+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-english-requirements.js

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

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

@@ -1,20 +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;
-}
+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-g-p-a-requirement.js

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