@studyportals/domain-client 3.31.0 → 3.32.0-1

package/src/models/compare-programme/i-internal-link.d.ts

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

package/src/models/compare-programme/i-internal-link.js

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

package/src/models/compare-programme/i-internal-link.js.map

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

package/src/models/compare-programme/i-link.d.ts

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

package/src/models/compare-programme/i-link.js

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

package/src/models/compare-programme/i-link.js.map

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

package/src/models/compare-programme/i-living-cost.d.ts

@@ -0,0 +1,20 @@
+export interface ILivingCost {
+    /**
+     * Get the applicable currency.
+     *
+     * @return string
+     */
+    getCurrency(): string;
+    /**
+     * Get the maximum living cost in the provided currency.
+     *
+     * @return number
+     */
+    getMax(): number;
+    /**
+     * Get the minimum living cost in the provided currency.
+     *
+     * @return number
+     */
+    getMin(): number;
+}

package/src/models/compare-programme/i-living-cost.js

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

package/src/models/compare-programme/i-living-cost.js.map

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

package/src/models/compare-programme/i-location.d.ts

@@ -0,0 +1,12 @@
+import { IOptionalLink } from "../../..";
+export interface ILocation {
+    getArea(): IOptionalLink;
+    canShowArea(): boolean;
+    getAreaId(): number;
+    getCity(): IOptionalLink;
+    getCityId(): number;
+    getCountry(): IOptionalLink;
+    getCountryId(): number;
+    getCountryIso(): string;
+    hasAreaId(): boolean;
+}

package/src/models/compare-programme/i-location.js

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

package/src/models/compare-programme/i-location.js.map

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

package/src/models/compare-programme/i-optional-link.d.ts

@@ -0,0 +1,23 @@
+export interface IOptionalLink {
+    /**
+     * 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;
+    canShowUrl(): boolean;
+}

package/src/models/compare-programme/i-optional-link.js

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

package/src/models/compare-programme/i-optional-link.js.map

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

package/src/models/compare-programme/i-start-date.d.ts

@@ -0,0 +1,33 @@
+import { IDeadline } from "../../..";
+export interface IStartDate {
+    /**
+     * Get the date the programme starts on.
+     *
+     * @return Date
+     */
+    getDate(): Date;
+    /**
+     * Get a list of deadlines that apply to this start date.
+     *
+     * Note: In case of extendable start dates, all information in the
+     * Deadline objects has already been extended to the first available start
+     * date.
+     *
+     * @return IDeadline[]
+     * @throws PropertyNotAvailableException
+     */
+    getDeadlines(): IDeadline[];
+    canShowDeadlines(): boolean;
+    /**
+     * True if you can apply at any time for this programme (rolling admission)
+     *
+     * @return boolean
+     */
+    isApplyingAnytime(): boolean;
+    /**
+     * True if the start date has passed (you can't start at this date anymore).
+     *
+     * @return boolean
+     */
+    isPassed(): boolean;
+}

package/src/models/compare-programme/i-start-date.js

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

package/src/models/compare-programme/i-start-date.js.map

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

package/src/models/compare-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/compare-programme/i-timing.js

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

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

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

package/src/models/compare-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/compare-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/compare-programme/i-tuition-fee.js.map

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

package/src/models/copilot-country/copilot-country-client.d.ts

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

package/src/models/copilot-country/copilot-country-client.js

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

package/src/models/copilot-country/copilot-country-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copilot-country-client.js","sourceRoot":"","sources":["../../../../src/models/copilot-country/copilot-country-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,oBAAqB,SAAQ,0BAA4B;IAC3D,YAAY;QACrB,OAAO,iBAAiB,CAAC;IAC1B,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,oDAYC"}

package/src/models/copilot-country/i-copilot-country.d.ts

