@studyportals/domain-client 3.13.0-2 → 3.14.0-0

package/index.d.ts

@@ -3,15 +3,12 @@ import { ClientException } from "./src/exceptions/client-exception";
 import { InternalServerException } from "./src/exceptions/internal-server-exception";
 import { NotFoundException } from "./src/exceptions/not-found-exception";
 import { PropertyNotAvailableException } from "./src/exceptions/property-not-available-exception";
-import { IInternalLink } from "./src/models/programme-card/i-internal-link";
-import { ILogo } from "./src/models/programme-card/i-logo";
 import { ICover } from "./src/models/programme-card/i-cover";
 import { ILink } from "./src/models/programme-card/i-link";
 import { IOptionalLink } from "./src/models/programme-card/i-optional-link";
 import { ILocation } from "./src/models/programme-card/i-location";
 import { IClickTrackingData } from "./src/models/programme-card/i-click-tracking-data";
 import { ITracking } from "./src/models/programme-card/i-tracking";
-import { ITuitionFee } from "./src/models/programme-card/i-tuition-fee";
 import { IDuration } from "./src/models/programme-card/i-duration";
 import { IDeadline } from "./src/models/programme-card/i-deadline";
 import { IStartDate } from "./src/models/programme-card/i-start-date";
@@ -26,13 +23,14 @@ import { IGeoTargetingConfiguration } from "./src/models/search-projection/i-geo
 import { IGeoTargetingValues } from "./src/models/search-projection/i-geo-targeting-values";
 import { ISearchProjection } from "./src/models/search-projection/i-search-projection";
 import { SearchProjectionClient } from "./src/models/search-projection/search-projection-client";
-import { IEnglishRequirements } from "./src/models/bestfit-programme/i-english-requirements";
-import { ICity } from "./src/models/bestfit-programme/i-city";
 import { ILivingCost } from "./src/models/bestfit-programme/i-living-cost";
 import { IGPARequirement } from "./src/models/bestfit-programme/i-g-p-a-requirement";
 import { IBestFitProgramme } from "./src/models/bestfit-programme/i-best-fit-programme";
 import { BestfitProgrammeClient } from "./src/models/bestfit-programme/bestfit-programme-client";
-import { ICountry } from "./src/models/dotdigital-programme/i-country";
+import { ILogo } from "./src/models/common/i-logo";
+import { ITuitionFee } from "./src/models/common/i-tuition-fee";
+import { IEnglishRequirements } from "./src/models/common/i-english-requirements";
+import { IInternalLink } from "./src/models/dotdigital-programme/i-internal-link";
 import { IDotDigitalProgramme } from "./src/models/dotdigital-programme/i-dot-digital-programme";
 import { DotdigitalProgrammeClient } from "./src/models/dotdigital-programme/dotdigital-programme-client";
 import { ISitemapProgrammeInfo } from "./src/models/sitemap-programme-info/i-sitemap-programme-info";
@@ -48,6 +46,8 @@ import { ISearchDiscipline } from "./src/models/search-discipline/i-search-disci
 import { PublicSearchDisciplineClient } from "./src/models/search-discipline/public-search-discipline-client";
 import { ISitemapDisciplineInfo } from "./src/models/sitemap-disciplines-info/i-sitemap-discipline-info";
 import { SitemapDisciplinesInfoClient } from "./src/models/sitemap-disciplines-info/sitemap-disciplines-info-client";
+import { ICountry } from "./src/models/common/i-country";
+import { ICity } from "./src/models/common/i-city";
 import { IReview } from "./src/models/dotdigital-organisation/i-review";
 import { IDotDigitalOrganisation } from "./src/models/dotdigital-organisation/i-dot-digital-organisation";
 import { DotdigitalOrganisationClient } from "./src/models/dotdigital-organisation/dotdigital-organisation-client";
@@ -62,4 +62,6 @@ import { SitemapCitiesInfoClient } from "./src/models/sitemap-cities-info/sitema
 import { PortalType } from "./src/types/portal-type";
 import { PortalMap } from "./src/types/portal-map";
 import { ModelClient } from "./src/model-client";
