@studyportals/domain-client 7.0.1-beta.5 → 7.1.0

package/src/models/search-projection/i-search-projection.d.ts

@@ -0,0 +1,186 @@
+import { IGeoTargetingValues, IOrganisationValues, IPremiumValues, ITuitionValues } from "../../..";
+export interface ISearchProjection {
+    /**
+     * List of area IDs where the programme is taught at (through venues).
+     *
+     * @return number[]
+     */
+    getAreas(): number[];
+    /**
+     * Current boost value for the programme (campaign automation).
+     *
+     * @return number
+     */
+    getBoost(): number;
+    /**
+     * Contents text of the programme (stripped of html tags).
+     *
+     * @return string
+     */
+    getContents(): string;
+    /**
+     * List of country IDs where the programme is taught at (through venues).
+     *
+     * @return number[]
+     */
+    getCountries(): number[];
+    /**
+     * List of country iso codes where the programme is taught at (through venues).
+     *
+     * @return string[]
+     */
+    getCountryIsoCodes(): string[];
+    /**
+     * Unformatted degree of the programme.
+     *
+     * @return string
+     */
+    getDegree(): string;
+    /**
+     * Formatted degree of the programme.
+     *
+     * @return string
+     */
+    getDegreeFormatted(): string;
+    /**
+     * List of intensity densities of the programme.
+     *
+     * @return string[]
+     */
+    getDensity(): string[];
+    /**
+     * Description text of the programme (stripped of html tags).
+     *
+     * @return string
+     */
+    getDescription(): string;
+    /**
+     * List of disciplines connected to the programme (includes parent IDs).
+     *
+     * @return number[]
+     */
+    getDisciplines(): number[];
+    /**
+     * List of educational forms.
+     *
+     * @return string[]
+     */
+    getEducationalForms(): string[];
+    /**
+     * Full time duration in days.
+     *
+     * @return number
+     */
+    getFullTimeDuration(): number;
+    canShowFullTimeDuration(): boolean;
+    getGeoTargetingValues(): IGeoTargetingValues;
+    /**
+     * Id of the programme.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * List of language IDs the programme is taught in.
+     *
+     * @return number[]
+     */
+    getLanguages(): number[];
+    /**
+     * Study level of the programme.
+     *
+     * @return string
+     */
+    getLevel(): string;
+    /**
+     * Url of the logo to display (square if available, legacy otherwise).
+     *
+     * @return string
+     */
+    getLogo(): string;
+    canShowLogo(): boolean;
+    /**
+     * Url of the legacy logo to display.
+     *
+     * @return string
+     */
+    getLogoOld(): string;
+    canShowLogoOld(): boolean;
+    /**
+     * List of study methods.
+     *
+     * @return string[]
+     */
+    getMethods(): string[];
+    getOrganisationValues(): IOrganisationValues;
+    /**
+     * Part time duration in days.
+     *
+     * @return number
+     */
+    getPartTimeDuration(): number;
+    canShowPartTimeDuration(): boolean;
+    getPremiumValues(): IPremiumValues;
+    /**
+     * The programme's probability seed value (previously known as 'entropy').
+     *
+     * Should be a value between 0 and 4095.
+     *
+     * @return number
+     */
+    getProbabilitySeed(): number;
+    /**
+     * List of region IDs where the programme is taught at (through venues).
+     *
+     * Includes both the direct regions as the parent regions.
+     *
+     * @return number[]
+     */
+    getRegions(): number[];
+    /**
+     * List of special programme types (executive, joint, erasmus).
+     *
+     * @return string[]
+     */
+    getSpecialStudy(): string[];
+    /**
+     * List of the start months for the programme.
+     *
+     * @return number[]
+     */
+    getStartDates(): number[];
+    /**
+     * Summary text of the programme (stripped of html tags).
+     *
+     * @return string
+     */
+    getSummary(): string;
+    /**
+     * Title of the programme.
+     *
+     * @return string
+     */
+    getTitle(): string;
+    getTuitionValues(): ITuitionValues;
+    canShowTuitionValues(): boolean;
+    /**
+     * List of json encoded venue descriptions.
+     *
+     * Example of structure:
+     * {
+     *'city': 'Eindhoven',
+     *'country': 'Netherlands',
+     *'area': 'North Brabant',
+     *'display_area': true
+     * }
+     *
+     * @return string[]
+     */
+    getVenues(): string[];
+    /**
+     * Public status of the programme.
+     *
+     * @return boolean
+     */
+    isPublic(): boolean;
+}

