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

package/src/models/programme-card/i-deadline.js

@@ -1 +0,0 @@
-export {};

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

@@ -1,40 +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-duration.js

@@ -1 +0,0 @@
-export {};

package/src/models/programme-card/i-internal-link.d.ts

@@ -1,28 +0,0 @@
-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/programme-card/i-internal-link.js

@@ -1 +0,0 @@
-export {};

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

@@ -1,22 +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-link.js

@@ -1 +0,0 @@
-export {};

package/src/models/programme-card/i-location.d.ts

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

@@ -1 +0,0 @@
-export {};

package/src/models/programme-card/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/programme-card/i-logo.js

@@ -1 +0,0 @@
-export {};

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

@@ -1,23 +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-optional-link.js

@@ -1 +0,0 @@
-export {};

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

@@ -1,212 +0,0 @@
-import { ICover, IDuration, IEnglishRequirements, IGPARequirement, IInternalLink, ILink, ILivingCost, ILocation, ILogo, ITiming, ITrackedLink, ITracking, ITuitionFee } from "../../..";
-import { IReviewRating } from "../common/i-review-rating";
-export interface IProgrammeCard {
-    /**
-     * ISO code of the country the programme is taught.
-     * Formatted in UPPERCASE
-     *
-     * @return string | null
-     */
-    getCountryIsoCode(): string | null;
-    /**
-     * 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;
-    /**
-     * @return number[] | null
-     */
-    getDisciplineIds(): number[] | null;
-    /**
-     * Get duration of the programme.
-     *
-     * @return IDuration
-     */
-    getDuration(): IDuration;
-    canShowDuration(): boolean;
-    getEnglishRequirements(): IEnglishRequirements | null;
-    getGPA(): IGPARequirement | null;
-    /**
-     * Get the programme id.
-     *
-     * @return number
-     */
-    getId(): number;
-    /**
-     * Get the programme level.
-     *
-     * @return string
-     */
-    getLevel(): string;
-    getLivingCost(): ILivingCost | null;
-    /**
-     * Get the locaiton the programme is located in.
-     *
-     * Uses the country based on the programmes venues.
-     *
-     * @return ILocation
-     */
-    getLocation(): ILocation;
-    canShowLocation(): boolean;
-    /**
-     * Get the location text the programme is located in
-     *
-     * Uses the country based on the programmes venues and isFullyOnline state
-     *
-     * @return string | null
-     */
-    getLocationText(): string | null;
-    /**
-     * 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 global position percentage in Meta Ranking
-     *
-     * @return string | null
-     */
-    getUniversityGlobalPositionPercentage(): string | null;
-    /**
-     * 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;
-    getWorkExperienceYears(): number | null;
-    getEcts(): number | null;
-    /**
-     * If a program is both on campus and online
-     *
-     * @return boolean
-     */
-    isBlended(): boolean;
-    /**
-     * If a program is given in fulltime
-     *
-     * @return boolean
-     */
-    isFullTime(): boolean;
-    /**
-     * If a program can only be taught online or not
-     *
-     * @return boolean
-     */
-    isFullyOnline(): boolean;
-    /**
-     * If a program is taught on campus
-     *
-     * @return boolean
-     */
-    isOnCampus(): boolean;
-    /**
-     * If a program can be taught online
-     *
-     * @return boolean
-     */
-    isOnline(): boolean;
-    /**
-     * If a program is given in parttime
-     *
-     * @return boolean
-     */
-    isPartTime(): boolean;
-    /**
-     * Public status of the programme.
-     *
-     * @return boolean
-     */
-    isPublic(): boolean;
-    /**
-     * The last time the programme has been updated and verified
-     *
-     * @return Date
-     */
-    getLastUpdated(): Date;
-    /**
-     * Get the programme's campaign type
-     *
-     * @return number
-     */
-    getCampaignType(): number | null;
-    /**
-     * Get the review rating of the programme.
-     *
-     * @return IReviewRating | null
-     */
-    getReviewRating(): IReviewRating | null;
-}

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,33 +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-start-date.js

@@ -1 +0,0 @@
-export {};

package/src/models/programme-card/i-timing.d.ts

@@ -1,45 +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-timing.js

@@ -1 +0,0 @@
-export {};

package/src/models/programme-card/i-tracked-link.d.ts

@@ -1,29 +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-tracked-link.js

@@ -1 +0,0 @@
-export {};

package/src/models/programme-card/i-tracking.d.ts

@@ -1,46 +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/i-tracking.js

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};

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

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

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

@@ -1,12 +0,0 @@
-import { ModelClient } from "../../model-client";
-export class ProgrammeCardClient extends ModelClient {
-    getModelName() {
-        return 'programme-card';
-    }
-    getVersion() {
-        return 'v1';
-    }
-    isPublic() {
-        return false;
-    }
-}

package/src/models/ranking-cards/i-ranking.d.ts

@@ -1,18 +0,0 @@
-export interface IRanking {
-    /**
-     * @return number
-     */
-    getId(): number;
-    /**
-     * @return number | null
-     */
-    getRankingId(): number | null;
-    /**
-     * @return number
-     */
-    getPosition(): number;
-    /**
-     * @return string
-     */
-    getRankingYear(): string;
-}

package/src/models/ranking-cards/i-ranking.js

@@ -1 +0,0 @@
-export {};

package/src/models/scholarship-card/i-scholarship-card-v2.d.ts

@@ -1,20 +0,0 @@
-export interface IScholarshipCardV2 {
-    getDescriptionOfApplicationBasis(): string | null;
-    getDescriptionOfBenefits(): string | null;
-    getDescriptionOfDeadline(): string;
-    getDescriptionOfDestinationCountryRestrictions(): string;
-    getDescriptionOfProviderLocation(): string | null;
-    getIsNotSpecifiedDeadline(): boolean;
-    getProviderId(): string | null;
-    getProviderIsUniversity(): boolean;
-    getProviderLogoSquareCdn(): string | null;
-    getProviderName(): string;
-    getScholarshipId(): string;
-    getScholarshipTitle(): string;
-    getScholarshipVirtualName(): string;
-    getDisciplineIds(): number[] | null;
-    getOriginCountryIds(): string[] | null;
-    getGrantCurrencyIso(): string | null;
-    getGrantAmount(): number | null;
-    getGrantDescription(): string | null;
-}

package/src/models/scholarship-card/i-scholarship-card-v2.js

@@ -1 +0,0 @@
-export {};