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

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-review-rating-domain.d.ts

@@ -1,6 +0,0 @@
-export interface IReviewRatingDomain {
-    getAverage(): number;
-    getAverageStarRating(): number;
-    getQuantity(): number;
-    hasEnoughQuantity(): boolean;
-}

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

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

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.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.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 {};

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

@@ -1,15 +0,0 @@
-export interface IScholarshipCard {
-    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;
-}

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

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

package/src/models/scholarship-card/public-scholarship-card-client.js

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

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

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

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

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

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

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

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

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

package/src/models/scholarship-search-document/i-scholarship-search-document.js

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

package/src/models/scholarship-search-document/scholarship-search-document-client.js

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

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

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

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

@@ -1,12 +0,0 @@
-import { ModelClient } from "../../model-client";
-export class PublicSearchDisciplineClient extends ModelClient {
-    getModelName() {
-        return 'search-discipline';
-    }
-    getVersion() {
-        return 'v1';
-    }
-    isPublic() {
-        return true;
-    }
-}

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

@@ -1,38 +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-configuration.js

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

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

@@ -1,30 +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-geo-targeting-values.js

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

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

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

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

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

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

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

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

@@ -1,50 +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/i-tuition-values.js

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

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

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

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

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