@studyportals/domain-client 5.6.1-beta.1 → 6.0.0-1

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

@@ -0,0 +1,20 @@
+export interface ILivingCost {
+    /**
+     * Get the applicable currency.
+     *
+     * @return string
+     */
+    getCurrency(): string;
+    /**
+     * Get the maximum living cost in the provided currency.
+     *
+     * @return number
+     */
+    getMax(): number;
+    /**
+     * Get the minimum living cost in the provided currency.
+     *
+     * @return number
+     */
+    getMin(): number;
+}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=i-living-cost.js.map

package/src/models/copilot-programme/i-living-cost.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-living-cost.js","sourceRoot":"","sources":["../../../../src/models/copilot-programme/i-living-cost.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,33 @@
+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/copilot-programme/i-start-date.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=i-start-date.js.map

package/src/models/copilot-programme/i-start-date.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-start-date.js","sourceRoot":"","sources":["../../../../src/models/copilot-programme/i-start-date.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,45 @@
+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/copilot-programme/i-timing.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=i-timing.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"i-timing.js","sourceRoot":"","sources":["../../../../src/models/copilot-programme/i-timing.ts"],"names":[],"mappings":""}

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

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=i-tuition-values.js.map

package/src/models/copilot-programme/i-tuition-values.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-tuition-values.js","sourceRoot":"","sources":["../../../../src/models/copilot-programme/i-tuition-values.ts"],"names":[],"mappings":""}

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

@@ -1,7 +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;
-}
+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,17 +1,13 @@
-"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;
+import { ModelClient } from "../../model-client";
+export class CustomerIOOrganisationClient extends ModelClient {
+    getModelName() {
+        return 'customerio-organisation';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
 //# sourceMappingURL=customerio-organisation-client.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"customerio-organisation-client.js","sourceRoot":"","sources":["../../../../src/models/customerio-organisation/customerio-organisation-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,4BAA6B,SAAQ,0BAAoC;IAC3E,YAAY;QACrB,OAAO,yBAAyB,CAAC;IAClC,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,oEAYC"}
+{"version":3,"file":"customerio-organisation-client.js","sourceRoot":"","sources":["../../../../src/models/customerio-organisation/customerio-organisation-client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,OAAO,4BAA6B,SAAQ,WAAoC;IAC3E,YAAY;QACrB,OAAO,yBAAyB,CAAC;IAClC,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD"}

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

@@ -0,0 +1,14 @@
+export interface ICity {
+    /**
+     * Get city id
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Get city name
+     *
+     * @return string
+     */
+    getName(): string;
+}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=i-city.js.map

package/src/models/customerio-organisation/i-city.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-city.js","sourceRoot":"","sources":["../../../../src/models/customerio-organisation/i-city.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,20 @@
+export interface ICountry {
+    /**
+     * Get country iso code
+     *
+     * @return string
+     */
+    getISOCode(): string;
+    /**
+     * Get country id
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Get country name
+     *
+     * @return string
+     */
+    getName(): string;
+}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=i-country.js.map

package/src/models/customerio-organisation/i-country.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-country.js","sourceRoot":"","sources":["../../../../src/models/customerio-organisation/i-country.ts"],"names":[],"mappings":""}

package/src/models/customerio-organisation/i-customer-i-o-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-i-o-organisation.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=i-customer-i-o-organisation.js.map

package/src/models/customerio-organisation/i-customer-i-o-organisation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-customer-i-o-organisation.js","sourceRoot":"","sources":["../../../../src/models/customerio-organisation/i-customer-i-o-organisation.ts"],"names":[],"mappings":""}

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

@@ -1,35 +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;
-}
+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,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=i-customer-io-organisation.js.map

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

@@ -1,7 +1,7 @@
-export interface IReview {
-    getEndDate(): Date | null;
-    getRating(): number;
-    getReview(): string | null;
-    getStartDate(): Date | null;
-    getTitle(): string | null;
-}
+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,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=i-review.js.map

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

@@ -1,7 +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;
-}
+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,17 +1,13 @@
-"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;
+import { ModelClient } from "../../model-client";
+export class CustomerIOProgrammeClient extends ModelClient {
+    getModelName() {
+        return 'customerio-programme';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
 //# sourceMappingURL=customerio-programme-client.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"customerio-programme-client.js","sourceRoot":"","sources":["../../../../src/models/customerio-programme/customerio-programme-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,yBAA0B,SAAQ,0BAAiC;IACrE,YAAY;QACrB,OAAO,sBAAsB,CAAC;IAC/B,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,8DAYC"}
+{"version":3,"file":"customerio-programme-client.js","sourceRoot":"","sources":["../../../../src/models/customerio-programme/customerio-programme-client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,OAAO,yBAA0B,SAAQ,WAAiC;IACrE,YAAY;QACrB,OAAO,sBAAsB,CAAC;IAC/B,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD"}

package/src/models/customerio-programme/i-country.d.ts

@@ -0,0 +1,20 @@
+export interface ICountry {
+    /**
+     * Get country iso code
+     *
+     * @return string
+     */
+    getISOCode(): string;
+    /**
+     * Get country id
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Get country name
+     *
+     * @return string
+     */
+    getName(): string;
+}

package/src/models/customerio-programme/i-country.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=i-country.js.map

package/src/models/customerio-programme/i-country.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-country.js","sourceRoot":"","sources":["../../../../src/models/customerio-programme/i-country.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=i-customer-i-o-programme.js.map

package/src/models/customerio-programme/i-customer-i-o-programme.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-customer-i-o-programme.js","sourceRoot":"","sources":["../../../../src/models/customerio-programme/i-customer-i-o-programme.ts"],"names":[],"mappings":""}