@studyportals/domain-client 4.12.0 → 4.13.0-beta.0

package/src/models/customerio-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/customerio-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/organisation-card/i-organisation-card.d.ts

@@ -1,36 +1,36 @@
-import { IRankingDiscipline } from "./i-ranking-discipline";
-export interface IOrganisationCard {
-    getNumberOfProgrammesForBachelors(): number;
-    getNumberOfProgrammesForDistanceLearning(): number;
-    getNumberOfProgrammesForMasters(): number;
-    getNumberOfProgrammesForPhd(): number;
-    getNumberOfProgrammesForShortCourses(): number;
-    getOrganisationGlobalMetaRankingPosition(): number | null;
-    getOrganisationMetaRankingPositionsByDiscipline(): IRankingDiscipline[] | null;
-    getOrganisationGlobalPositionPercentage(): string | null;
-    getOrganisationHasDeliveryMethodBlended(): boolean;
-    getOrganisationHasDeliveryMethodOnCampus(): boolean;
-    getOrganisationHasDeliveryMethodOnline(): boolean;
-    getOrganisationId(): number;
-    getOrganisationIsPremium(): boolean;
-    getOrganisationLocationCityName(): string | null;
-    getOrganisationLocationCityRelativeLinkOfDetailPage(): string | null;
-    getOrganisationLocationCountryIsoCode(): string | null;
-    getOrganisationLocationCountryName(): string | null;
-    getOrganisationLocationCountryRelativeLinkOfDetailPage(): string | null;
-    getOrganisationLocationAreaCode(): string | null;
-    getOrganisationLogoSquareCdn(): string | null;
-    getOrganisationMayShowCoverImage(): boolean;
-    getOrganisationMayShowLogoSquare(): boolean;
-    getOrganisationName(): string;
-    getOrganisationRelativeLinkOfDetailPage(): string;
-    getOrganisationSummary(): string | null;
-    getOrganisationVenuesCount(): number;
-    getScholarshipsCountForBachelors(): number;
-    getScholarshipsCountForMasters(): number;
-    getScholarshipsCountForPhd(): number;
-    isForProfitFunding(): boolean;
-    isNonProfitFunding(): boolean;
-    isPublicFunding(): boolean;
-    getCampaignType(): number;
-}
+import { IRankingDiscipline } from "./i-ranking-discipline";
+export interface IOrganisationCard {
+    getNumberOfProgrammesForBachelors(): number;
+    getNumberOfProgrammesForDistanceLearning(): number;
+    getNumberOfProgrammesForMasters(): number;
+    getNumberOfProgrammesForPhd(): number;
+    getNumberOfProgrammesForShortCourses(): number;
+    getOrganisationGlobalMetaRankingPosition(): number | null;
+    getOrganisationMetaRankingPositionsByDiscipline(): IRankingDiscipline[] | null;
+    getOrganisationGlobalPositionPercentage(): string | null;
+    getOrganisationHasDeliveryMethodBlended(): boolean;
+    getOrganisationHasDeliveryMethodOnCampus(): boolean;
+    getOrganisationHasDeliveryMethodOnline(): boolean;
+    getOrganisationId(): number;
+    getOrganisationIsPremium(): boolean;
+    getOrganisationLocationCityName(): string | null;
+    getOrganisationLocationCityRelativeLinkOfDetailPage(): string | null;
+    getOrganisationLocationCountryIsoCode(): string | null;
+    getOrganisationLocationCountryName(): string | null;
+    getOrganisationLocationCountryRelativeLinkOfDetailPage(): string | null;
+    getOrganisationLocationAreaCode(): string | null;
+    getOrganisationLogoSquareCdn(): string | null;
+    getOrganisationMayShowCoverImage(): boolean;
+    getOrganisationMayShowLogoSquare(): boolean;
+    getOrganisationName(): string;
+    getOrganisationRelativeLinkOfDetailPage(): string;
+    getOrganisationSummary(): string | null;
+    getOrganisationVenuesCount(): number;
+    getScholarshipsCountForBachelors(): number;
+    getScholarshipsCountForMasters(): number;
+    getScholarshipsCountForPhd(): number;
+    isForProfitFunding(): boolean;
+    isNonProfitFunding(): boolean;
+    isPublicFunding(): boolean;
+    getCampaignType(): number;
+}

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

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

package/src/models/organisation-card/i-ranking-discipline.d.ts

@@ -1,4 +1,4 @@
-export interface IRankingDiscipline {
-    getDisciplineId(): number;
-    getPosition(): number | null;
-}
+export interface IRankingDiscipline {
+    getDisciplineId(): number;
+    getPosition(): number | null;
+}