-export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, ILogo, ITuitionFee, IEnglishRequirements, IInternalLink, IDotDigitalProgramme, DotdigitalProgrammeClient, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISearchCountryFaq, PublicSearchCountryFaqClient, ISitemapCountryInfo, SitemapCountriesInfoClient, IDegreeInfo, ISitemapCountryDegreeInfo, SitemapCountryDegreeInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, IDotDigitalOrganisation, DotdigitalOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, PortalType, PortalMap, ModelClient };
+import { ICompareProgramme } from "./src/models/compare-programme/i-compare-programme";
+import { CompareProgrammeClient } from "./src/models/compare-programme/compare-programme-client";
+export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, ILogo, ITuitionFee, IEnglishRequirements, IInternalLink, IDotDigitalProgramme, DotdigitalProgrammeClient, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISearchCountryFaq, PublicSearchCountryFaqClient, ISitemapCountryInfo, SitemapCountriesInfoClient, IDegreeInfo, ISitemapCountryDegreeInfo, SitemapCountryDegreeInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, IDotDigitalOrganisation, DotdigitalOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, ICompareProgramme, CompareProgrammeClient, PortalType, PortalMap, ModelClient };

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelClient = exports.PortalType = exports.SitemapCitiesInfoClient = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = exports.SitemapOrganisationsInfoClient = exports.DotdigitalOrganisationClient = exports.SitemapDisciplinesInfoClient = exports.PublicSearchDisciplineClient = exports.SitemapCountryDegreeInfoClient = exports.SitemapCountriesInfoClient = exports.PublicSearchCountryFaqClient = exports.SitemapProgrammeInfoClient = exports.DotdigitalProgrammeClient = exports.BestfitProgrammeClient = exports.SearchProjectionClient = exports.ProgrammeCardClient = exports.PropertyNotAvailableException = exports.NotFoundException = exports.InternalServerException = exports.ClientException = exports.BadRequestException = void 0;
+exports.ModelClient = exports.PortalType = exports.CompareProgrammeClient = exports.SitemapCitiesInfoClient = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = exports.SitemapOrganisationsInfoClient = exports.DotdigitalOrganisationClient = exports.SitemapDisciplinesInfoClient = exports.PublicSearchDisciplineClient = exports.SitemapCountryDegreeInfoClient = exports.SitemapCountriesInfoClient = exports.PublicSearchCountryFaqClient = exports.SitemapProgrammeInfoClient = exports.DotdigitalProgrammeClient = exports.BestfitProgrammeClient = exports.SearchProjectionClient = exports.ProgrammeCardClient = exports.PropertyNotAvailableException = exports.NotFoundException = exports.InternalServerException = exports.ClientException = exports.BadRequestException = void 0;
 const bad_request_exception_1 = require("./src/exceptions/bad-request-exception");
 Object.defineProperty(exports, "BadRequestException", { enumerable: true, get: function () { return bad_request_exception_1.BadRequestException; } });
 const client_exception_1 = require("./src/exceptions/client-exception");
@@ -45,4 +45,6 @@ const portal_type_1 = require("./src/types/portal-type");
 Object.defineProperty(exports, "PortalType", { enumerable: true, get: function () { return portal_type_1.PortalType; } });
 const model_client_1 = require("./src/model-client");
 Object.defineProperty(exports, "ModelClient", { enumerable: true, get: function () { return model_client_1.ModelClient; } });
