@studyportals/domain-client 3.31.0 → 3.32.0-1

package/src/models/dotdigital-programme/i-timing.d.ts

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

package/src/models/dotdigital-programme/i-timing.js

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

package/src/models/dotdigital-programme/i-timing.js.map

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

package/src/models/dotdigital-programme/i-tuition-fee.d.ts

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

package/src/models/dotdigital-programme/i-tuition-fee.js

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

package/src/models/dotdigital-programme/i-tuition-fee.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-tuition-fee.js","sourceRoot":"","sources":["../../../../src/models/dotdigital-programme/i-tuition-fee.ts"],"names":[],"mappings":""}

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

@@ -1,68 +1,68 @@
-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[];
-}
+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[];
+}

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

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