@studyportals/domain-client 3.30.0 → 3.32.0-1

package/index.d.ts

@@ -55,6 +55,8 @@ import { ISitemapOrganisationInfo } from "./src/models/sitemap-organisations-inf
 import { SitemapOrganisationsInfoClient } from "./src/models/sitemap-organisations-info/sitemap-organisations-info-client";
 import { IOrganisationCard } from "./src/models/organisation-card/i-organisation-card";
 import { OrganisationCardClient } from "./src/models/organisation-card/organisation-card-client";
+import { IOrganisationSearchDocument } from "./src/models/organisation-search-document/i-organisation-search-document";
+import { OrganisationSearchDocumentClient } from "./src/models/organisation-search-document/organisation-search-document-client";
 import { ISitemapRankingsInfo } from "./src/models/sitemap-rankings-info/i-sitemap-rankings-info";
 import { SitemapRankingsInfoClient } from "./src/models/sitemap-rankings-info/sitemap-rankings-info-client";
 import { ISitemapArticleInfo } from "./src/models/sitemap-articles-info/i-sitemap-article-info";
@@ -74,4 +76,8 @@ import { ICompareProgramme } from "./src/models/compare-programme/i-compare-prog
 import { CompareProgrammeClient } from "./src/models/compare-programme/compare-programme-client";
 import { IOrganisationForSearch } from "./src/models/organisation-for-search/i-organisation-for-search";
 import { PublicOrganisationForSearchClient } from "./src/models/organisation-for-search/public-organisation-for-search-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, IScholarshipCard, PublicScholarshipCardClient, IRankingCards, IRankingCard, IRanking, PublicRankingCardsClient, ICompareProgramme, CompareProgrammeClient, PortalType, PortalMap, ModelClient, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, OrganisationCardClient };