+const compare_programme_client_1 = require("./src/models/compare-programme/compare-programme-client");
+Object.defineProperty(exports, "CompareProgrammeClient", { enumerable: true, get: function () { return compare_programme_client_1.CompareProgrammeClient; } });
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AAkE3E,oGAlEQ,2CAAmB,OAkER;AAjEpB,wEAAmE;AAkElE,gGAlEQ,kCAAe,OAkER;AAjEhB,0FAAoF;AAkEnF,wGAlEQ,mDAAuB,OAkER;AAjExB,8EAAwE;AAkEvE,kGAlEQ,uCAAiB,OAkER;AAjElB,wGAAiG;AAkEhG,8GAlEQ,gEAA6B,OAkER;AAlD9B,6FAAwF;AA+DvF,oGA/DQ,2CAAmB,OA+DR;AAxDpB,sGAAiG;AA+DhG,uGA/DQ,iDAAsB,OA+DR;AAzDvB,sGAAiG;AA6DhG,uGA7DQ,iDAAsB,OA6DR;AA1DvB,+GAA0G;AAgEzG,0GAhEQ,uDAAyB,OAgER;AA9D1B,qHAA+G;AAgE9G,2GAhEQ,0DAA0B,OAgER;AA9D3B,uHAAgH;AAgE/G,6GAhEQ,+DAA4B,OAgER;AA9D7B,qHAA+G;AAgE9G,2GAhEQ,0DAA0B,OAgER;AA7D3B,oIAA6H;AAgE5H,+GAhEQ,mEAA8B,OAgER;AA9D/B,oHAA8G;AAgE7G,6GAhEQ,8DAA4B,OAgER;AA9D7B,2HAAqH;AAgEpH,6GAhEQ,8DAA4B,OAgER;AA7D7B,wHAAmH;AAkElH,6GAlEQ,6DAA4B,OAkER;AAhE7B,iIAA2H;AAkE1H,+GAlEQ,kEAA8B,OAkER;AAhE/B,kHAA4G;AAkE3G,0GAlEQ,wDAAyB,OAkER;AAhE1B,kHAA4G;AAkE3G,0GAlEQ,wDAAyB,OAkER;AAhE1B,4GAAsG;AAkErG,wGAlEQ,oDAAuB,OAkER;AAjExB,yDAAqD;AAkEpD,2FAlEQ,wBAAU,OAkER;AAhEX,qDAAiD;AAkEhD,4FAlEQ,0BAAW,OAkER"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AAoE3E,oGApEQ,2CAAmB,OAoER;AAnEpB,wEAAmE;AAoElE,gGApEQ,kCAAe,OAoER;AAnEhB,0FAAoF;AAoEnF,wGApEQ,mDAAuB,OAoER;AAnExB,8EAAwE;AAoEvE,kGApEQ,uCAAiB,OAoER;AAnElB,wGAAiG;AAoEhG,8GApEQ,gEAA6B,OAoER;AAvD9B,6FAAwF;AAoEvF,oGApEQ,2CAAmB,OAoER;AA7DpB,sGAAiG;AAoEhG,uGApEQ,iDAAsB,OAoER;AAhEvB,sGAAiG;AAoEhG,uGApEQ,iDAAsB,OAoER;AA9DvB,+GAA0G;AAoEzG,0GApEQ,uDAAyB,OAoER;AAlE1B,qHAA+G;AAoE9G,2GApEQ,0DAA0B,OAoER;AAlE3B,uHAAgH;AAoE/G,6GApEQ,+DAA4B,OAoER;AAlE7B,qHAA+G;AAoE9G,2GApEQ,0DAA0B,OAoER;AAjE3B,oIAA6H;AAoE5H,+GApEQ,mEAA8B,OAoER;AAlE/B,oHAA8G;AAoE7G,6GApEQ,8DAA4B,OAoER;AAlE7B,2HAAqH;AAoEpH,6GApEQ,8DAA4B,OAoER;AA/D7B,wHAAmH;AAoElH,6GApEQ,6DAA4B,OAoER;AAlE7B,iIAA2H;AAoE1H,+GApEQ,kEAA8B,OAoER;AAlE/B,kHAA4G;AAoE3G,0GApEQ,wDAAyB,OAoER;AAlE1B,kHAA4G;AAoE3G,0GApEQ,wDAAyB,OAoER;AAlE1B,4GAAsG;AAoErG,wGApEQ,oDAAuB,OAoER;AAnExB,yDAAqD;AAsEpD,2FAtEQ,wBAAU,OAsER;AApEX,qDAAiD;AAsEhD,4FAtEQ,0BAAW,OAsER;AApEZ,sGAAgG;AAiE/F,uGAjEQ,iDAAsB,OAiER"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studyportals/domain-client",
-  "version": "3.13.0-2",
+  "version": "3.14.0-0",
   "description": "Responsible for fetching data from the Domain API",
   "main": "bin/index.js",
   "author": "StudyPortals B.V.",

package/src/models/common/i-english-requirements.d.ts

@@ -1,4 +1,11 @@
 export interface IEnglishRequirements {
+    /**
+     * Required score for Cambridge english
+     *
+     * @return number
+     */
+    getCambridgeEnglish(): number;
+    canShowCambridgeEnglish(): boolean;
     /**
      * Required score for IELTS tests
      *

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"compare-programme-client.js","sourceRoot":"","sources":["../../../../src/models/compare-programme/compare-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/compare-programme/i-compare-programme.d.ts

@@ -0,0 +1,86 @@
+import { IDuration, IEnglishRequirements, IGPARequirement, ILink, ILivingCost, ILocation, ITiming, ITuitionFee } from "../../..";
+export interface ICompareProgramme {
+    /**
+     * Duration of the programme
+     *
+     * @return IDuration | null
+     */
+    getDuration(): IDuration | null;
+    /**
+     * English level requirements.
+     *
+     * @return IEnglishRequirements
+     */
+    getEnglishRequirements(): IEnglishRequirements;
+    /**
+     * GPA requirements
+     *
+     * @return IGPARequirement | null
+     */
+    getGPA(): IGPARequirement | null;
+    /**
+     * Id of the programme.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Estimated living cost based on universities' location.
+     *
+     * @return ILivingCost | null
+     */
+    getLivingCost(): ILivingCost | null;
+    /**
+     * Indicates where a programme is taught
+     *
+     * @return ILocation | null
+     */
+    getLocation(): ILocation | null;
+    /**
+     * The universities review quantity
+     *
+     * @return number | null
+     */
+    getReviewQuantity(): number | null;
+    /**
+     * The universities review rating
+     *
+     * @return number | null
+     */
+    getReviewRating(): number | null;
+    /**
+     * Get all start dates
+     *
+     * @return ITiming[]
+     */
+    getTimings(): ITiming[];
+    /**
+     * The programmes tuition fees
+     *
+     * @return ITuitionFee[]
+     */
+    getTuitionFees(): ITuitionFee[];
+    /**
+     * Returns a link to the university
+     *
+     * @return ILink
+     */
+    getUniversityLink(): ILink;
+    /**
+     * Amount of years required as work experience
+     *
+     * @return number | null
+     */
+    getWorkExperienceYears(): number | null;
+    /**
+     * Indicates whenever a programme is fully online or not
+     *
+     * @return boolean
+     */
+    isFullyOnline(): boolean;
+    /**
+     * Is programme public
+     * @return boolean
+     */
+    isPublic(): boolean;
+}

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

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

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

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

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

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

