@studyportals/domain-client 4.14.1 → 4.15.0

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

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

@@ -1,107 +1,125 @@
-import { IEnglishRequirements, IGeoTargetingValues, IInternalLink, ITiming, ITuitionValues, ILink } from "../../..";
-export interface ICopilotProgramme {
-    /**
-     * Get country the programme is taught in
-     *
-     * @return number[]
-     */
-    getCountryIds(): number[];
-    /**
-     * Get country the programme is taught in
-     *
-     * @return string[]
-     */
-    getCountryIsoCodes(): string[];
-    /**
-     * Get discipline ids attached to this programme
-     *
-     * @return number[]
-     */
-    getDisciplineIds(): number[];
-    /**
-     * Education level
-     *
-     * @return string
-     */
-    getEducationalLevel(): string;
-    /**
-     * English level requirements.
-     *
-     * @return IEnglishRequirements
-     */
-    getEnglishRequirements(): IEnglishRequirements;
-    getGeneralRequirements(): string | null;
-    /**
-     * Get geotargetting settings for the programme
-     *
-     * @return IGeoTargetingValues
-     */
-    getGeoTargetingValues(): IGeoTargetingValues;
-    getGlobalUniversityRanking(): string | null;
-    /**
-     * Id of the programme.
-     *
-     * @return number
-     */
-    getId(): number;
-    /**
-     * 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;
-    /**
-     * Get a link to the programme's university page.
-     *
-     * The link contains the page path as url and the university name as the
-     * link description.
-     *
-     * @return ILink
-     */
-    getUniversityLink(): ILink;
-    /**
-     * Summary of the programme.
-     *
-     * @return string
-     */
-    getSummary(): string;
-    /**
-     * Get all start dates
-     *
-     * @return ITiming[]
-     */
-    getTimings(): ITiming[];
-    /**
-     * Title of the programme.
-     *
-     * @return string
-     */
-    getTitle(): string;
-    /**
-     * The programmes tuition fees
-     *
-     * @return ITuitionValues | null
-     */
-    getTuitionValues(): ITuitionValues | null;
-    /**
-     * University id
-     *
-     * @return number
-     */
-    getUniversityId(): number;
-    /**
-     * University title
-     *
-     * @return string
-     */
-    getUniversityTitle(): string;
-    /**
-     * Is programme public
-     *
-     * @return boolean
-     */
-    isPublic(): boolean;
-}
+import { IEnglishRequirements, IGPARequirement, IGeoTargetingValues, IInternalLink, ILink, ILivingCost, ITiming, ITuitionValues } from "../../..";
+export interface ICopilotProgramme {
+    /**
+     * Get country the programme is taught in
+     *
+     * @return number[]
+     */
+    getCountryIds(): number[];
+    /**
+     * Get country iso codes the programme is taught in
+     *
+     * @return string[]
+     */
+    getCountryIsoCodes(): string[];
+    /**
+     * Get discipline ids attached to this programme
+     *
+     * @return number[]
+     */
+    getDisciplineIds(): number[];
+    /**
+     * Education level
+     *
+     * @return string
+     */
+    getEducationalLevel(): string;
+    /**
+     * English level requirements.
+     *
+     * @return IEnglishRequirements
+     */
+    getEnglishRequirements(): IEnglishRequirements;
+    /**
+     * GPA Requirements
+     *
+     * @return IGPARequirement | null
+     */
+    getGPA(): IGPARequirement | null;
+    getGeneralRequirements(): string | null;
+    /**
+     * Get geotargetting settings for the programme
+     *
+     * @return IGeoTargetingValues
+     */
+    getGeoTargetingValues(): IGeoTargetingValues;
+    getGlobalUniversityRanking(): string | null;
+    /**
+     * Id of the programme.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * The programmes estimated living cost
+     *
+     * @return ILivingCost | null
+     */
+    getLivingCost(): ILivingCost | 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;
+    /**
+     * Summary of the programme.
+     *
+     * @return string
+     */
+    getSummary(): string;
+    /**
+     * Get all start dates
+     *
+     * @return ITiming[]
+     */
+    getTimings(): ITiming[];
+    /**
+     * Title of the programme.
+     *
+     * @return string
+     */
+    getTitle(): string;
+    /**
+     * The programmes tuition fees
+     *
+     * @return ITuitionValues | null
+     */
+    getTuitionValues(): ITuitionValues | null;
+    /**
+     * University id
+     *
+     * @return number
+     */
+    getUniversityId(): number;
+    /**
+     * Get a link to the programme's university page.
+     *
+     * The link contains the page path as url and the university name as the
+     * link description.
+     *
+     * @return ILink
+     */
+    getUniversityLink(): ILink;
+    /**
+     * University title
+     *
+     * @return string
+     */
+    getUniversityTitle(): string;
+    /**
+     * Work experience requirements in years
+     *
+     * @return number | null
+     */
+    getWorkExperienceYears(): number | null;
+    /**
+     * Is programme public
+     *
+     * @return boolean
+     */
+    isPublic(): boolean;
+}

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

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

package/src/models/customerio-organisation/customerio-organisation-client.d.ts

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

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

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

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

@@ -1,35 +1,35 @@
-import { ICity, ICountry, IReview } from "../../..";
-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;
-}
+import { ICity, ICountry, IReview } from "../../..";
+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-io-organisation.js

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

package/src/models/customerio-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/customerio-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/customerio-programme/customerio-programme-client.d.ts

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

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

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