@studyportals/domain-client 3.30.0 → 3.32.0-organisations.0

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

@@ -1,107 +1,107 @@
-import { ICountry, IEnglishRequirements, IInternalLink, ILogo, ITiming, 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;
-    /**
-     * Get all start dates
-     *
-     * @return ITiming[]
-     */
-    getTimings(): ITiming[];
-    /**
-     * 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;
-}
+import { ICountry, IEnglishRequirements, IInternalLink, ILogo, ITiming, 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;
+    /**
+     * Get all start dates
+     *
+     * @return ITiming[]
+     */
+    getTimings(): ITiming[];
+    /**
+     * 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/organisation-card/i-organisation-card.d.ts

@@ -1,17 +1,17 @@
-export interface IOrganisationCard {
-    getOrganisationCoverImageCdn(): string | null;
-    getOrganisationHasDeliveryMethodBlended(): boolean;
-    getOrganisationHasDeliveryMethodOnCampus(): boolean;
-    getOrganisationHasDeliveryMethodOnline(): boolean;
-    getOrganisationId(): number;
-    getOrganisationLocationCityName(): string | null;
-    getOrganisationLocationCityRelativeLinkOfDetailPage(): string | null;
-    getOrganisationLocationCountryIsoCode(): string | null;
-    getOrganisationLocationCountryRelativeLinkOfDetailPage(): string | null;
-    getOrganisationLogoSquareCdn(): string | null;
-    getOrganisationMayShowCoverImage(): boolean;
-    getOrganisationMayShowLogoSquare(): boolean;
-    getOrganisationName(): string;
-    getOrganisationRelativeLinkOfDetailPage(): string;
-    getOrganisationSummary(): string | null;
-}
+export interface IOrganisationCard {
+    getOrganisationCoverImageCdn(): string | null;
+    getOrganisationHasDeliveryMethodBlended(): boolean;
+    getOrganisationHasDeliveryMethodOnCampus(): boolean;
+    getOrganisationHasDeliveryMethodOnline(): boolean;
+    getOrganisationId(): number;
+    getOrganisationLocationCityName(): string | null;
+    getOrganisationLocationCityRelativeLinkOfDetailPage(): string | null;
+    getOrganisationLocationCountryIsoCode(): string | null;
+    getOrganisationLocationCountryRelativeLinkOfDetailPage(): string | null;
+    getOrganisationLogoSquareCdn(): string | null;
+    getOrganisationMayShowCoverImage(): boolean;
+    getOrganisationMayShowLogoSquare(): boolean;
+    getOrganisationName(): string;
+    getOrganisationRelativeLinkOfDetailPage(): string;
+    getOrganisationSummary(): string | null;
+}

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/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,26 @@
-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 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

@@ -0,0 +1,69 @@
+export interface IOrganisationSearchDocument {
+    /**
+     * Gets the ISO codes of all countries where the organisation has venues
+     *
+     * @return string[]
+     */
+    getCountryIsoCodesOfVenues(): string[];
+    /**
+     * 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[];
+    /**
+     * Indicates whether the organisation is published or not
+     *
+     * @return boolean
+     */
+    isPublished(): boolean;
+}

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

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

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

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

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"organisation-search-document-client.js","sourceRoot":"","sources":["../../../../src/models/organisation-search-document/organisation-search-document-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,gCAAiC,SAAQ,0BAAwC;IACnF,YAAY;QACrB,OAAO,8BAA8B,CAAC;IACvC,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,4EAYC"}

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

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

@@ -1,14 +1,14 @@
-export interface ICover {
-    /**
-     * Get the file ID of the cover (as known in the system)
-     *
-     * @return number
-     */
-    getId(): number;
-    /**
-     * Get the source URL for the cover.
-     *
-     * @return string
-     */
-    getSource(): string;
-}
+export interface ICover {
+    /**
+     * Get the file ID of the cover (as known in the system)
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Get the source URL for the cover.
+     *
+     * @return string
+     */
+    getSource(): string;
+}

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

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