package/src/models/{dotdigital-programme/i-country.js → compare-programme/i-deadline.js}

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

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

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

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

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

package/src/models/{dotdigital-organisation/i-country.js → compare-programme/i-duration.js}

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

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

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

package/src/models/{bestfit-programme → compare-programme}/i-english-requirements.d.ts

@@ -1,4 +1,11 @@
 export interface IEnglishRequirements {
+    /**
+     * Required score for Cambridge english
+     *
+     * @return number
+     */
+    getCambridgeEnglish(): number;
+    canShowCambridgeEnglish(): boolean;
     /**
      * Required score for Duolingo
      *

package/src/models/compare-programme/i-english-requirements.js.map

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

package/src/models/compare-programme/i-g-p-a-requirement.d.ts

@@ -0,0 +1,20 @@
+export interface IGPARequirement {
+    /**
+     * The used GPA scale for this requirement
+     *
+     * @return string
+     */
+    getScale(): string;
+    /**
+     * Required minimum score.
+     *
+     * @return string
+     */
+    getScore(): string;
+    /**
+     * Is GPA recommended or required.
+     *
+     * @return boolean
+     */
+    isRequired(): boolean;
+}

package/src/models/compare-programme/i-g-p-a-requirement.js

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

package/src/models/compare-programme/i-g-p-a-requirement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-g-p-a-requirement.js","sourceRoot":"","sources":["../../../../src/models/compare-programme/i-g-p-a-requirement.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/{dotdigital-programme/i-logo.js → compare-programme/i-link.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=i-logo.js.map
+//# 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,11 @@
+import { IOptionalLink } from "../../..";
+export interface ILocation {
+    getArea(): IOptionalLink;
+    canShowArea(): boolean;
+    getAreaId(): number;
+    getCity(): IOptionalLink;
+    getCityId(): number;
+    getCountry(): IOptionalLink;
+    getCountryId(): number;
+    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/{dotdigital-organisation/i-city.js → compare-programme/i-timing.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=i-city.js.map
+//# 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.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/programme-card/i-programme-card.d.ts

@@ -113,7 +113,6 @@ export interface IProgrammeCard {
     getTracking(): ITracking;
     /**
      * Get all tuition fees of the programme.
-     *
      * @return ITuitionFee[]
      */
     getTuitionFees(): ITuitionFee[];

package/src/models/bestfit-programme/i-english-requirements.js.map

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

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

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

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

@@ -1,14 +0,0 @@
-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.map

@@ -1 +0,0 @@
-{"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

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

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

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

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

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

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

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

package/src/models/dotdigital-programme/i-english-requirements.d.ts

@@ -1,37 +0,0 @@
-export interface IEnglishRequirements {
-    /**
-     * Required score for Duolingo
-     *
-     * @return number
-     */
-    getDuolingo(): number;
-    canShowDuolingo(): boolean;
-    /**
-     * Required score for IELTS tests
-     *
-     * @return number
-     */
-    getIELTS(): number;
-    canShowIELTS(): boolean;
-    /**
-     * Required score for PTE
-     *
-     * @return number
-     */
-    getPTE(): number;
-    canShowPTE(): boolean;
-    /**
-     * Required score for TOEFL internet
-     *
-     * @return number
-     */
-    getTOEFLInternet(): number;
-    canShowTOEFLInternet(): boolean;
-    /**
-     * Required score for TOEFL paper
-     *
-     * @return number
-     */
-    getTOEFLPaper(): number;
-    canShowTOEFLPaper(): boolean;
-}

package/src/models/dotdigital-programme/i-english-requirements.js

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

package/src/models/dotdigital-programme/i-english-requirements.js.map

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

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

@@ -1,14 +0,0 @@
-export interface ILogo {
-    /**
-     * Get the file ID of the logo.
-     *
-     * @return number
-     */
-    getId(): number;
-    /**
-     * Get the imgix URL of the logo.
-     *
-     * @return string
-     */
-    getSource(): string;
-}

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

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

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

@@ -1,50 +0,0 @@
-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

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

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

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