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

package/src/models/copilot-country/i-copilot-ranking-card.d.ts

@@ -1,38 +1,38 @@
-export interface ICopilotRankingCard {
-    /**
-     * Get the organisation id.
-     *
-     * @return number
-     */
-    getOrganisationId(): number;
-    /**
-     * Get the organisation name.
-     *
-     * @return string | null
-     */
-    getOrganisationName(): string | null;
-    /**
-     * Get the organisation homepage link.
-     *
-     * @return string | null
-     */
-    getOrganisationPageUrl(): string | null;
-    /**
-     * Get the organisation logo url.
-     *
-     * @return string | null
-     */
-    getOrganisationLogoUrl(): string | null;
-    /**
-     * Verifies if the organisation's logo can be displayed.
-     *
-     * @return boolean
-     */
-    hasOrganisationLogo(): boolean;
-    /**
-     * Retrieves the ranking position for the organisation in the Studyportals ranking in the country of the university.
-     *
-     * @return number | null
-     */
-    getPositionInCountry(): number | null;
-}
+export interface ICopilotRankingCard {
+    /**
+     * Get the organisation id.
+     *
+     * @return number
+     */
+    getOrganisationId(): number;
+    /**
+     * Get the organisation name.
+     *
+     * @return string | null
+     */
+    getOrganisationName(): string | null;
+    /**
+     * Get the organisation homepage link.
+     *
+     * @return string | null
+     */
+    getOrganisationPageUrl(): string | null;
+    /**
+     * Get the organisation logo url.
+     *
+     * @return string | null
+     */
+    getOrganisationLogoUrl(): string | null;
+    /**
+     * Verifies if the organisation's logo can be displayed.
+     *
+     * @return boolean
+     */
+    hasOrganisationLogo(): boolean;
+    /**
+     * Retrieves the ranking position for the organisation in the Studyportals ranking in the country of the university.
+     *
+     * @return number | null
+     */
+    getPositionInCountry(): number | null;
+}

package/src/models/copilot-country/i-copilot-ranking-card.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=i-copilot-ranking-card.js.map

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

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

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

@@ -1,17 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CopilotProgrammeClient = void 0;
-const model_client_1 = require("../../model-client");
-class CopilotProgrammeClient extends model_client_1.ModelClient {
-    getModelName() {
-        return 'copilot-programme';
-    }
-    getVersion() {
-        return 'v1';
-    }
-    isPublic() {
-        return false;
-    }
-}
-exports.CopilotProgrammeClient = CopilotProgrammeClient;
+import { ModelClient } from "../../model-client";
+export class CopilotProgrammeClient extends ModelClient {
+    getModelName() {
+        return 'copilot-programme';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
 //# sourceMappingURL=copilot-programme-client.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"copilot-programme-client.js","sourceRoot":"","sources":["../../../../src/models/copilot-programme/copilot-programme-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,sBAAuB,SAAQ,0BAA8B;IAC/D,YAAY;QACrB,OAAO,mBAAmB,CAAC;IAC5B,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,wDAYC"}
+{"version":3,"file":"copilot-programme-client.js","sourceRoot":"","sources":["../../../../src/models/copilot-programme/copilot-programme-client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,OAAO,sBAAuB,SAAQ,WAA8B;IAC/D,YAAY;QACrB,OAAO,mBAAmB,CAAC;IAC5B,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD"}

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

@@ -1,125 +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;
-}
+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

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=i-copilot-programme.js.map

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

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

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

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

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

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

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

@@ -0,0 +1,51 @@
+export interface IEnglishRequirements {
+    /**
+     * Required score for Cambridge english
+     *
+     * @return number
+     */
+    getCambridgeEnglish(): number;
+    canShowCambridgeEnglish(): boolean;
+    /**
+     * Required score for Duolingo
+     *
+     * @return number
+     */
+    getDuolingo(): number;
+    canShowDuolingo(): boolean;
+    /**
+     * Required score for IELTS tests
+     *
+     * @return number
+     */
+    getIELTS(): number;
+    canShowIELTS(): boolean;
+    /**
+     * Required score for OTE
+     *
+     * @return number
+     */
+    getOte(): number;
+    canShowOte(): boolean;
+    /**
+     * Required score for PTE
+     *
+     * @return number
+     */
+    getPTE(): number;
+    canShowPTE(): boolean;
+    /**
+     * Required score for TOEFL internet
+     *
+     * @return number
+     */
+    getTOEFLInternet(): number;
+    canShowTOEFLInternet(): boolean;
+    /**
+     * Required score for TOEFL paper
+     *
+     * @return number
+     */
+    getTOEFLPaper(): number;
+    canShowTOEFLPaper(): boolean;
+}

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

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

package/src/models/copilot-programme/i-english-requirements.js.map

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

package/src/models/copilot-programme/i-g-p-a-requirement.d.ts

@@ -0,0 +1,20 @@
+export interface IGPARequirement {
+    /**
+     * The used GPA scale for this requirement
+     *
+     * @return string
+     */
+    getScale(): string;
+    /**
+     * Required minimum score.
+     *
+     * @return string
+     */
+    getScore(): string;
+    /**
+     * Is GPA recommended or required.
+     *
+     * @return boolean
+     */
+    isRequired(): boolean;
+}

package/src/models/copilot-programme/i-g-p-a-requirement.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=i-g-p-a-requirement.js.map

package/src/models/copilot-programme/i-g-p-a-requirement.js.map

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

package/src/models/copilot-programme/i-geo-targeting-configuration.d.ts

@@ -0,0 +1,38 @@
+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/copilot-programme/i-geo-targeting-configuration.js

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

package/src/models/copilot-programme/i-geo-targeting-configuration.js.map

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

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

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

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

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

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

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

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

package/src/models/copilot-programme/i-internal-link.js.map

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

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

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

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

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

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