@@ -0,0 +1,32 @@
+export interface ICopilotCountry {
+    /**
+     * How to apply in country x text
+     *
+     * @return string | null
+     */
+    getHowToApplyText(): string | null;
+    /**
+     * Id of the country.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * ISO code ALPHA-2
+     *
+     * @return string
+     */
+    getIsoCode(): string;
+    /**
+     * Country title
+     *
+     * @return string
+     */
+    getTitle(): string;
+    /**
+     * Why study in country x text
+     *
+     * @return string | null
+     */
+    getWhyText(): string | null;
+}

package/src/models/copilot-country/i-copilot-country.js

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

package/src/models/copilot-country/i-copilot-country.js.map

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

package/src/models/copilot-programme/copilot-programme-client.d.ts

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

package/src/models/copilot-programme/copilot-programme-client.js

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

package/src/models/copilot-programme/copilot-programme-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copilot-programme-client.js","sourceRoot":"","sources":["../../../../src/models/copilot-programme/copilot-programme-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,sBAAuB,SAAQ,0BAA8B;IAC/D,YAAY;QACrB,OAAO,mBAAmB,CAAC;IAC5B,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,wDAYC"}

package/src/models/copilot-programme/i-copilot-programme.d.ts

@@ -0,0 +1,86 @@
+import { IEnglishRequirements, IGeoTargetingValues, IInternalLink, ITiming, ITuitionValues } from "../../..";
+export interface ICopilotProgramme {
+    /**
+     * Get country the programme is teached in
+     *
+     * @return number[]
+     */
+    getCountryIds(): number[];
+    /**
+     * Get discipline ids attached to this programme
+     *
+     * @return number[]
+     */
+    getDisciplineIds(): number[];
+    /**
+     * Education level
+     *
+     * @return string
+     */
+    getEducationalLevel(): string;
+    /**
+     * English level requirements.
+     *
+     * @return IEnglishRequirements
+     */
+    getEnglishRequirements(): IEnglishRequirements;
+    getGeneralRequirements(): string | null;
+    /**
+     * Get geotargetting settings for the programme
+     *
+     * @return IGeoTargetingValues
+     */
+    getGeoTargetingValues(): IGeoTargetingValues;
+    getGlobalUniversityRanking(): string | null;
+    /**
+     * Id of the programme.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * 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;
+    /**
+     * Get all start dates
+     *
+     * @return ITiming[]
+     */
+    getTimings(): ITiming[];
+    /**
+     * Title of the programme.
+     *
+     * @return string
+     */
+    getTitle(): string;
+    /**
+     * The programmes tuition fees
+     *
+     * @return ITuitionValues | null
+     */
+    getTuitionValues(): ITuitionValues | null;
+    /**
+     * University id
+     *
+     * @return number
+     */
+    getUniversityId(): number;
+    /**
+     * University title
+     *
+     * @return string
+     */
+    getUniversityTitle(): string;
+    /**
+     * Is programme public
+     *
+     * @return boolean
+     */
+    isPublic(): boolean;
+}

package/src/models/copilot-programme/i-copilot-programme.js

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

package/src/models/copilot-programme/i-copilot-programme.js.map

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

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

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

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

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

package/src/models/dotdigital-organisation/i-city.d.ts

@@ -0,0 +1,14 @@
+export interface ICity {
+    /**
+     * Get city id
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Get city name
+     *
+     * @return string
+     */
+    getName(): string;
+}

package/src/models/dotdigital-organisation/i-city.js

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

package/src/models/dotdigital-organisation/i-city.js.map

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

package/src/models/dotdigital-organisation/i-country.d.ts

@@ -0,0 +1,20 @@
+export interface ICountry {
+    /**
+     * Get country iso code
+     *
+     * @return string
+     */
+    getISOCode(): string;
+    /**
+     * Get country id
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Get country name
+     *
+     * @return string
+     */
+    getName(): string;
+}

package/src/models/dotdigital-organisation/i-country.js

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

package/src/models/dotdigital-organisation/i-country.js.map

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