@studyportals/domain-client 4.12.0-0 → 4.13.0-beta.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/copilot-country/copilot-country-client.d.ts

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

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

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

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

@@ -1,39 +1,39 @@
-import { ICopilotRankingCard } from "./i-copilot-ranking-card";
-export interface ICopilotCountry {
-    /**
-     * How to apply in country x text
-     *
-     * @return string | null
-     */
-    getHowToApplyText(): string | null;
-    /**
-     * Id of the country.
-     *
-     * @return number
-     */
-    getId(): number;
-    /**
-     * ISO code ALPHA-2
-     *
-     * @return string
-     */
-    getIsoCode(): string;
-    /**
-     * Country title
-     *
-     * @return string
-     */
-    getTitle(): string;
-    /**
-     * Why study in country x text
-     *
-     * @return string | null
-     */
-    getWhyText(): string | null;
-    /**
-     * Top universities of the country
-     *
-     * @return ICopilotRankingCard[] | null
-     */
-    getTopUniversities(): ICopilotRankingCard[] | null;
-}
+import { ICopilotRankingCard } from "./i-copilot-ranking-card";
+export interface ICopilotCountry {
+    /**
+     * How to apply in country x text
+     *
+     * @return string | null
+     */
+    getHowToApplyText(): string | null;
+    /**
+     * Id of the country.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * ISO code ALPHA-2
+     *
+     * @return string
+     */
+    getIsoCode(): string;
+    /**
+     * Country title
+     *
+     * @return string
+     */
+    getTitle(): string;
+    /**
+     * Why study in country x text
+     *
+     * @return string | null
+     */
+    getWhyText(): string | null;
+    /**
+     * Top universities of the country
+     *
+     * @return ICopilotRankingCard[] | null
+     */
+    getTopUniversities(): ICopilotRankingCard[] | null;
+}

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

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

package/src/models/copilot-country/i-copilot-ranking-card.d.ts

@@ -1,38 +1,38 @@
-export interface ICopilotRankingCard {
-    /**
-     * Get the organisation id.
-     *
-     * @return number
-     */
-    getOrganisationId(): number;
-    /**
-     * Get the organisation name.
-     *
-     * @return string | null
-     */
-    getOrganisationName(): string | null;
-    /**
-     * Get the organisation homepage link.
-     *
-     * @return string | null
-     */
-    getOrganisationPageUrl(): string | null;
-    /**
-     * Get the organisation logo url.
-     *
-     * @return string | null
-     */
-    getOrganisationLogoUrl(): string | null;
-    /**
-     * Verifies if the organisation's logo can be displayed.
-     *
-     * @return boolean
-     */
-    hasOrganisationLogo(): boolean;
-    /**
-     * Retrieves the ranking position for the organisation in the Studyportals ranking in the country of the university.
-     *
-     * @return number | null
-     */
-    getPositionInCountry(): number | null;
-}
+export interface ICopilotRankingCard {
+    /**
+     * Get the organisation id.
+     *
+     * @return number
+     */
+    getOrganisationId(): number;
+    /**
+     * Get the organisation name.
+     *
+     * @return string | null
+     */
+    getOrganisationName(): string | null;
+    /**
+     * Get the organisation homepage link.
+     *
+     * @return string | null
+     */
+    getOrganisationPageUrl(): string | null;
+    /**
+     * Get the organisation logo url.
+     *
+     * @return string | null
+     */
+    getOrganisationLogoUrl(): string | null;
+    /**
+     * Verifies if the organisation's logo can be displayed.
+     *
+     * @return boolean
+     */
+    hasOrganisationLogo(): boolean;
+    /**
+     * Retrieves the ranking position for the organisation in the Studyportals ranking in the country of the university.
+     *
+     * @return number | null
+     */
+    getPositionInCountry(): number | null;
+}

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

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

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

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

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

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