@studyportals/domain-client 3.5.2 → 3.6.0-0

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/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/search-country-faq/i-search-country-faq.d.ts

@@ -1,18 +1,18 @@
-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
+     */
+    getRankingCountryLink(): 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-projection/i-geo-targeting-configuration.d.ts

@@ -1,38 +1,38 @@
-export interface IGeoTargetingConfiguration {
-    /**
-     * Bit set 1 of targeted country ID information.
-     *
-     * @return number
-     */
-    getBit1(): number;
-    /**
-     * Bit set 2 of targeted country ID information.
-     *
-     * @return number
-     */
-    getBit2(): number;
-    /**
-     * Bit set 3 of targeted country ID information.
-     *
-     * @return number
-     */
-    getBit3(): number;
-    /**
-     * Bit set 4 of targeted country ID information.
-     *
-     * @return number
-     */
-    getBit4(): number;
-    /**
-     * Bit set 5 of targeted country ID information.
-     *
-     * @return number
-     */
-    getBit5(): number;
-    /**
-     * List of all configured country IDs.
-     *
-     * @return number[]
-     */
-    getTargetedCountries(): number[];
-}
+export interface IGeoTargetingConfiguration {
+    /**
+     * Bit set 1 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit1(): number;
+    /**
+     * Bit set 2 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit2(): number;
+    /**
+     * Bit set 3 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit3(): number;
+    /**
+     * Bit set 4 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit4(): number;
+    /**
+     * Bit set 5 of targeted country ID information.
+     *
+     * @return number
+     */
+    getBit5(): number;
+    /**
+     * List of all configured country IDs.
+     *
+     * @return number[]
+     */
+    getTargetedCountries(): number[];
+}

package/src/models/search-projection/i-geo-targeting-configuration.js

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

package/src/models/search-projection/i-geo-targeting-values.d.ts

@@ -1,30 +1,30 @@
-import { IGeoTargetingConfiguration } from "../../..";
-export interface IGeoTargetingValues {
-    /**
-     * Geo-targeting configuration for "light premium" listing.
-     *
-     * @return IGeoTargetingConfiguration
-     */
-    getLightPremium(): IGeoTargetingConfiguration;
-    canShowLightPremium(): boolean;
-    /**
-     * Geo-targeting configuration for "premium" listing.
-     *
-     * @return IGeoTargetingConfiguration
-     */
-    getPremium(): IGeoTargetingConfiguration;
-    canShowPremium(): boolean;
-    /**
-     * Geo-targeting configuration for "super premium" listing.
-     *
-     * @return IGeoTargetingConfiguration
-     */
-    getSuperPremium(): IGeoTargetingConfiguration;
-    canShowSuperPremium(): boolean;
-    /**
-     * Programme has active geo-targeting settings.
-     *
-     * @return boolean
-     */
-    isGeoTargeted(): boolean;
-}
+import { IGeoTargetingConfiguration } from "../../..";
+export interface IGeoTargetingValues {
+    /**
+     * Geo-targeting configuration for "light premium" listing.
+     *
+     * @return IGeoTargetingConfiguration
+     */
+    getLightPremium(): IGeoTargetingConfiguration;
+    canShowLightPremium(): boolean;
+    /**
+     * Geo-targeting configuration for "premium" listing.
+     *
+     * @return IGeoTargetingConfiguration
+     */
+    getPremium(): IGeoTargetingConfiguration;
+    canShowPremium(): boolean;
+    /**
+     * Geo-targeting configuration for "super premium" listing.
+     *
+     * @return IGeoTargetingConfiguration
+     */
+    getSuperPremium(): IGeoTargetingConfiguration;
+    canShowSuperPremium(): boolean;
+    /**
+     * Programme has active geo-targeting settings.
+     *
+     * @return boolean
+     */
+    isGeoTargeted(): boolean;
+}

package/src/models/search-projection/i-geo-targeting-values.js

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

package/src/models/search-projection/i-organisation-values.d.ts

@@ -1,40 +1,40 @@
-export interface IOrganisationValues {
-    /**
-     * Country ID of the top level organisation.
-     *
-     * @return number
-     */
-    getCountryId(): number;
-    /**
-     * ID of the programme's main organisation.
-     *
-     * First premium organisation or top level organisation.
-     *
-     * @return number
-     */
-    getId(): number;
-    /**
-     * Name of the programme's main organisation.
-     *
-     * First premium organisation or top level organisation.
-     *
-     * @return string
-     */
-    getName(): string;
-    /**
-     * List of all organisation IDs attached to the programme (main + sub).
-     *
-     * @return number[]
-     */
-    getOrganisations(): number[];
-    /**
-     * Region ID of the top level organisation.
-     *
-     * Currently only possible region ID is 38 (EEA region). All other regions
-     * are ignored for this field.
-     *
-     * @return number
-     */
-    getRegionId(): number;
-    canShowRegionId(): boolean;
-}
+export interface IOrganisationValues {
+    /**
+     * Country ID of the top level organisation.
+     *
+     * @return number
+     */
+    getCountryId(): number;
+    /**
+     * ID of the programme's main organisation.
+     *
+     * First premium organisation or top level organisation.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Name of the programme's main organisation.
+     *
+     * First premium organisation or top level organisation.
+     *
+     * @return string
+     */
+    getName(): string;
+    /**
+     * List of all organisation IDs attached to the programme (main + sub).
+     *
+     * @return number[]
+     */
+    getOrganisations(): number[];
+    /**
+     * Region ID of the top level organisation.
+     *
+     * Currently only possible region ID is 38 (EEA region). All other regions
+     * are ignored for this field.
+     *
+     * @return number
+     */
+    getRegionId(): number;
+    canShowRegionId(): boolean;
+}

package/src/models/search-projection/i-organisation-values.js

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