@studyportals/domain-client 8.3.1 → 8.4.0

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

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

package/src/models/customerio-organisation/i-city.d.ts

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

package/src/models/customerio-organisation/i-city.js

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

package/src/models/customerio-organisation/i-country.d.ts

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

package/src/models/customerio-organisation/i-country.js

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

package/src/models/customerio-organisation/i-customer-i-o-organisation.d.ts

@@ -0,0 +1,35 @@
+import { ICity, ICountry, IReview } from "../../../index.js";
+export interface ICustomerIOOrganisation {
+    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/customerio-organisation/i-customer-i-o-organisation.js

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

package/src/models/customerio-programme/i-country.d.ts

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

package/src/models/customerio-programme/i-country.js

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

package/src/models/customerio-programme/i-customer-i-o-programme.d.ts

@@ -0,0 +1,107 @@
+import { ICountry, IEnglishRequirements, IInternalLink, ILogo, ITiming, ITuitionFee } from "../../../index.js";
+export interface ICustomerIOProgramme {
+    /**
+     * 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;
+    /**
+     * Get all start dates
+     *
+     * @return ITiming[]
+     */
+    getTimings(): ITiming[];
+    /**
+     * 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/customerio-programme/i-customer-i-o-programme.js

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

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

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

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

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

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

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

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

@@ -0,0 +1,33 @@
+import { IDeadline } from "../../../index.js";
+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/customerio-programme/i-start-date.js

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

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

@@ -0,0 +1,45 @@
+import { IDeadline, IStartDate } from "../../../index.js";
+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/customerio-programme/i-timing.js

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

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

@@ -0,0 +1,64 @@
+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 discounted tuition amount per unit in the provided currency.
+     * Returns null if the discounted amount is the same as the regular amount.
+     *
+     * @return number | null
+     */
+    getDiscountedAmount(): number | null;
+    /**
+     * Get the original tuition amount before any transformation step.
+     *
+     * @return number
+     */
+    getOriginalAmount(): number;
+    /**
+     * Get the original discounted tuition amount before any transformation step.
+     * Returns null if the original discounted amount is the same as the original amount.
+     *
+     * @return number | null
+     */
+    getOriginalDiscountedAmount(): number | null;
+    /**
+     * 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/customerio-programme/i-tuition-fee.js

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

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

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

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

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

package/src/models/programme-card/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/programme-card/i-living-cost.js

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

package/src/models/programme-card/i-review-rating-domain.d.ts

@@ -0,0 +1,6 @@
+export interface IReviewRatingDomain {
+    getAverage(): number;
+    getAverageStarRating(): number;
+    getQuantity(): number;
+    hasEnoughQuantity(): boolean;
+}

package/src/models/programme-card/i-review-rating-domain.js

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