@studyportals/domain-client 7.0.1-beta.4 → 7.0.1-beta.9

package/src/models/customerio-organisation/customerio-organisation-client.d.ts

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

package/src/models/customerio-organisation/customerio-organisation-client.js

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

package/src/models/customerio-organisation/i-customer-io-organisation.d.ts

@@ -1,35 +0,0 @@
-import { ICity, ICountry, IReview } from "../../..";
-export interface ICustomerIOOrganisation {
-    getAboutCareer(): string | null;
-    getAboutEducation(): string | null;
-    getAboutHistory(): string | null;
-    getAboutResearch(): string | null;
-    getAcademicStaff(): number | null;
-    getAmountOfProgrammes(): number;
-    getAverageStudentRating(): number | null;
-    getCity(): ICity;
-    getCountry(): ICountry;
-    getCoverUrl(): string | null;
-    getFemaleStudents(): number | null;
-    getId(): number;
-    getLogoUrl(): string | null;
-    getName(): string | null;
-    getOrganisationUrl(): string;
-    /**
-     * @return string[] | null
-     */
-    getReasons(): string[] | null;
-    /**
-     * @return IReview[]
-     */
-    getReviews(): IReview[];
-    getServicesHousing(): string | null;
-    getServicesICT(): string | null;
-    getServicesLibrary(): string | null;
-    getServicesMedical(): string | null;
-    getServicesStudent(): string | null;
-    getStudentLifeCampus(): string | null;
-    getStudentLifeSport(): string | null;
-    getStudents(): number | null;
-    getStudentsInternational(): number | null;
-}

package/src/models/customerio-organisation/i-customer-io-organisation.js

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

package/src/models/customerio-organisation/i-review.d.ts

@@ -1,7 +0,0 @@
-export interface IReview {
-    getEndDate(): Date | null;
-    getRating(): number;
-    getReview(): string | null;
-    getStartDate(): Date | null;
-    getTitle(): string | null;
-}

package/src/models/customerio-organisation/i-review.js

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

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

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

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

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

package/src/models/customerio-programme/i-customer-io-programme.d.ts

@@ -1,107 +0,0 @@
-import { ICountry, IEnglishRequirements, IInternalLink, ILogo, ITiming, ITuitionFee } from "../../..";
-export interface ICustomerIOProgramme {
-    /**
-     * Campaign type of the campaign the programme is attached to
-     *
-     * @return number
-     */
-    getCampaignType(): number;
-    canShowCampaignType(): boolean;
-    /**
-     * Get country the programme is teached in
-     *
-     * @return ICountry
-     */
-    getCountry(): ICountry;
-    canShowCountry(): boolean;
-    /**
-     * Get discipline ids attached to this programme
-     *
-     * @return number[]
-     */
-    getDisciplineIds(): number[];
-    /**
-     * Education level
-     *
-     * @return string
-     */
-    getEducationalLevel(): string;
-    /**
-     * English level requirements.
-     *
-     * @return IEnglishRequirements
-     */
-    getEnglishRequirements(): IEnglishRequirements;
-    /**
-     * Id of the programme.
-     *
-     * @return number
-     */
-    getId(): number;
-    /**
-     * The last time the programme has been updated and verified
-     *
-     * @return Date
-     */
-    getLastUpdated(): Date;
-    /**
-     * University logo url
-     *
-     * @return ILogo
-     */
-    getLogo(): ILogo;
-    canShowLogo(): boolean;
-    /**
-     * 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;
-    /**
-     * The universities review rating
-     *
-     * @return number
-     */
-    getReviewRating(): number;
-    canShowReviewRating(): boolean;
-    /**
-     * Get all start dates
-     *
-     * @return ITiming[]
-     */
-    getTimings(): ITiming[];
-    /**
-     * Title of the programme.
-     *
-     * @return string
-     */
-    getTitle(): string;
-    /**
-     * The programmes tuition fees
-     *
-     * @return ITuitionFee[]
-     */
-    getTuitionFees(): ITuitionFee[];
-    canShowTuitionFees(): boolean;
-    /**
-     * University id
-     *
-     * @return number
-     */
-    getUniversityId(): number;
-    /**
-     * University title
-     *
-     * @return string
-     */
-    getUniversityTitle(): string;
-    /**
-     * Is programme public
-     *
-     * @return boolean
-     */
-    isPublic(): boolean;
-}

package/src/models/customerio-programme/i-customer-io-programme.js

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

package/src/models/customerio-programme/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/customerio-programme/i-internal-link.js

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

package/src/models/faq-static-content/i-faq-static-content.d.ts

@@ -1,10 +0,0 @@
-import { IFaq } from "./i-faq";
-import { IStaticContent } from "./i-static-content";
-export interface IFaqStaticContent {
-    getFaqId(): number | null;
-    getStaticContentId(): number | null;
-    getRankingFaqs(): IFaq[] | null;
-    getSearchFaqs(): IFaq[] | null;
-    getRankingStaticContent(): IStaticContent[] | null;
-    getSearchStaticContent(): IStaticContent[] | null;
-}

package/src/models/faq-static-content/i-faq-static-content.js

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