package/src/models/organisation-card/i-ranking-discipline.js

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

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

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

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

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

package/src/models/organisation-for-search/i-organisation-for-search.d.ts

@@ -1,26 +1,32 @@
-export interface IOrganisationForSearch {
-    /**
-     * Gets the ISO codes of all countries where the organisation has venues.
-     *
-     * @return string[]
-     */
-    getIsoCodesOfCountriesOfVenues(): string[];
-    /**
-     * Gets the ID of the organisation.
-     *
-     * @return number
-     */
-    getOrganisationId(): number;
-    /**
-     * Gets the name of the organisation.
-     *
-     * @return string
-     */
-    getOrganisationName(): string;
-    /**
-     * Gets the virtual name of the organisation.
-     *
-     * @return string
-     */
-    getOrganisationVirtualName(): string;
-}
+export interface IOrganisationForSearch {
+    /**
+     * Gets the ISO codes of all countries where the organisation has venues.
+     *
+     * @return string[]
+     */
+    getIsoCodesOfCountriesOfVenues(): string[];
+    /**
+     * Gets the ISO country code of the main location of the organisation
+     *
+     * @return string
+     */
+    getMainLocationCountryIsoCode(): string;
+    /**
+     * Gets the ID of the organisation.
+     *
+     * @return number
+     */
+    getOrganisationId(): number;
+    /**
+     * Gets the name of the organisation.
+     *
+     * @return string
+     */
+    getOrganisationName(): string;
+    /**
+     * Gets the virtual name of the organisation.
+     *
+     * @return string
+     */
+    getOrganisationVirtualName(): string;
+}

package/src/models/organisation-for-search/i-organisation-for-search.js

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

package/src/models/organisation-for-search/public-organisation-for-search-client.d.ts

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

package/src/models/organisation-for-search/public-organisation-for-search-client.js

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

package/src/models/organisation-search-document/i-organisation-search-document.d.ts

