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

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

@@ -0,0 +1,125 @@
+import { IEnglishRequirements, IGPARequirement, IGeoTargetingValues, IInternalLink, ILink, ILivingCost, ITiming, ITuitionValues } from "../../..";
+export interface ICopilotProgramme {
+    /**
+     * Get country the programme is taught in
+     *
+     * @return number[]
+     */
+    getCountryIds(): number[];
+    /**
+     * Get country iso codes the programme is taught in
+     *
+     * @return string[]
+     */
+    getCountryIsoCodes(): string[];
+    /**
+     * Get discipline ids attached to this programme
+     *
+     * @return number[]
+     */
+    getDisciplineIds(): number[];
+    /**
+     * Education level
+     *
+     * @return string
+     */
+    getEducationalLevel(): string;
+    /**
+     * English level requirements.
+     *
+     * @return IEnglishRequirements
+     */
+    getEnglishRequirements(): IEnglishRequirements;
+    /**
+     * GPA Requirements
+     *
+     * @return IGPARequirement | null
+     */
+    getGPA(): IGPARequirement | null;
+    getGeneralRequirements(): string | null;
+    /**
+     * Get geotargetting settings for the programme
+     *
+     * @return IGeoTargetingValues
+     */
+    getGeoTargetingValues(): IGeoTargetingValues;
+    getGlobalUniversityRanking(): string | null;
+    /**
+     * Id of the programme.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * The programmes estimated living cost
+     *
+     * @return ILivingCost | null
+     */
+    getLivingCost(): ILivingCost | null;
+    /**
+     * 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;
+    /**
+     * Summary of the programme.
+     *
+     * @return string
+     */
+    getSummary(): string;
+    /**
+     * Get all start dates
+     *
+     * @return ITiming[]
+     */
+    getTimings(): ITiming[];
+    /**
+     * Title of the programme.
+     *
+     * @return string
+     */
+    getTitle(): string;
+    /**
+     * The programmes tuition fees
+     *
+     * @return ITuitionValues | null
+     */
+    getTuitionValues(): ITuitionValues | null;
+    /**
+     * 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;
+    /**
+     * University title
+     *
+     * @return string
+     */
+    getUniversityTitle(): string;
+    /**
+     * Work experience requirements in years
+     *
+     * @return number | null
+     */
+    getWorkExperienceYears(): number | null;
+    /**
+     * Is programme public
+     *
+     * @return boolean
+     */
+    isPublic(): boolean;
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomerIOOrganisationClient = void 0;
+const model_client_1 = require("../../model-client");
+class CustomerIOOrganisationClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'customerio-organisation';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.CustomerIOOrganisationClient = CustomerIOOrganisationClient;

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

@@ -0,0 +1,35 @@
+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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomerIOProgrammeClient = void 0;
+const model_client_1 = require("../../model-client");
+class CustomerIOProgrammeClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'customerio-programme';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.CustomerIOProgrammeClient = CustomerIOProgrammeClient;

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

@@ -0,0 +1,107 @@
+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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,28 @@
+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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicFaqStaticContentClient = void 0;
+const model_client_1 = require("../../model-client");
+class PublicFaqStaticContentClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'faq-static-content';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return true;
+    }
+}
+exports.PublicFaqStaticContentClient = PublicFaqStaticContentClient;

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

@@ -0,0 +1,39 @@
+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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganisationCardClient = void 0;
+const model_client_1 = require("../../model-client");
+class OrganisationCardClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'organisation-card';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.OrganisationCardClient = OrganisationCardClient;

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

@@ -0,0 +1,32 @@
+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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicOrganisationForSearchClient = void 0;
+const model_client_1 = require("../../model-client");
+class PublicOrganisationForSearchClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'organisation-for-search';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return true;
+    }
+}
+exports.PublicOrganisationForSearchClient = PublicOrganisationForSearchClient;