package/src/models/search-projection/i-search-projection.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/search-projection/i-tuition-values.d.ts

@@ -0,0 +1,50 @@
+export interface ITuitionValues {
+    /**
+     * Tuition (converted to per year if possible) for EEA students.
+     *
+     * @return number
+     */
+    getTuitionEea(): number;
+    canShowTuitionEea(): boolean;
+    /**
+     * Tuition currency.
+     *
+     * @return number
+     */
+    getTuitionEeaCurrency(): number;
+    canShowTuitionEeaCurrency(): boolean;
+    /**
+     * Tuition (converted to per year if possible) for international students.
+     *
+     * @return number
+     */
+    getTuitionInternational(): number;
+    canShowTuitionInternational(): boolean;
+    /**
+     * Tuition currency.
+     *
+     * @return number
+     */
+    getTuitionInternationalCurrency(): number;
+    canShowTuitionInternationalCurrency(): boolean;
+    /**
+     * Tuition (converted to per year if possible) for national students.
+     *
+     * @return number
+     */
+    getTuitionNational(): number;
+    canShowTuitionNational(): boolean;
+    /**
+     * Tuition currency.
+     *
+     * @return number
+     */
+    getTuitionNationalCurrency(): number;
+    canShowTuitionNationalCurrency(): boolean;
+    /**
+     * Unit all tuition fees are provided in.
+     *
+     * @return number
+     */
+    getTuitionUnitType(): number;
+}

package/src/models/search-projection/i-tuition-values.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/search-projection/search-projection-client.d.ts

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

package/src/models/search-projection/search-projection-client.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchProjectionClient = void 0;
+const model_client_1 = require("../../model-client");
+class SearchProjectionClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'search-projection';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.SearchProjectionClient = SearchProjectionClient;

package/src/models/sitemap-articles-info/i-sitemap-article-info.d.ts

@@ -0,0 +1,26 @@
+export interface ISitemapArticleInfo {
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getPath(): string;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemapForMasters(): boolean;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemapForBachelors(): boolean;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemapForPhd(): boolean;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemapForShortCourses(): boolean;
+}

package/src/models/sitemap-articles-info/i-sitemap-article-info.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/sitemap-articles-info/sitemap-articles-info-client.d.ts

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

package/src/models/sitemap-articles-info/sitemap-articles-info-client.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitemapArticlesInfoClient = void 0;
+const model_client_1 = require("../../model-client");
+class SitemapArticlesInfoClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'sitemap-articles-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.SitemapArticlesInfoClient = SitemapArticlesInfoClient;

package/src/models/sitemap-cities-info/i-sitemap-city-info.d.ts

@@ -0,0 +1,14 @@
+export interface ISitemapCityInfo {
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getPath(): string;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemap(): boolean;
+}

package/src/models/sitemap-cities-info/i-sitemap-city-info.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/sitemap-cities-info/sitemap-cities-info-client.d.ts

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

package/src/models/sitemap-cities-info/sitemap-cities-info-client.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitemapCitiesInfoClient = void 0;
+const model_client_1 = require("../../model-client");
+class SitemapCitiesInfoClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'sitemap-cities-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.SitemapCitiesInfoClient = SitemapCitiesInfoClient;

package/src/models/sitemap-countries-info/i-sitemap-country-info.d.ts

@@ -0,0 +1,14 @@
+export interface ISitemapCountryInfo {
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getPath(): string;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemap(): boolean;
+}

package/src/models/sitemap-countries-info/i-sitemap-country-info.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/sitemap-countries-info/sitemap-countries-info-client.d.ts

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

