@studyportals/domain-client 3.6.0-2 → 3.6.1-beta.1

package/src/models/programme-card/i-duration.ts

@@ -1,46 +0,0 @@
-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/programme-card/i-link.ts

@@ -1,25 +0,0 @@
-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/programme-card/i-location.ts

@@ -1,12 +0,0 @@
-import { IOptionalLink } from "../../..";
-
-export interface ILocation {
-
-	getArea(): IOptionalLink;
-
-	canShowArea(): boolean;
-
-	getCity(): IOptionalLink;
-
-	getCountry(): IOptionalLink;
-}

package/src/models/programme-card/i-optional-link.ts

@@ -1,27 +0,0 @@
-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/programme-card/i-programme-card.ts

@@ -1,152 +0,0 @@
-import { ICover, IDuration, IInternalLink, ILink, ILocation, ILogo, ITiming, ITrackedLink, ITracking, ITuitionFee } from "../../..";
-
-export interface IProgrammeCard {
-
-	/**
-	 * Get the Cover of the programme if available.
-	 *
-	 * @return ICover
-	 */
-	getCover(): ICover;
-
-	canShowCover(): boolean;
-
-	/**
-	 * Get the degree name of the programme.
-	 *
-	 * @return string
-	 */
-	getDegree(): string;
-
-	/**
-	 * Get duration of the programme.
-	 *
-	 * @return IDuration
-	 */
-	getDuration(): IDuration;
-
-	canShowDuration(): boolean;
-
-	/**
-	 * Get the programme id.
-	 *
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * Get the programme level.
-	 *
-	 * @return string
-	 */
-	getLevel(): string;
-
-	/**
-	 * Get the locaiton the programme is located in.
-	 *
-	 * Uses the country based on the programmes venues.
-	 *
-	 * @return ILocation
-	 */
-	getLocation(): ILocation;
-
-	canShowLocation(): boolean;
-
-	/**
-	 * Get the Logo of the programme if available.
-	 *
-	 * @return ILogo
-	 */
-	getLogo(): ILogo;
-
-	canShowLogo(): boolean;
-
-	/**
-	 * Returns premium type
-	 * Such as Super premium, premium, light, etc..
-	 *
-	 * @return string
-	 */
-	getPremiumType(): string;
-
-	/**
-	 * Get a link to the programme page.
-	 *
-	 * The link contains the page path as url and the programme name as the
-	 * link description.
-	 *
-	 * @return IInternalLink
-	 */
-	getProgrammeLink(): IInternalLink;
-
-	/**
-	 * Get programme's referral link
-	 *
-	 * @return ITrackedLink
-	 */
-	getReferralLink(): ITrackedLink;
-
-	canShowReferralLink(): boolean;
-
-	/**
-	 * Get the summary of the programme.
-	 *
-	 * @return string
-	 */
-	getSummary(): string;
-
-	/**
-	 * Get all start dates
-	 *
-	 * @return ITiming[]
-	 */
-	getTimings(): ITiming[];
-
-	canShowTimings(): boolean;
-
-	/**
-	 * Get the programme title.
-	 *
-	 * @return string
-	 */
-	getTitle(): string;
-
-	/**
-	 * Get the tracking information needed to track the impression on the card.
-	 *
-	 * @return ITracking
-	 */
-	getTracking(): ITracking;
-
-	/**
-	 * Get all tuition fees of the programme.
-	 * @return ITuitionFee[]
-	 */
-	getTuitionFees(): ITuitionFee[];
-
-	canShowTuitionFees(): boolean;
-
-	/**
-	 * Get the programme's university id
-	 *
-	 * @return number
-	 */
-	getUniversityId(): number;
-
-	/**
-	 * Get a link to the programme's university page.
-	 *
-	 * The link contains the page path as url and the university name as the
-	 * link description.
-	 *
-	 * @return ILink
-	 */
-	getUniversityLink(): ILink;
-
-	/**
-	 * Public status of the programme.
-	 *
-	 * @return boolean
-	 */
-	isPublic(): boolean;
-}

package/src/models/programme-card/i-start-date.ts

@@ -1,39 +0,0 @@
-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/programme-card/i-timing.ts

@@ -1,53 +0,0 @@
-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/programme-card/i-tracked-link.ts

@@ -1,34 +0,0 @@
-import { ITracking } from "../../..";
-
-export interface ITrackedLink {
-
-	/**
-	 * Get an optional text describing the link (typically <a>-tags contents).
-	 *
-	 * @return string
-	 * @throws PropertyNotAvailableException
-	 */
-	getDescription(): string;
-
-	canShowDescription(): boolean;
-
-	/**
-	 * Get an object containing all information needed to properly track a link.
-	 *
-	 * @return ITracking
-	 */
-	getTracking(): ITracking;
-
-	/**
-	 * 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/programme-card/i-tracking.ts

@@ -1,55 +0,0 @@
-import { IClickTrackingData } from "../../..";
-
-export interface ITracking {
-
-	/**
-	 * Get the value of the data-action attribute.
-	 *
-	 * @return string
-	 */
-	getAction(): string;
-
-	/**
-	 * Get all the data that is need to make click tracking possible
-	 *
-	 * @return IClickTrackingData
-	 */
-	getClickTrackingData(): IClickTrackingData;
-
-	canShowClickTrackingData(): boolean;
-
-	/**
-	 * Get the value of the data-description attribute.
-	 *
-	 * @return string
-	 */
-	getDescription(): string;
-
-	/**
-	 * Get the extra information value.
-	 *
-	 * @return string
-	 */
-	getExtra(): string;
-
-	/**
-	 * Get the value of the data-id attribute.
-	 *
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * Get the value of the data-label attribute.
-	 *
-	 * @return string
-	 */
-	getLabel(): string;
-
-	/**
-	 * Get the value of the data-type attribute.
-	 *
-	 * @return string
-	 */
-	getType(): string;
-}

package/src/models/programme-card/programme-card-client.ts

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

package/src/models/search-country-faq/i-search-country-faq.ts

@@ -1,22 +0,0 @@
-export interface ISearchCountryFaq {
-
-	/**
-	 * @return number
-	 */
-	getId(): number;
-
-	/**
-	 * @return string
-	 */
-	getName(): string;
-
-	/**
-	 * @return string
-	 */
-	getRankingCountryLink(): string;
-
-	/**
-	 * @return string[]
-	 */
-	getTopFiveUniversities(): string[];
-}

package/src/models/search-country-faq/public-search-country-faq-client.ts

@@ -1,16 +0,0 @@
-import { ISearchCountryFaq } from "../../..";
-import { ModelClient } from "../../model-client";
-
-export class PublicSearchCountryFaqClient extends ModelClient<ISearchCountryFaq> {
-	protected getModelName(): string {
-		return 'search-country-faq';
-	}
-
-	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,46 +0,0 @@
-export interface IOrganisationValues {
-
-	/**
-	 * Country ID of the top level organisation.
-	 *
-	 * @return number
-	 */
-	getCountryId(): number;
-
-	/**
-	 * 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;
-}