@@ -1,116 +1,116 @@
-export interface IOrganisationSearchDocument {
-    /**
-     * Gets the ISO codes of all countries where the organisation has venues
-     *
-     * @return string[]
-     */
-    getCountryIsoCodesOfVenues(): string[];
-    /**
-     * Returns the number of bachelors offered by the organisation
-     *
-     * @return number
-     */
-    getNumberOfProgrammesForBachelors(): number;
-    /**
-     * Returns the number of distance learning courses offered by the organisation
-     *
-     * @return number
-     */
-    getNumberOfProgrammesForDistanceLearning(): number;
-    /**
-     * Returns the number of masters offered by the organisation
-     *
-     * @return number
-     */
-    getNumberOfProgrammesForMasters(): number;
-    /**
-     * Returns the number of phds offered by the organisation
-     *
-     * @return number
-     */
-    getNumberOfProgrammesForPhd(): number;
-    /**
-     * Returns the number of short courses offered by the organisation
-     *
-     * @return number
-     */
-    getNumberOfProgrammesForShortCourses(): number;
-    /**
-     * Gets the ID of the organisation.
-     *
-     * @return number
-     */
-    getOrganisationId(): number;
-    /**
-     * Gets the premium type of the organisation
-     *
-     * @return string | null
-     */
-    getPremiumType(): string | null;
-    /**
-     * Cheked whether the organisation has studies taught both online and on campus
-     *
-     * @return boolean
-     */
-    hasDeliveryMethodBlended(): boolean;
-    /**
-     * Cheked whether the organisation has studies taught on campus
-     *
-     * @return boolean
-     */
-    hasDeliveryMethodOnCampus(): boolean;
-    /**
-     * Cheked whether the organisation has studies taught online
-     *
-     * @return boolean
-     */
-    hasDeliveryMethodOnline(): boolean;
-    /**
-     * Gets the IDs of all areas where the organisation has venues
-     *
-     * @return number[]
-     */
-    identifyAreasOfVenues(): number[];
-    /**
-     * Gets the disciplines of Bachelors programmes taught at the organisation
-     *
-     * @return number[]
-     */
-    identifyDisciplinesForBachelors(): number[];
-    /**
-     * Gets the disciplines of Masters programmes taught at the organisation
-     *
-     * @return number[]
-     */
-    identifyDisciplinesForMasters(): number[];
-    /**
-     * Gets the disciplines of PhD programmes taught at the organisation
-     *
-     * @return number[]
-     */
-    identifyDisciplinesForPhd(): number[];
-    /**
-     * Gets the disciplines of short courses programmes taught at the organisation
-     *
-     * @return number[]
-     */
-    identifyDisciplinesForShortCourses(): number[];
-    /**
-     * Gets the IDs of all regions (continents) where the organisation has venues
-     *
-     * @return number[]
-     */
-    identifyRegionsOfVenues(): number[];
-    /**
-     * Returns true when the organisation does not have a parent organisation
-     *
-     * @return boolean
-     */
-    isMainOrganisation(): boolean;
-    /**
-     * Indicates whether the organisation is published or not
-     *
-     * @return boolean
-     */
-    isPublished(): boolean;
-}
+export interface IOrganisationSearchDocument {
+    /**
+     * Gets the ISO codes of all countries where the organisation has venues
+     *
+     * @return string[]
+     */
+    getCountryIsoCodesOfVenues(): string[];
+    /**
+     * Returns the number of bachelors offered by the organisation
+     *
+     * @return number
+     */
+    getNumberOfProgrammesForBachelors(): number;
+    /**
+     * Returns the number of distance learning courses offered by the organisation
+     *
+     * @return number
+     */
+    getNumberOfProgrammesForDistanceLearning(): number;
+    /**
+     * Returns the number of masters offered by the organisation
+     *
+     * @return number
+     */
+    getNumberOfProgrammesForMasters(): number;
+    /**
+     * Returns the number of phds offered by the organisation
+     *
+     * @return number
+     */
+    getNumberOfProgrammesForPhd(): number;
+    /**
+     * Returns the number of short courses offered by the organisation
+     *
+     * @return number
+     */
+    getNumberOfProgrammesForShortCourses(): number;
+    /**
+     * Gets the ID of the organisation.
+     *
+     * @return number
+     */
+    getOrganisationId(): number;
+    /**
+     * Gets the premium type of the organisation
+     *
+     * @return string | null
+     */
+    getPremiumType(): string | null;
+    /**
+     * Cheked whether the organisation has studies taught both online and on campus
+     *
+     * @return boolean
+     */
+    hasDeliveryMethodBlended(): boolean;
+    /**
+     * Cheked whether the organisation has studies taught on campus
+     *
+     * @return boolean
+     */
+    hasDeliveryMethodOnCampus(): boolean;
+    /**
+     * Cheked whether the organisation has studies taught online
+     *
+     * @return boolean
+     */
+    hasDeliveryMethodOnline(): boolean;
+    /**
+     * Gets the IDs of all areas where the organisation has venues
+     *
+     * @return number[]
+     */
+    identifyAreasOfVenues(): number[];
+    /**
+     * Gets the disciplines of Bachelors programmes taught at the organisation
+     *
+     * @return number[]
+     */
+    identifyDisciplinesForBachelors(): number[];
+    /**
+     * Gets the disciplines of Masters programmes taught at the organisation
+     *
+     * @return number[]
+     */
+    identifyDisciplinesForMasters(): number[];
+    /**
+     * Gets the disciplines of PhD programmes taught at the organisation
+     *
+     * @return number[]
+     */
+    identifyDisciplinesForPhd(): number[];
+    /**
+     * Gets the disciplines of short courses programmes taught at the organisation
+     *
+     * @return number[]
+     */
+    identifyDisciplinesForShortCourses(): number[];
+    /**
+     * Gets the IDs of all regions (continents) where the organisation has venues
+     *
+     * @return number[]
+     */
+    identifyRegionsOfVenues(): number[];
+    /**
+     * Returns true when the organisation does not have a parent organisation
+     *
+     * @return boolean
+     */
+    isMainOrganisation(): boolean;
+    /**
+     * Indicates whether the organisation is published or not
+     *
+     * @return boolean
+     */
+    isPublished(): boolean;
+}

package/src/models/organisation-search-document/i-organisation-search-document.js

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

package/src/models/organisation-search-document/organisation-search-document-client.d.ts

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

package/src/models/organisation-search-document/organisation-search-document-client.js

@@ -1,17 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrganisationSearchDocumentClient = void 0;
-const model_client_1 = require("../../model-client");
-class OrganisationSearchDocumentClient extends model_client_1.ModelClient {
-    getModelName() {
-        return 'organisation-search-document';
-    }
-    getVersion() {
-        return 'v1';
-    }
-    isPublic() {
-        return false;
-    }
-}
-exports.OrganisationSearchDocumentClient = OrganisationSearchDocumentClient;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganisationSearchDocumentClient = void 0;
+const model_client_1 = require("../../model-client");
+class OrganisationSearchDocumentClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'organisation-search-document';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.OrganisationSearchDocumentClient = OrganisationSearchDocumentClient;
 //# sourceMappingURL=organisation-search-document-client.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