@studyportals/domain-client 4.15.0 → 4.16.0

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.d.ts

@@ -1,18 +1,18 @@
-export interface IRanking {
-    /**
-     * @return number
-     */
-    getId(): number;
-    /**
-     * @return number | null
-     */
-    getRankingId(): number | null;
-    /**
-     * @return number
-     */
-    getPosition(): number;
-    /**
-     * @return string
-     */
-    getRankingYear(): string;
-}
+export interface IRanking {
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return number | null
+     */
+    getRankingId(): number | null;
+    /**
+     * @return number
+     */
+    getPosition(): number;
+    /**
+     * @return string
+     */
+    getRankingYear(): string;
+}

package/src/models/ranking-cards/i-ranking.js

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

package/src/models/scholarship-card/i-scholarship-card.d.ts

@@ -1,15 +1,15 @@
-export interface IScholarshipCard {
-    getDescriptionOfApplicationBasis(): string | null;
-    getDescriptionOfBenefits(): string | null;
-    getDescriptionOfDeadline(): string;
-    getDescriptionOfDestinationCountryRestrictions(): string;
-    getDescriptionOfProviderLocation(): string | null;
-    getIsNotSpecifiedDeadline(): boolean;
-    getProviderId(): string | null;
-    getProviderIsUniversity(): boolean;
-    getProviderLogoSquareCdn(): string | null;
-    getProviderName(): string;
-    getScholarshipId(): string;
-    getScholarshipTitle(): string;
-    getScholarshipVirtualName(): string;
-}
+export interface IScholarshipCard {
+    getDescriptionOfApplicationBasis(): string | null;
+    getDescriptionOfBenefits(): string | null;
+    getDescriptionOfDeadline(): string;
+    getDescriptionOfDestinationCountryRestrictions(): string;
+    getDescriptionOfProviderLocation(): string | null;
+    getIsNotSpecifiedDeadline(): boolean;
+    getProviderId(): string | null;
+    getProviderIsUniversity(): boolean;
+    getProviderLogoSquareCdn(): string | null;
+    getProviderName(): string;
+    getScholarshipId(): string;
+    getScholarshipTitle(): string;
+    getScholarshipVirtualName(): string;
+}

package/src/models/scholarship-card/i-scholarship-card.js

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

package/src/models/scholarship-card/public-scholarship-card-client.d.ts

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

package/src/models/scholarship-card/public-scholarship-card-client.js

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

package/src/models/search-country-faq/i-search-country-faq.d.ts

@@ -1,18 +1,14 @@
-export interface ISearchCountryFaq {
-    /**
-     * @return number
-     */
-    getId(): number;
-    /**
-     * @return string
-     */
-    getName(): string;
-    /**
-     * @return string
-     */
-    getRankingCountryLink(): string;
-    /**
-     * @return string[]
-     */
-    getTopFiveUniversities(): string[];
-}
+export interface ISearchCountryFaq {
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getName(): string;
+    /**
+     * @return string[]
+     */
+    getTopFiveUniversities(): string[];
+}

package/src/models/search-country-faq/i-search-country-faq.js

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

package/src/models/search-country-faq/public-search-country-faq-client.d.ts

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

package/src/models/search-country-faq/public-search-country-faq-client.js

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

package/src/models/search-discipline/i-search-discipline.d.ts

@@ -1,26 +1,26 @@
-export interface ISearchDiscipline {
-    /**
-     * @return string | null
-     */
-    getIcon(): string | null;
-    /**
-     * @return number
-     */
-    getId(): number;
-    /**
-     * @return string
-     */
-    getName(): string;
-    /**
-     * @return string | null
-     */
-    getOldVirtualPath(): string | null;
-    /**
-     * @return number | null
-     */
-    getParentId(): number | null;
-    /**
-     * @return string
-     */
-    getVirtualPath(): string;
-}
+export interface ISearchDiscipline {
+    /**
+     * @return string | null
+     */
+    getIcon(): string | null;
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getName(): string;
+    /**
+     * @return string | null
+     */
+    getOldVirtualPath(): string | null;
+    /**
+     * @return number | null
+     */
+    getParentId(): number | null;
+    /**
+     * @return string
+     */
+    getVirtualPath(): string;
+}

package/src/models/search-discipline/i-search-discipline.js

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

package/src/models/search-discipline/public-search-discipline-client.d.ts

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

package/src/models/search-discipline/public-search-discipline-client.js

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