package/src/models/faq-static-content/i-faq.d.ts

@@ -1,4 +0,0 @@
-export interface IFaq {
-    getQuestion(): string;
-    getAnswer(): string;
-}

package/src/models/faq-static-content/i-faq.js

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

package/src/models/faq-static-content/i-static-content-url.d.ts

@@ -1,4 +0,0 @@
-export interface IStaticContentUrl {
-    getUrl(): string;
-    getText(): string;
-}

package/src/models/faq-static-content/i-static-content-url.js

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

package/src/models/faq-static-content/i-static-content.d.ts

@@ -1,5 +0,0 @@
-import { IStaticContentUrl } from "./i-static-content-url";
-export interface IStaticContent {
-    getUrls(): IStaticContentUrl[];
-    getText(): string;
-}

package/src/models/faq-static-content/i-static-content.js

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

package/src/models/faq-static-content/public-faq-static-content-client.d.ts

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

package/src/models/faq-static-content/public-faq-static-content-client.js

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

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

@@ -1,39 +0,0 @@
-import { IReviewRating } from "../common/i-review-rating";
-import { IRankingDiscipline } from "./i-ranking-discipline";
-export interface IOrganisationCard {
-    getNumberOfProgrammesForBachelors(): number;
-    getNumberOfProgrammesForDistanceLearning(): number;
-    getNumberOfProgrammesForMasters(): number;
-    getNumberOfProgrammesForPhd(): number;
-    getNumberOfProgrammesForShortCourses(): number;
-    getOrganisationGlobalMetaRankingPosition(): number | null;
-    getOrganisationMetaRankingPositionsByDiscipline(): IRankingDiscipline[] | null;
-    getOrganisationGlobalPositionPercentage(): string | null;
-    getOrganisationHasDeliveryMethodBlended(): boolean;
-    getOrganisationHasDeliveryMethodOnCampus(): boolean;
-    getOrganisationHasDeliveryMethodOnline(): boolean;
-    getOrganisationId(): number;
-    getOrganisationIsPremium(): boolean;
-    getOrganisationLocationCityName(): string | null;
-    getOrganisationLocationCityRelativeLinkOfDetailPage(): string | null;
-    getOrganisationLocationCountryIsoCode(): string | null;
-    getOrganisationLocationCountryName(): string | null;
-    getOrganisationLocationCountryRelativeLinkOfDetailPage(): string | null;
-    getOrganisationLocationAreaCode(): string | null;
-    getOrganisationLogoSquareCdn(): string | null;
-    getOrganisationMayShowCoverImage(): boolean;
-    getOrganisationMayShowLogoSquare(): boolean;
-    getOrganisationName(): string;
-    getOrganisationRelativeLinkOfDetailPage(): string;
-    getOrganisationSummary(): string | null;
-    getOrganisationVenuesCount(): number;
-    getScholarshipsCountForBachelors(): number;
-    getScholarshipsCountForMasters(): number;
-    getScholarshipsCountForPhd(): number;
-    isForProfitFunding(): boolean;
-    isNonProfitFunding(): boolean;
-    isPublicFunding(): boolean;
-    getCampaignType(): number;
-    getReviewRating(): IReviewRating | null;
-    getIsoCodesOfCountriesOfVenues(): string[] | null;
-}

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

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

package/src/models/organisation-card/i-ranking-discipline.d.ts

@@ -1,4 +0,0 @@
-export interface IRankingDiscipline {
-    getDisciplineId(): number;
-    getPosition(): number | null;
-}

package/src/models/organisation-card/i-ranking-discipline.js

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

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

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

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

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

package/src/models/organisation-for-search/i-organisation-for-search.d.ts

@@ -1,32 +0,0 @@
-export interface IOrganisationForSearch {
-    /**
-     * Gets the ISO codes of all countries where the organisation has venues.
-     *
-     * @return string[]
-     */
-    getIsoCodesOfCountriesOfVenues(): string[];
-    /**
-     * Gets the ISO country code of the main location of the organisation
-     *
-     * @return string
-     */
-    getMainLocationCountryIsoCode(): string;
-    /**
-     * Gets the ID of the organisation.
-     *
-     * @return number
-     */
-    getOrganisationId(): number;
-    /**
-     * Gets the name of the organisation.
-     *
-     * @return string
-     */
-    getOrganisationName(): string;
-    /**
-     * Gets the virtual name of the organisation.
-     *
-     * @return string
-     */
-    getOrganisationVirtualName(): string;
-}

package/src/models/organisation-for-search/i-organisation-for-search.js

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

package/src/models/organisation-for-search/public-organisation-for-search-client.d.ts

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

package/src/models/organisation-for-search/public-organisation-for-search-client.js

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

package/src/models/organisation-search-document/i-organisation-search-document.d.ts

