@studyportals/domain-client 6.0.0-5 → 6.0.0-7

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 @@
+export {};

package/src/models/bestfit-programme/i-living-cost.js

@@ -1,2 +1 @@
 export {};
-//# 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 @@
+export {};

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

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-city.js.map

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

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-country.js.map

package/src/models/common/i-english-requirements.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-english-requirements.js.map

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

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-g-p-a-requirement.js.map

package/src/models/common/i-internal-link.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-internal-link.js.map

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

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-logo.js.map

package/src/models/common/i-review-rating.d.ts

@@ -0,0 +1,26 @@
+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-review-rating.js

@@ -0,0 +1 @@
+export {};

package/src/models/common/i-tuition-fee.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-tuition-fee.js.map

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

@@ -0,0 +1,51 @@
+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 OTE
+     *
+     * @return number
+     */
+    getOte(): number;
+    canShowOte(): 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 @@
+export {};

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 @@
+export {};

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

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

package/src/models/compare-programme/i-living-cost.js

@@ -0,0 +1 @@
+export {};

package/src/models/copilot-country/copilot-country-client.js

@@ -10,4 +10,3 @@ export class CopilotCountryClient extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=copilot-country-client.js.map

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

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-copilot-country.js.map

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

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-copilot-ranking-card.js.map

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

@@ -10,4 +10,3 @@ export class CopilotProgrammeClient extends ModelClient {
         return false;
     }
 }
-//# sourceMappingURL=copilot-programme-client.js.map

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

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=i-copilot-programme.js.map

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,51 @@
+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 OTE
+     *
+     * @return number
+     */
+    getOte(): number;
+    canShowOte(): 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/copilot-programme/i-english-requirements.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

package/src/models/copilot-programme/i-geo-targeting-configuration.d.ts

@@ -0,0 +1,38 @@
+export interface IGeoTargetingConfiguration {
+    /**
+     * Bit set 1 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit1(): number;
+    /**
+     * Bit set 2 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit2(): number;
+    /**
+     * Bit set 3 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit3(): number;
+    /**
+     * Bit set 4 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit4(): number;
+    /**
+     * Bit set 5 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit5(): number;
+    /**
+     * List of all configured country IDs.
+     *
+     * @return number[]
+     */
+    getTargetedCountries(): number[];
+}

package/src/models/copilot-programme/i-geo-targeting-configuration.js

@@ -0,0 +1 @@
+export {};

package/src/models/copilot-programme/i-geo-targeting-values.d.ts

@@ -0,0 +1,30 @@
+import { IGeoTargetingConfiguration } from "../../..";
+export interface IGeoTargetingValues {
+    /**
+     * Geo-targeting configuration for "light premium" listing.
+     *
+     * @return IGeoTargetingConfiguration
+     */
+    getLightPremium(): IGeoTargetingConfiguration;
+    canShowLightPremium(): boolean;
+    /**
+     * Geo-targeting configuration for "premium" listing.
+     *
+     * @return IGeoTargetingConfiguration
+     */
+    getPremium(): IGeoTargetingConfiguration;
+    canShowPremium(): boolean;
+    /**
+     * Geo-targeting configuration for "super premium" listing.
+     *
+     * @return IGeoTargetingConfiguration
+     */
+    getSuperPremium(): IGeoTargetingConfiguration;
+    canShowSuperPremium(): boolean;
+    /**
+     * Programme has active geo-targeting settings.
+     *
+     * @return boolean
+     */
+    isGeoTargeted(): boolean;
+}

package/src/models/copilot-programme/i-geo-targeting-values.js

@@ -0,0 +1 @@
+export {};

package/src/models/copilot-programme/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/copilot-programme/i-internal-link.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

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

package/src/models/copilot-programme/i-living-cost.js

@@ -0,0 +1 @@
+export {};

package/src/models/copilot-programme/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/copilot-programme/i-start-date.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,45 @@
+import { IDeadline, IStartDate } from "../../..";
+export interface ITiming {
+    /**
+     * Get the IDeadline applicable for this type and programme.
+     *
+     * Note: In case of extendable start dates, all information in the
+     * Deadline object has already been extended to the first available start
+     * date.
+     *
+     * @return IDeadline
+     * @throws PropertyNotAvailableException
+     */
+    getDeadline(): IDeadline;
+    canShowDeadline(): boolean;
+    /**
+     * Get the IStartDate applicable for this type and programme.
+     *
+     * Note: In case of extendable start dates, all information in the
+     * StartDate objects has already been extended to the first available start
+     * date.
+     *
+     * @return IStartDate
+     * @throws PropertyNotAvailableException
+     */
+    getStartDate(): IStartDate;
+    canShowStartDate(): boolean;
+    /**
+     * Type of user the timing is applicable to (e.g. general, eea, national).
+     *
+     * @return string
+     */
+    getType(): string;
+    /**
+     * True if the programme allows to apply at any time (rolling application).
+     *
+     * @return boolean
+     */
+    isApplyingAnytime(): boolean;
+    /**
+     * True if the programme can start at any time (rolling admission).
+     *
+     * @return boolean
+     */
+    isStartingAnytime(): boolean;
+}

package/src/models/copilot-programme/i-timing.js

@@ -0,0 +1 @@
+export {};

package/src/models/copilot-programme/i-tuition-values.d.ts

@@ -0,0 +1,50 @@
+export interface ITuitionValues {
+    /**
+     * Tuition (converted to per year if possible) for EEA students.
+     *
+     * @return number
+     */
+    getTuitionEea(): number;
+    canShowTuitionEea(): boolean;
+    /**
+     * Tuition currency.
+     *
+     * @return number
+     */
+    getTuitionEeaCurrency(): number;
+    canShowTuitionEeaCurrency(): boolean;
+    /**
+     * Tuition (converted to per year if possible) for international students.
+     *
+     * @return number
+     */
+    getTuitionInternational(): number;
+    canShowTuitionInternational(): boolean;
+    /**
+     * Tuition currency.
+     *
+     * @return number
+     */
+    getTuitionInternationalCurrency(): number;
+    canShowTuitionInternationalCurrency(): boolean;
+    /**
+     * Tuition (converted to per year if possible) for national students.
+     *
+     * @return number
+     */
+    getTuitionNational(): number;
+    canShowTuitionNational(): boolean;
+    /**
+     * Tuition currency.
+     *
+     * @return number
+     */
+    getTuitionNationalCurrency(): number;
+    canShowTuitionNationalCurrency(): boolean;
+    /**
+     * Unit all tuition fees are provided in.
+     *
+     * @return number
+     */
+    getTuitionUnitType(): number;
+}