@studyportals/domain-client 6.1.0-beta.0 → 6.1.0-beta.1

package/src/models/search-discipline/i-search-discipline.ts

@@ -1,32 +0,0 @@
-export interface ISearchDiscipline {
-
-	/**
-	 * @return string | null
-	 */
-	getIcon(): string | null;
-
-	/**
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * @return string
-	 */
-	getName(): string;
-
-	/**
-	 * @return string | null
-	 */
-	getOldVirtualPath(): string | null;
-
-	/**
-	 * @return number | null
-	 */
-	getParentId(): number | null;
-
-	/**
-	 * @return string
-	 */
-	getVirtualPath(): string;
-}

package/src/models/search-discipline/public-search-discipline-client.ts

@@ -1,16 +0,0 @@
-import { ISearchDiscipline } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class PublicSearchDisciplineClient extends ModelClient<ISearchDiscipline> {
-	protected getModelName(): string {
-		return 'search-discipline';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return true;
-	}
-}

package/src/models/search-projection/i-geo-targeting-configuration.ts

@@ -1,44 +0,0 @@
-export interface IGeoTargetingConfiguration {
-
-	/**
-	 * Bit set 1 of targeted country ID information.
-	 *
-	 * @return number
-	 */
-	getBit1(): number;
-
-	/**
-	 * Bit set 2 of targeted country ID information.
-	 *
-	 * @return number
-	 */
-	getBit2(): number;
-
-	/**
-	 * Bit set 3 of targeted country ID information.
-	 *
-	 * @return number
-	 */
-	getBit3(): number;
-
-	/**
-	 * Bit set 4 of targeted country ID information.
-	 *
-	 * @return number
-	 */
-	getBit4(): number;
-
-	/**
-	 * Bit set 5 of targeted country ID information.
-	 *
-	 * @return number
-	 */
-	getBit5(): number;
-
-	/**
-	 * List of all configured country IDs.
-	 *
-	 * @return number[]
-	 */
-	getTargetedCountries(): number[];
-}

package/src/models/search-projection/i-geo-targeting-values.ts

@@ -1,38 +0,0 @@
-import { IGeoTargetingConfiguration } from "../../..";
-
-export interface IGeoTargetingValues {
-
-	/**
-	 * Geo-targeting configuration for "light premium" listing.
-	 *
-	 * @return IGeoTargetingConfiguration
-	 */
-	getLightPremium(): IGeoTargetingConfiguration;
-
-	canShowLightPremium(): boolean;
-
-	/**
-	 * Geo-targeting configuration for "premium" listing.
-	 *
-	 * @return IGeoTargetingConfiguration
-	 */
-	getPremium(): IGeoTargetingConfiguration;
-
-	canShowPremium(): boolean;
-
-	/**
-	 * Geo-targeting configuration for "super premium" listing.
-	 *
-	 * @return IGeoTargetingConfiguration
-	 */
-	getSuperPremium(): IGeoTargetingConfiguration;
-
-	canShowSuperPremium(): boolean;
-
-	/**
-	 * Programme has active geo-targeting settings.
-	 *
-	 * @return boolean
-	 */
-	isGeoTargeted(): boolean;
-}

package/src/models/search-projection/i-organisation-values.ts

@@ -1,53 +0,0 @@
-export interface IOrganisationValues {
-
-	/**
-	 * Country ID of the top level organisation.
-	 *
-	 * @return number
-	 */
-	getCountryId(): number;
-
-	/**
-	 * Country iso code of the top level organisation.
-	 *
-	 * @return string
-	 */
-	getCountryIsoCode(): string;
-
-	/**
-	 * ID of the programme's main organisation.
-	 *
-	 * First premium organisation or top level organisation.
-	 *
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * Name of the programme's main organisation.
-	 *
-	 * First premium organisation or top level organisation.
-	 *
-	 * @return string
-	 */
-	getName(): string;
-
-	/**
-	 * List of all organisation IDs attached to the programme (main + sub).
-	 *
-	 * @return number[]
-	 */
-	getOrganisations(): number[];
-
-	/**
-	 * Region ID of the top level organisation.
-	 *
-	 * Currently only possible region ID is 38 (EEA region). All other regions
-	 * are ignored for this field.
-	 *
-	 * @return number
-	 */
-	getRegionId(): number;
-
-	canShowRegionId(): boolean;
-}

package/src/models/search-projection/i-premium-values.ts

@@ -1,43 +0,0 @@
-export interface IPremiumValues {
-
-	/**
-	 * Bottom of the premium probability range (between 0.0 asn 1.0).
-	 *
-	 * @return number
-	 */
-	getPremiumBottom(): number;
-
-	canShowPremiumBottom(): boolean;
-
-	/**
-	 * CPM value attached to the premium listing.
-	 *
-	 * @return number
-	 */
-	getPremiumCpm(): number;
-
-	canShowPremiumCpm(): boolean;
-
-	/**
-	 * Top of the premium probability range (between 0.0 asn 1.0).
-	 *
-	 * @return number
-	 */
-	getPremiumTop(): number;
-
-	canShowPremiumTop(): boolean;
-
-	/**
-	 * Short hand premium type (sp, p, lp, slp, sslp, b).
-	 *
-	 * @return string
-	 */
-	getPremiumType(): string;
-
-	/**
-	 * Premium weight value used in Cloudsearch commercial sorting.
-	 *
-	 * @return number
-	 */
-	getPremiumValue(): number;
-}

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

@@ -1,223 +0,0 @@
-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-tuition-values.ts

@@ -1,63 +0,0 @@
-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/search-projection-client.ts

@@ -1,16 +0,0 @@
-import { ISearchProjection } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class SearchProjectionClient extends ModelClient<ISearchProjection> {
-	protected getModelName(): string {
-		return 'search-projection';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

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

@@ -1,33 +0,0 @@
-
-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/sitemap-articles-info-client.ts

@@ -1,16 +0,0 @@
-import { ISitemapArticleInfo } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class SitemapArticlesInfoClient extends ModelClient<ISitemapArticleInfo> {
-	protected getModelName(): string {
-		return 'sitemap-articles-info';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

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

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

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

@@ -1,16 +0,0 @@
-import { ISitemapCityInfo } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class SitemapCitiesInfoClient extends ModelClient<ISitemapCityInfo> {
-	protected getModelName(): string {
-		return 'sitemap-cities-info';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

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

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

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

@@ -1,16 +0,0 @@
-import { ISitemapCountryInfo } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class SitemapCountriesInfoClient extends ModelClient<ISitemapCountryInfo> {
-	protected getModelName(): string {
-		return 'sitemap-countries-info';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}

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

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

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

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

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

@@ -1,16 +0,0 @@
-import { ISitemapCountryDegreeInfo } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class SitemapCountryDegreeInfoClient extends ModelClient<ISitemapCountryDegreeInfo> {
-	protected getModelName(): string {
-		return 'sitemap-country-degree-info';
-	}
-
-	protected getVersion(): string {
-		return 'v1';
-	}
-
-	public isPublic(): boolean {
-		return false;
-	}
-}