package/src/models/sitemap-countries-info/sitemap-countries-info-client.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitemapCountriesInfoClient = void 0;
+const model_client_1 = require("../../model-client");
+class SitemapCountriesInfoClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'sitemap-countries-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.SitemapCountriesInfoClient = SitemapCountriesInfoClient;

package/src/models/sitemap-country-degree-info/i-degree-info.d.ts

@@ -0,0 +1,14 @@
+export interface IDegreeInfo {
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getLevel(): string;
+    /**
+     * @return string
+     */
+    getPath(): string;
+}

package/src/models/sitemap-country-degree-info/i-degree-info.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/sitemap-country-degree-info/i-sitemap-country-degree-info.d.ts

@@ -0,0 +1,11 @@
+import { IDegreeInfo } from "../../..";
+export interface ISitemapCountryDegreeInfo {
+    /**
+     * @return IDegreeInfo[]
+     */
+    getDegrees(): IDegreeInfo[];
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemap(): boolean;
+}

package/src/models/sitemap-country-degree-info/i-sitemap-country-degree-info.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/sitemap-country-degree-info/sitemap-country-degree-info-client.d.ts

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

package/src/models/sitemap-country-degree-info/sitemap-country-degree-info-client.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitemapCountryDegreeInfoClient = void 0;
+const model_client_1 = require("../../model-client");
+class SitemapCountryDegreeInfoClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'sitemap-country-degree-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.SitemapCountryDegreeInfoClient = SitemapCountryDegreeInfoClient;

package/src/models/sitemap-disciplines-info/i-sitemap-discipline-info.d.ts

@@ -0,0 +1,14 @@
+export interface ISitemapDisciplineInfo {
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getPath(): string;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemap(): boolean;
+}

package/src/models/sitemap-disciplines-info/i-sitemap-discipline-info.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/sitemap-disciplines-info/sitemap-disciplines-info-client.d.ts

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

package/src/models/sitemap-disciplines-info/sitemap-disciplines-info-client.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitemapDisciplinesInfoClient = void 0;
+const model_client_1 = require("../../model-client");
+class SitemapDisciplinesInfoClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'sitemap-disciplines-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.SitemapDisciplinesInfoClient = SitemapDisciplinesInfoClient;

package/src/models/sitemap-organisations-info/i-sitemap-organisation-info.d.ts

@@ -0,0 +1,26 @@
+export interface ISitemapOrganisationInfo {
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getPath(): string;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemapForBachelors(): boolean;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemapForMasters(): boolean;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemapForPhd(): boolean;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemapForShortCourses(): boolean;
+}

package/src/models/sitemap-organisations-info/i-sitemap-organisation-info.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/sitemap-organisations-info/sitemap-organisations-info-client.d.ts

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

package/src/models/sitemap-organisations-info/sitemap-organisations-info-client.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitemapOrganisationsInfoClient = void 0;
+const model_client_1 = require("../../model-client");
+class SitemapOrganisationsInfoClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'sitemap-organisations-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.SitemapOrganisationsInfoClient = SitemapOrganisationsInfoClient;

package/src/models/sitemap-programme-info/i-sitemap-programme-info.d.ts

@@ -0,0 +1,26 @@
+export interface ISitemapProgrammeInfo {
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getPath(): string;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemapForBachelors(): boolean;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemapForMasters(): boolean;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemapForPhd(): boolean;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemapForShortCourses(): boolean;
+}

package/src/models/sitemap-programme-info/i-sitemap-programme-info.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/sitemap-programme-info/sitemap-programme-info-client.d.ts

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

package/src/models/sitemap-programme-info/sitemap-programme-info-client.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitemapProgrammeInfoClient = void 0;
+const model_client_1 = require("../../model-client");
+class SitemapProgrammeInfoClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'sitemap-programme-info';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.SitemapProgrammeInfoClient = SitemapProgrammeInfoClient;

package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.d.ts

@@ -0,0 +1,14 @@
+export interface ISitemapRankingsInfo {
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getPath(): string;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemap(): boolean;
+}

package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/sitemap-rankings-info/sitemap-rankings-info-client.d.ts

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