@studyportals/domain-client 3.26.0 → 3.27.0-beta.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-for-search/i-organisation-for-search.d.ts

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"public-organisation-for-search-client.js","sourceRoot":"","sources":["../../../../src/models/organisation-for-search/public-organisation-for-search-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,iCAAkC,SAAQ,0BAAmC;IAC/E,YAAY;QACrB,OAAO,yBAAyB,CAAC;IAClC,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AAZD,8EAYC"}

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

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

@@ -1,20 +1,20 @@
-export interface IDeadline {
-    /**
-     * Get the date this deadline expires on.
-     *
-     * @return Date
-     */
-    getDate(): Date;
-    /**
-     * Get the deadline type (e.g. general, national, eea, etc).
-     *
-     * @return string
-     */
-    getType(): string;
-    /**
-     * True if the deadline has passed (e.g. you can't apply anymore).
-     *
-     * @return boolean
-     */
-    isPassed(): boolean;
-}
+export interface IDeadline {
+    /**
+     * Get the date this deadline expires on.
+     *
+     * @return Date
+     */
+    getDate(): Date;
+    /**
+     * Get the deadline type (e.g. general, national, eea, etc).
+     *
+     * @return string
+     */
+    getType(): string;
+    /**
+     * True if the deadline has passed (e.g. you can't apply anymore).
+     *
+     * @return boolean
+     */
+    isPassed(): boolean;
+}

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

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

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

@@ -1,40 +1,40 @@
-export interface IDuration {
-    /**
-     * Get the amount of periods the programme takes to complete.
-     *
-     * Note: Durations of more than 70 days (with period === 'days') are
-     * automatically calculated back to an amount of months.
-     *
-     * @return number
-     */
-    getAmount(): number;
-    /**
-     * Get an optional textual description of the duration.
-     *
-     * @return string
-     * @throws PropertyNotAvailableException
-     */
-    getDescription(): string;
-    canShowDescription(): boolean;
-    /**
-     * Get the original duration amount before any calculations.
-     *
-     * @return number
-     */
-    getOriginalDuration(): number;
-    /**
-     * Get the original duration period before any calculations.
-     *
-     * @return string
-     */
-    getOriginalPeriod(): string;
-    /**
-     * Get the period this duration is provided in (days or months).
-     *
-     * Note: Durations of more than 70 days (with period === 'days') are
-     * automatically calculated back to an amount of months.
-     *
-     * @return string
-     */
-    getPeriod(): string;
-}
+export interface IDuration {
+    /**
+     * Get the amount of periods the programme takes to complete.
+     *
+     * Note: Durations of more than 70 days (with period === 'days') are
+     * automatically calculated back to an amount of months.
+     *
+     * @return number
+     */
+    getAmount(): number;
+    /**
+     * Get an optional textual description of the duration.
+     *
+     * @return string
+     * @throws PropertyNotAvailableException
+     */
+    getDescription(): string;
+    canShowDescription(): boolean;
+    /**
+     * Get the original duration amount before any calculations.
+     *
+     * @return number
+     */
+    getOriginalDuration(): number;
+    /**
+     * Get the original duration period before any calculations.
+     *
+     * @return string
+     */
+    getOriginalPeriod(): string;
+    /**
+     * Get the period this duration is provided in (days or months).
+     *
+     * Note: Durations of more than 70 days (with period === 'days') are
+     * automatically calculated back to an amount of months.
+     *
+     * @return string
+     */
+    getPeriod(): string;
+}

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

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

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

@@ -1,22 +1,22 @@
-export interface ILink {
-    /**
-     * Get an optional text describing the link (typically <a>-tags contents).
-     *
-     * @return string
-     * @throws PropertyNotAvailableException
-     */
-    getDescription(): string;
-    canShowDescription(): boolean;
-    /**
-     * 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 ILink {
+    /**
+     * Get an optional text describing the link (typically <a>-tags contents).
+     *
+     * @return string
+     * @throws PropertyNotAvailableException
+     */
+    getDescription(): string;
+    canShowDescription(): boolean;
+    /**
+     * 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-link.js

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