+import { ICopilotProgramme } from "./src/models/copilot-programme/i-copilot-programme";
+import { CopilotProgrammeClient } from "./src/models/copilot-programme/copilot-programme-client";
+import { ICopilotCountry } from "./src/models/copilot-country/i-copilot-country";
+import { CopilotCountryClient } from "./src/models/copilot-country/copilot-country-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, IOrganisationSearchDocument, OrganisationSearchDocumentClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, IScholarshipCard, PublicScholarshipCardClient, IRankingCards, IRankingCard, IRanking, PublicRankingCardsClient, ICompareProgramme, CompareProgrammeClient, PortalType, PortalMap, ModelClient, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, OrganisationCardClient, ICopilotProgramme, ICopilotCountry, CopilotProgrammeClient, CopilotCountryClient };

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrganisationCardClient = exports.PublicOrganisationForSearchClient = exports.ModelClient = exports.PortalType = exports.CompareProgrammeClient = exports.PublicRankingCardsClient = exports.PublicScholarshipCardClient = 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.CopilotCountryClient = exports.CopilotProgrammeClient = exports.OrganisationCardClient = exports.PublicOrganisationForSearchClient = exports.ModelClient = exports.PortalType = exports.CompareProgrammeClient = exports.PublicRankingCardsClient = exports.PublicScholarshipCardClient = exports.SitemapCitiesInfoClient = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = exports.OrganisationSearchDocumentClient = 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");
@@ -37,6 +37,8 @@ const sitemap_organisations_info_client_1 = require("./src/models/sitemap-organi
 Object.defineProperty(exports, "SitemapOrganisationsInfoClient", { enumerable: true, get: function () { return sitemap_organisations_info_client_1.SitemapOrganisationsInfoClient; } });
 const organisation_card_client_1 = require("./src/models/organisation-card/organisation-card-client");
 Object.defineProperty(exports, "OrganisationCardClient", { enumerable: true, get: function () { return organisation_card_client_1.OrganisationCardClient; } });
+const organisation_search_document_client_1 = require("./src/models/organisation-search-document/organisation-search-document-client");
+Object.defineProperty(exports, "OrganisationSearchDocumentClient", { enumerable: true, get: function () { return organisation_search_document_client_1.OrganisationSearchDocumentClient; } });
 const sitemap_rankings_info_client_1 = require("./src/models/sitemap-rankings-info/sitemap-rankings-info-client");
 Object.defineProperty(exports, "SitemapRankingsInfoClient", { enumerable: true, get: function () { return sitemap_rankings_info_client_1.SitemapRankingsInfoClient; } });
 const sitemap_articles_info_client_1 = require("./src/models/sitemap-articles-info/sitemap-articles-info-client");
@@ -55,4 +57,8 @@ const compare_programme_client_1 = require("./src/models/compare-programme/compa
 Object.defineProperty(exports, "CompareProgrammeClient", { enumerable: true, get: function () { return compare_programme_client_1.CompareProgrammeClient; } });
 const public_organisation_for_search_client_1 = require("./src/models/organisation-for-search/public-organisation-for-search-client");
 Object.defineProperty(exports, "PublicOrganisationForSearchClient", { enumerable: true, get: function () { return public_organisation_for_search_client_1.PublicOrganisationForSearchClient; } });
+const copilot_programme_client_1 = require("./src/models/copilot-programme/copilot-programme-client");
+Object.defineProperty(exports, "CopilotProgrammeClient", { enumerable: true, get: function () { return copilot_programme_client_1.CopilotProgrammeClient; } });
+const copilot_country_client_1 = require("./src/models/copilot-country/copilot-country-client");
+Object.defineProperty(exports, "CopilotCountryClient", { enumerable: true, get: function () { return copilot_country_client_1.CopilotCountryClient; } });
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AA8E3E,oGA9EQ,2CAAmB,OA8ER;AA7EpB,wEAAmE;AA8ElE,gGA9EQ,kCAAe,OA8ER;AA7EhB,0FAAoF;AA8EnF,wGA9EQ,mDAAuB,OA8ER;AA7ExB,8EAAwE;AA8EvE,kGA9EQ,uCAAiB,OA8ER;AA7ElB,wGAAiG;AA8EhG,8GA9EQ,gEAA6B,OA8ER;AAjE9B,6FAAwF;AA8EvF,oGA9EQ,2CAAmB,OA8ER;AAvEpB,sGAAiG;AA8EhG,uGA9EQ,iDAAsB,OA8ER;AA1EvB,sGAAiG;AA8EhG,uGA9EQ,iDAAsB,OA8ER;AAxEvB,+GAA0G;AA8EzG,0GA9EQ,uDAAyB,OA8ER;AA5E1B,qHAA+G;AA8E9G,2GA9EQ,0DAA0B,OA8ER;AA5E3B,uHAAgH;AA8E/G,6GA9EQ,+DAA4B,OA8ER;AA5E7B,qHAA+G;AA8E9G,2GA9EQ,0DAA0B,OA8ER;AA3E3B,oIAA6H;AA8E5H,+GA9EQ,mEAA8B,OA8ER;AA5E/B,oHAA8G;AA8E7G,6GA9EQ,8DAA4B,OA8ER;AA5E7B,2HAAqH;AA8EpH,6GA9EQ,8DAA4B,OA8ER;AAzE7B,wHAAmH;AA8ElH,6GA9EQ,6DAA4B,OA8ER;AA5E7B,iIAA2H;AA8E1H,+GA9EQ,kEAA8B,OA8ER;AA5E/B,sGAAiG;AAiGhG,uGAjGQ,iDAAsB,OAiGR;AA/FvB,kHAA4G;AA4E3G,0GA5EQ,wDAAyB,OA4ER;AA1E1B,kHAA4G;AA4E3G,0GA5EQ,wDAAyB,OA4ER;AA1E1B,4GAAsG;AA4ErG,wGA5EQ,oDAAuB,OA4ER;AA1ExB,iHAA2G;AA4E1G,4GA5EQ,4DAA2B,OA4ER;AAxE5B,wGAAkG;AA4EjG,yGA5EQ,sDAAwB,OA4ER;AA3EzB,yDAAqD;AA8EpD,2FA9EQ,wBAAU,OA8ER;AA5EX,qDAAiD;AA8EhD,4FA9EQ,0BAAW,OA8ER;AA5EZ,sGAAgG;AAyE/F,uGAzEQ,iDAAsB,OAyER;AAvEvB,sIAA8H;AA4E7H,kHA5EQ,yEAAiC,OA4ER"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AAoF3E,oGApFQ,2CAAmB,OAoFR;AAnFpB,wEAAmE;AAoFlE,gGApFQ,kCAAe,OAoFR;AAnFhB,0FAAoF;AAoFnF,wGApFQ,mDAAuB,OAoFR;AAnFxB,8EAAwE;AAoFvE,kGApFQ,uCAAiB,OAoFR;AAnFlB,wGAAiG;AAoFhG,8GApFQ,gEAA6B,OAoFR;AAvE9B,6FAAwF;AAoFvF,oGApFQ,2CAAmB,OAoFR;AA7EpB,sGAAiG;AAoFhG,uGApFQ,iDAAsB,OAoFR;AAhFvB,sGAAiG;AAoFhG,uGApFQ,iDAAsB,OAoFR;AA9EvB,+GAA0G;AAoFzG,0GApFQ,uDAAyB,OAoFR;AAlF1B,qHAA+G;AAoF9G,2GApFQ,0DAA0B,OAoFR;AAlF3B,uHAAgH;AAoF/G,6GApFQ,+DAA4B,OAoFR;AAlF7B,qHAA+G;AAoF9G,2GApFQ,0DAA0B,OAoFR;AAjF3B,oIAA6H;AAoF5H,+GApFQ,mEAA8B,OAoFR;AAlF/B,oHAA8G;AAoF7G,6GApFQ,8DAA4B,OAoFR;AAlF7B,2HAAqH;AAoFpH,6GApFQ,8DAA4B,OAoFR;AA/E7B,wHAAmH;AAoFlH,6GApFQ,6DAA4B,OAoFR;AAlF7B,iIAA2H;AAoF1H,+GApFQ,kEAA8B,OAoFR;AAlF/B,sGAAiG;AAyGhG,uGAzGQ,iDAAsB,OAyGR;AAvGvB,uIAAiI;AAkFhI,iHAlFQ,sEAAgC,OAkFR;AAhFjC,kHAA4G;AAkF3G,0GAlFQ,wDAAyB,OAkFR;AAhF1B,kHAA4G;AAkF3G,0GAlFQ,wDAAyB,OAkFR;AAhF1B,4GAAsG;AAkFrG,wGAlFQ,oDAAuB,OAkFR;AAhFxB,iHAA2G;AAkF1G,4GAlFQ,4DAA2B,OAkFR;AA9E5B,wGAAkG;AAkFjG,yGAlFQ,sDAAwB,OAkFR;AAjFzB,yDAAqD;AAoFpD,2FApFQ,wBAAU,OAoFR;AAlFX,qDAAiD;AAoFhD,4FApFQ,0BAAW,OAoFR;AAlFZ,sGAAgG;AA+E/F,uGA/EQ,iDAAsB,OA+ER;AA7EvB,sIAA8H;AAkF7H,kHAlFQ,yEAAiC,OAkFR;AAhFlC,sGAAgG;AAqF/F,uGArFQ,iDAAsB,OAqFR;AAnFvB,gGAA0F;AAoFzF,qGApFQ,6CAAoB,OAoFR"}

package/package.json

@@ -1,55 +1,55 @@
-{
-  "name": "@studyportals/domain-client",
-  "version": "3.30.0",
-  "description": "Responsible for fetching data from the Domain API",
-  "main": "index.js",
-  "author": "StudyPortals B.V.",
-  "contributors": [
-    "braaibander <danny@studyportals.com>"
-  ],
-  "license": "BSD-3-Clause",
-  "scripts": {
-    "test": "mocha --reporter spec \"tests/**/*.test.ts\"",
-    "coverage": "nyc mocha --reporter dot \"tests/**/*.test.ts\"",
-    "lint": "eslint . --ext .ts --max-warnings=0",
-    "lint:fix": "eslint . --ext .ts --fix",
-    "pre-push": "npm run test && npm run coverage && npm run lint",
-    "prepare-dist": "npm run test  && rm -fR bin && npx tsc && cp package.json bin/package.json && rm -fR bin/tests",
-    "publish-beta": "npm version prerelease --preid=beta && npm run prepare-dist && npm publish ./bin --tag beta",
-    "publish-major": "npm version major && npm run prepare-dist && npm publish ./bin",
-    "publish-minor": "npm version minor && npm run prepare-dist && npm publish ./bin",
-    "publish-patch": "npm version patch && npm run prepare-dist && npm publish ./bin",
-    "publish-current": "npm run prepare-dist && npm publish ./bin"
-  },
-  "husky": {
-    "hooks": {
-      "pre-push": "npm run pre-push"
-    }
-  },
-  "dependencies": {
-    "axios": "^1.6.0"
-  },
-  "devDependencies": {
-    "@studyportals/code-style": "^2.0.3",
-    "@testdeck/mocha": "^0.3.3",
-    "@types/axios": "^0.14.0",
-    "@types/mocha": "^10.0.0",
-    "@types/moxios": "^0.4.9",
-    "@types/node": "^14.14.8",
-    "@types/reflect-metadata": "^0.1.0",
-    "@typescript-eslint/eslint-plugin": "^4.8.1",
-    "@typescript-eslint/parser": "^4.8.1",
-    "eslint": "^7.13.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-mocha": "^10.1.0",
-    "husky": "^4.3.0",
-    "mocha": "^10.1.0",
-    "moxios": "^0.4.0",
-    "nyc": "^15.1.0",
-    "source-map-support": "^0.5.19",
-    "ts-node": "^10.9.1",
-    "tslint": "^6.1.3",
-    "typemoq": "^2.1.0",
-    "typescript": "^4.9.3"
-  }
-}
+{
+  "name": "@studyportals/domain-client",
+  "version": "3.32.0-1",
+  "description": "Responsible for fetching data from the Domain API",
+  "main": "index.js",
+  "author": "StudyPortals B.V.",
+  "contributors": [
+    "braaibander <danny@studyportals.com>"
+  ],
+  "license": "BSD-3-Clause",
+  "scripts": {
+    "test": "mocha --reporter spec \"tests/**/*.test.ts\"",
+    "coverage": "nyc mocha --reporter dot \"tests/**/*.test.ts\"",
+    "lint": "eslint . --ext .ts --max-warnings=0",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "pre-push": "npm run test && npm run coverage && npm run lint",
+    "prepare-dist": "npm run test  && rm -fR bin && npx tsc && cp package.json bin/package.json && rm -fR bin/tests",
+    "publish-beta": "npm version prerelease --preid=beta && npm run prepare-dist && npm publish ./bin --tag beta",
+    "publish-major": "npm version major && npm run prepare-dist && npm publish ./bin",
+    "publish-minor": "npm version minor && npm run prepare-dist && npm publish ./bin",
+    "publish-patch": "npm version patch && npm run prepare-dist && npm publish ./bin",
+    "publish-current": "npm run prepare-dist && npm publish ./bin"
+  },
+  "husky": {
+    "hooks": {
+      "pre-push": "npm run pre-push"
+    }
+  },
+  "dependencies": {
+    "axios": "^1.6.0"
+  },
+  "devDependencies": {
+    "@studyportals/code-style": "^2.0.3",
+    "@testdeck/mocha": "^0.3.3",
+    "@types/axios": "^0.14.0",
+    "@types/mocha": "^10.0.0",
+    "@types/moxios": "^0.4.9",
+    "@types/node": "^14.14.8",
+    "@types/reflect-metadata": "^0.1.0",
+    "@typescript-eslint/eslint-plugin": "^4.8.1",
+    "@typescript-eslint/parser": "^4.8.1",
+    "eslint": "^7.13.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-mocha": "^10.1.0",
+    "husky": "^4.3.0",
+    "mocha": "^10.1.0",
+    "moxios": "^0.4.0",
+    "nyc": "^15.1.0",
+    "source-map-support": "^0.5.19",
+    "ts-node": "^10.9.1",
+    "tslint": "^6.1.3",
+    "typemoq": "^2.1.0",
+    "typescript": "^4.9.3"
+  }
+}

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

@@ -0,0 +1,44 @@
+export interface IEnglishRequirements {
+    /**
+     * Required score for Cambridge english
+     *
+     * @return number
+     */
+    getCambridgeEnglish(): number;
+    canShowCambridgeEnglish(): boolean;
+    /**
+     * 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/bestfit-programme/i-english-requirements.js

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

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

@@ -0,0 +1 @@
+{"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-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/bestfit-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/bestfit-programme/i-g-p-a-requirement.js.map

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

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

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# 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/compare-programme/i-duration.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# 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/compare-programme/i-english-requirements.d.ts

@@ -0,0 +1,44 @@
+export interface IEnglishRequirements {
+    /**
+     * Required score for Cambridge english
+     *
+     * @return number
+     */
+    getCambridgeEnglish(): number;
+    canShowCambridgeEnglish(): boolean;
+    /**
+     * 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/compare-programme/i-english-requirements.js

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

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-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