@studyportals/domain-client 3.14.0 → 3.16.0-0

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

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

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

@@ -0,0 +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;
+//# sourceMappingURL=compare-programme-client.js.map

package/src/models/compare-programme/compare-programme-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare-programme-client.js","sourceRoot":"","sources":["../../../../src/models/compare-programme/compare-programme-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,sBAAuB,SAAQ,0BAA8B;IAC/D,YAAY;QACrB,OAAO,mBAAmB,CAAC;IAC5B,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,wDAYC"}

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

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

package/src/models/{dotdigital-organisation/i-country.js → compare-programme/i-compare-programme.js}

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

package/src/models/compare-programme/i-compare-programme.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-compare-programme.js","sourceRoot":"","sources":["../../../../src/models/compare-programme/i-compare-programme.ts"],"names":[],"mappings":""}

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

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

@@ -1,89 +1,101 @@
-import { ICountry, IEnglishRequirements, IInternalLink, ILogo, ITuitionFee } from "../../..";
-export interface IDotDigitalProgramme {
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * Title of the programme.
-     *
-     * @return string
-     */
-    getTitle(): string;
-    /**
-     * The programmes tuition fees
-     *
-     * @return ITuitionFee[]
-     */
-    getTuitionFees(): ITuitionFee[];
-    canShowTuitionFees(): boolean;
-    /**
-     * University title
-     *
-     * @return string
-     */
-    getUniversityTitle(): string;
-    /**
-     * Is programme public
-     *
-     * @return boolean
-     */
-    isPublic(): boolean;
-}
+import { ICountry, IEnglishRequirements, IInternalLink, ILogo, ITuitionFee } from "../../..";
+export interface IDotDigitalProgramme {
+    /**
+     * 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;
+    /**
+     * 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/dotdigital-programme/i-dot-digital-programme.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-programme.js.map

package/src/models/dotdigital-programme/i-internal-link.d.ts

@@ -1,28 +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;
-}
+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/dotdigital-programme/i-internal-link.js

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

package/src/models/programme-card/i-click-tracking-data.d.ts

@@ -1,5 +1,5 @@
-export interface IClickTrackingData {
-    getAction(): string;
-    getCategory(): string;
-    getLabel(): string;
-}
+export interface IClickTrackingData {
+    getAction(): string;
+    getCategory(): string;
+    getLabel(): string;
+}

package/src/models/programme-card/i-click-tracking-data.js

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