@studyportals/domain-client 3.30.0 → 3.32.0-organisations.0

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/dotdigital-organisation/dotdigital-organisation-client.d.ts

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

package/src/models/dotdigital-organisation/dotdigital-organisation-client.js

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

package/src/models/dotdigital-organisation/i-dot-digital-organisation.d.ts

@@ -1,35 +1,35 @@
-import { ICity, ICountry, IReview } from "../../..";
-export interface IDotDigitalOrganisation {
-    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;
-}
+import { ICity, ICountry, IReview } from "../../..";
+export interface IDotDigitalOrganisation {
+    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/dotdigital-organisation/i-dot-digital-organisation.js

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

package/src/models/dotdigital-organisation/i-review.d.ts

@@ -1,7 +1,7 @@
-export interface IReview {
-    getEndDate(): Date | null;
-    getRating(): number;
-    getReview(): string | null;
-    getStartDate(): Date | null;
-    getTitle(): string | null;
-}
+export interface IReview {
+    getEndDate(): Date | null;
+    getRating(): number;
+    getReview(): string | null;
+    getStartDate(): Date | null;
+    getTitle(): string | null;
+}

package/src/models/dotdigital-organisation/i-review.js

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

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

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

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

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