@@ -1,158 +0,0 @@
-export interface IOrganisationSearchDocument {
-    /**
-     * Gets the ISO codes of all countries where the organisation has venues
-     *
-     * @return string[]
-     */
-    getCountryIsoCodesOfVenues(): string[];
-    /**
-     * Gets the ISO code of the main location of the organisation
-     *
-     * @return string
-     */
-    getCountryIsoCodeOfMainLocation(): string;
-    /**
-     * Returns the number of bachelors offered by the organisation
-     *
-     * @return number
-     */
-    getNumberOfProgrammesForBachelors(): number;
-    /**
-     * Returns the number of distance learning courses offered by the organisation
-     *
-     * @return number
-     */
-    getNumberOfProgrammesForDistanceLearning(): number;
-    /**
-     * Returns the number of masters offered by the organisation
-     *
-     * @return number
-     */
-    getNumberOfProgrammesForMasters(): number;
-    /**
-     * Returns the number of phds offered by the organisation
-     *
-     * @return number
-     */
-    getNumberOfProgrammesForPhd(): number;
-    /**
-     * Returns the number of short courses offered by the organisation
-     *
-     * @return number
-     */
-    getNumberOfProgrammesForShortCourses(): number;
-    /**
-     * Gets the ID of the organisation.
-     *
-     * @return number
-     */
-    getOrganisationId(): number;
-    /**
-     * Gets the premium type of the organisation
-     *
-     * @return string | null
-     */
-    getPremiumType(): string | null;
-    /**
-     * Checks whether the organisation has studies taught both online and on campus
-     *
-     * @return boolean
-     */
-    hasDeliveryMethodBlended(): boolean;
-    /**
-     * Checks whether the organisation has studies taught on campus
-     *
-     * @return boolean
-     */
-    hasDeliveryMethodOnCampus(): boolean;
-    /**
-     * Checks whether the organisation has studies taught online
-     *
-     * @return boolean
-     */
-    hasDeliveryMethodOnline(): boolean;
-    /**
-     * Gets the IDs of all areas where the organisation has venues
-     *
-     * @return number[]
-     */
-    identifyAreasOfVenues(): number[];
-    /**
-     * Gets the disciplines of Bachelors programmes taught at the organisation
-     *
-     * @return number[]
-     */
-    identifyDisciplinesForBachelors(): number[];
-    /**
-     * Gets the disciplines of Masters programmes taught at the organisation
-     *
-     * @return number[]
-     */
-    identifyDisciplinesForMasters(): number[];
-    /**
-     * Gets the disciplines of PhD programmes taught at the organisation
-     *
-     * @return number[]
-     */
-    identifyDisciplinesForPhd(): number[];
-    /**
-     * Gets the disciplines of short courses programmes taught at the organisation
-     *
-     * @return number[]
-     */
-    identifyDisciplinesForShortCourses(): number[];
-    /**
-     * Gets the IDs of all regions (continents) where the organisation has venues
-     *
-     * @return number[]
-     */
-    identifyRegionsOfVenues(): number[];
-    /**
-     * Returns true when the organisation does not have a parent organisation
-     *
-     * @return boolean
-     */
-    isMainOrganisation(): boolean;
-    /**
-     * Indicates whether the organisation is published or not
-     *
-     * @return boolean
-     */
-    isPublished(): boolean;
-    /**
-     * Gets the city IDs for Masters programmes offered by the organisation
-     *
-     * @return array<number>
-     */
-    getCityIdsForMasters(): number[];
-    /**
-     * Gets the city IDs for Bachelors programmes offered by the organisation
-     *
-     * @return array<number>
-     */
-    getCityIdsForBachelors(): number[];
-    /**
-     * Gets the city IDs for PhD programmes offered by the organisation
-     *
-     * @return array<number>
-     */
-    getCityIdsForPhd(): number[];
-    /**
-     * Gets the city IDs for Short Courses programmes offered by the organisation
-     *
-     * @return array<number>
-     */
-    getCityIdsForShortCourses(): number[];
-    /**
-     * Gets the city IDs for Distance Learning programmes offered by the organisation
-     *
-     * @return array<number>
-     */
-    getCityIdsForDistanceLearning(): number[];
-    /**
-     * Gets the virtual path for the organisation
-     *
-     * @return string
-     */
-    getVirtualPath(): string;
-}

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

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

package/src/models/organisation-search-document/organisation-search-document-client.d.ts

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

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

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

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

@@ -1,5 +0,0 @@
-export interface IClickTrackingData {
-    getAction(): string;
-    getCategory(): string;
-    getLabel(): string;
-}

package/src/models/programme-card/i-click-tracking-data.js

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

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

@@ -1,14 +0,0 @@
-export interface ICover {
-    /**
-     * Get the file ID of the cover (as known in the system)
-     *
-     * @return number
-     */
-    getId(): number;
-    /**
-     * Get the source URL for the cover.
-     *
-     * @return string
-     */
-    getSource(): string;
-}

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

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

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

@@ -1,20 +0,0 @@
-export interface IDeadline {
-    /**
-     * Get the date this deadline expires on.
-     *
-     * @return Date
-     */
-    getDate(): Date;
-    /**
-     * Get the deadline type (e.g. general, national, eea, etc).
-     *
-     * @return string
-     */
-    getType(): string;
-    /**
-     * True if the deadline has passed (e.g. you can't apply anymore).
-     *
-     * @return boolean
-     */
-    isPassed(): boolean;
-}