@studyportals/domain-client 3.33.0 → 3.34.0

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

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

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

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

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

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

package/src/models/programme-card/i-tracked-link.d.ts

@@ -1,29 +1,29 @@
-import { ITracking } from "../../..";
-export interface ITrackedLink {
-    /**
-     * Get an optional text describing the link (typically <a>-tags contents).
-     *
-     * @return string
-     * @throws PropertyNotAvailableException
-     */
-    getDescription(): string;
-    canShowDescription(): boolean;
-    /**
-     * Get an object containing all information needed to properly track a link.
-     *
-     * @return ITracking
-     */
-    getTracking(): ITracking;
-    /**
-     * 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;
-}
+import { ITracking } from "../../..";
+export interface ITrackedLink {
+    /**
+     * Get an optional text describing the link (typically <a>-tags contents).
+     *
+     * @return string
+     * @throws PropertyNotAvailableException
+     */
+    getDescription(): string;
+    canShowDescription(): boolean;
+    /**
+     * Get an object containing all information needed to properly track a link.
+     *
+     * @return ITracking
+     */
+    getTracking(): ITracking;
+    /**
+     * 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/programme-card/i-tracked-link.js

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

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

@@ -1,46 +1,46 @@
-import { IClickTrackingData } from "../../..";
-export interface ITracking {
-    /**
-     * Get the value of the data-action attribute.
-     *
-     * @return string
-     */
-    getAction(): string;
-    /**
-     * Get all the data that is need to make click tracking possible
-     *
-     * @return IClickTrackingData
-     */
-    getClickTrackingData(): IClickTrackingData;
-    canShowClickTrackingData(): boolean;
-    /**
-     * Get the value of the data-description attribute.
-     *
-     * @return string
-     */
-    getDescription(): string;
-    /**
-     * Get the extra information value.
-     *
-     * @return string
-     */
-    getExtra(): string;
-    /**
-     * Get the value of the data-id attribute.
-     *
-     * @return number
-     */
-    getId(): number;
-    /**
-     * Get the value of the data-label attribute.
-     *
-     * @return string
-     */
-    getLabel(): string;
-    /**
-     * Get the value of the data-type attribute.
-     *
-     * @return string
-     */
-    getType(): string;
-}
+import { IClickTrackingData } from "../../..";
+export interface ITracking {
+    /**
+     * Get the value of the data-action attribute.
+     *
+     * @return string
+     */
+    getAction(): string;
+    /**
+     * Get all the data that is need to make click tracking possible
+     *
+     * @return IClickTrackingData
+     */
+    getClickTrackingData(): IClickTrackingData;
+    canShowClickTrackingData(): boolean;
+    /**
+     * Get the value of the data-description attribute.
+     *
+     * @return string
+     */
+    getDescription(): string;
+    /**
+     * Get the extra information value.
+     *
+     * @return string
+     */
+    getExtra(): string;
+    /**
+     * Get the value of the data-id attribute.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Get the value of the data-label attribute.
+     *
+     * @return string
+     */
+    getLabel(): string;
+    /**
+     * Get the value of the data-type attribute.
+     *
+     * @return string
+     */
+    getType(): string;
+}

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

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

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

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

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

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

package/src/models/ranking-cards/i-ranking-card.d.ts

@@ -1,87 +1,87 @@
-import { IRanking } from "../../..";
-export interface IRankingCard {
-    /**
-     * Get the organisation city.
-     *
-     * @return string | null
-     */
-    getOrganisationCity(): string | null;
-    /**
-     * Get the organisation country.
-     *
-     * @return string | null
-     */
-    getOrganisationCountry(): string | null;
-    /**
-     * Get the organisation id.
-     *
-     * @return number
-     */
-    getOrganisationId(): number;
-    /**
-     * Get the organisation logo url.
-     *
-     * @return string | null
-     */
-    getOrganisationLogoUrl(): string | null;
-    /**
-     * Get the organisation name.
-     *
-     * @return string | null
-     */
-    getOrganisationName(): string | null;
-    /**
-     * Get the organisation homepage link.
-     *
-     * @return string | null
-     */
-    getOrganisationPageUrl(): string | null;
-    /**
-     * Get the position for the organisation in the Studyportals ranking.
-     *
-     * @return number | null
-     */
-    getPosition(): number | null;
-    /**
-     * Retrieves the ranking position for the organisation in the Studyportals ranking in the country of the university.
-     *
-     * @return number | null
-     */
-    getPositionInCountry(): number | null;
-    /**
-     * Retrieves the ranking position for the organisation in the Studyportals ranking in the region of the university.
-     *
-     * @return number | null
-     */
-    getPositionInRegion(): number | null;
-    /**
-     * Retrieves the percentage category in the Studyportals ranking.
-     *
-     * @return string | null
-     */
-    getGlobalPositionPercentage(): string | null;
-    /**
-     * Retrieves the percentage category in the Studyportals ranking for the current location.
-     *
-     * @return string | null
-     */
-    getCountryPositionPercentage(): string | null;
-    /**
-     * Get the year the organisation was ranked.
-     *
-     * @return string | null
-     */
-    getRankingYear(): string | null;
-    /**
-     * Get this organisation's ranked position for each available ranking.
-     *
-     * @return IRanking[]
-     */
-    getRankings(): IRanking[];
-    /**
-     * Verifies if the organisation's logo can be displayed.
-     *
-     * @return boolean
-     */
-    hasOrganisationLogo(): boolean;
-}
+import { IRanking } from "../../..";
+export interface IRankingCard {
+    /**
+     * Get the organisation city.
+     *
+     * @return string | null
+     */
+    getOrganisationCity(): string | null;
+    /**
+     * Get the organisation country.
+     *
+     * @return string | null
+     */
+    getOrganisationCountry(): string | null;
+    /**
+     * Get the organisation id.
+     *
+     * @return number
+     */
+    getOrganisationId(): number;
+    /**
+     * Get the organisation logo url.
+     *
+     * @return string | null
+     */
+    getOrganisationLogoUrl(): string | null;
+    /**
+     * Get the organisation name.
+     *
+     * @return string | null
+     */
+    getOrganisationName(): string | null;
+    /**
+     * Get the organisation homepage link.
+     *
+     * @return string | null
+     */
+    getOrganisationPageUrl(): string | null;
+    /**
+     * Get the position for the organisation in the Studyportals ranking.
+     *
+     * @return number | null
+     */
+    getPosition(): number | null;
+    /**
+     * Retrieves the ranking position for the organisation in the Studyportals ranking in the country of the university.
+     *
+     * @return number | null
+     */
+    getPositionInCountry(): number | null;
+    /**
+     * Retrieves the ranking position for the organisation in the Studyportals ranking in the region of the university.
+     *
+     * @return number | null
+     */
+    getPositionInRegion(): number | null;
+    /**
+     * Retrieves the percentage category in the Studyportals ranking.
+     *
+     * @return string | null
+     */
+    getGlobalPositionPercentage(): string | null;
+    /**
+     * Retrieves the percentage category in the Studyportals ranking for the current location.
+     *
+     * @return string | null
+     */
+    getCountryPositionPercentage(): string | null;
+    /**
+     * Get the year the organisation was ranked.
+     *
+     * @return string | null
+     */
+    getRankingYear(): string | null;
+    /**
+     * Get this organisation's ranked position for each available ranking.
+     *
+     * @return IRanking[]
+     */
+    getRankings(): IRanking[];
+    /**
+     * Verifies if the organisation's logo can be displayed.
+     *
+     * @return boolean
+     */
+    hasOrganisationLogo(): boolean;
+}