@studyportals/domain-client 3.36.0 → 3.36.1-beta.0

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

@@ -1,40 +1,40 @@
-export interface IOrganisationValues {
-    /**
-     * Country ID of the top level organisation.
-     *
-     * @return number
-     */
-    getCountryId(): number;
-    /**
-     * ID of the programme's main organisation.
-     *
-     * First premium organisation or top level organisation.
-     *
-     * @return number
-     */
-    getId(): number;
-    /**
-     * Name of the programme's main organisation.
-     *
-     * First premium organisation or top level organisation.
-     *
-     * @return string
-     */
-    getName(): string;
-    /**
-     * List of all organisation IDs attached to the programme (main + sub).
-     *
-     * @return number[]
-     */
-    getOrganisations(): number[];
-    /**
-     * Region ID of the top level organisation.
-     *
-     * Currently only possible region ID is 38 (EEA region). All other regions
-     * are ignored for this field.
-     *
-     * @return number
-     */
-    getRegionId(): number;
-    canShowRegionId(): boolean;
-}
+export interface IOrganisationValues {
+    /**
+     * Country ID of the top level organisation.
+     *
+     * @return number
+     */
+    getCountryId(): number;
+    /**
+     * ID of the programme's main organisation.
+     *
+     * First premium organisation or top level organisation.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Name of the programme's main organisation.
+     *
+     * First premium organisation or top level organisation.
+     *
+     * @return string
+     */
+    getName(): string;
+    /**
+     * List of all organisation IDs attached to the programme (main + sub).
+     *
+     * @return number[]
+     */
+    getOrganisations(): number[];
+    /**
+     * Region ID of the top level organisation.
+     *
+     * Currently only possible region ID is 38 (EEA region). All other regions
+     * are ignored for this field.
+     *
+     * @return number
+     */
+    getRegionId(): number;
+    canShowRegionId(): boolean;
+}

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

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

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

@@ -1,35 +1,35 @@
-export interface IPremiumValues {
-    /**
-     * Bottom of the premium probability range (between 0.0 asn 1.0).
-     *
-     * @return number
-     */
-    getPremiumBottom(): number;
-    canShowPremiumBottom(): boolean;
-    /**
-     * CPM value attached to the premium listing.
-     *
-     * @return number
-     */
-    getPremiumCpm(): number;
-    canShowPremiumCpm(): boolean;
-    /**
-     * Top of the premium probability range (between 0.0 asn 1.0).
-     *
-     * @return number
-     */
-    getPremiumTop(): number;
-    canShowPremiumTop(): boolean;
-    /**
-     * Short hand premium type (sp, p, lp, slp, sslp, b).
-     *
-     * @return string
-     */
-    getPremiumType(): string;
-    /**
-     * Premium weight value used in Cloudsearch commercial sorting.
-     *
-     * @return number
-     */
-    getPremiumValue(): number;
-}
+export interface IPremiumValues {
+    /**
+     * Bottom of the premium probability range (between 0.0 asn 1.0).
+     *
+     * @return number
+     */
+    getPremiumBottom(): number;
+    canShowPremiumBottom(): boolean;
+    /**
+     * CPM value attached to the premium listing.
+     *
+     * @return number
+     */
+    getPremiumCpm(): number;
+    canShowPremiumCpm(): boolean;
+    /**
+     * Top of the premium probability range (between 0.0 asn 1.0).
+     *
+     * @return number
+     */
+    getPremiumTop(): number;
+    canShowPremiumTop(): boolean;
+    /**
+     * Short hand premium type (sp, p, lp, slp, sslp, b).
+     *
+     * @return string
+     */
+    getPremiumType(): string;
+    /**
+     * Premium weight value used in Cloudsearch commercial sorting.
+     *
+     * @return number
+     */
+    getPremiumValue(): number;
+}

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

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

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

@@ -1,180 +1,180 @@
-import { IGeoTargetingValues, IOrganisationValues, IPremiumValues, ITuitionValues } from "../../..";
-export interface ISearchProjection {
-    /**
-     * List of area IDs where the programme is taught at (through venues).
-     *
-     * @return number[]
-     */
-    getAreas(): number[];
-    /**
-     * Current boost value for the programme (campaign automation).
-     *
-     * @return number
-     */
-    getBoost(): number;
-    /**
-     * Contents text of the programme (stripped of html tags).
-     *
-     * @return string
-     */
-    getContents(): string;
-    /**
-     * List of country IDs where the programme is taught at (through venues).
-     *
-     * @return number[]
-     */
-    getCountries(): number[];
-    /**
-     * Unformatted degree of the programme.
-     *
-     * @return string
-     */
-    getDegree(): string;
-    /**
-     * Formatted degree of the programme.
-     *
-     * @return string
-     */
-    getDegreeFormatted(): string;
-    /**
-     * List of intensity densities of the programme.
-     *
-     * @return string[]
-     */
-    getDensity(): string[];
-    /**
-     * Description text of the programme (stripped of html tags).
-     *
-     * @return string
-     */
-    getDescription(): string;
-    /**
-     * List of disciplines connected to the programme (includes parent IDs).
-     *
-     * @return number[]
-     */
-    getDisciplines(): number[];
-    /**
-     * List of educational forms.
-     *
-     * @return string[]
-     */
-    getEducationalForms(): string[];
-    /**
-     * Full time duration in days.
-     *
-     * @return number
-     */
-    getFullTimeDuration(): number;
-    canShowFullTimeDuration(): boolean;
-    getGeoTargetingValues(): IGeoTargetingValues;
-    /**
-     * Id of the programme.
-     *
-     * @return number
-     */
-    getId(): number;
-    /**
-     * List of language IDs the programme is taught in.
-     *
-     * @return number[]
-     */
-    getLanguages(): number[];
-    /**
-     * Study level of the programme.
-     *
-     * @return string
-     */
-    getLevel(): string;
-    /**
-     * Url of the logo to display (square if available, legacy otherwise).
-     *
-     * @return string
-     */
-    getLogo(): string;
-    canShowLogo(): boolean;
-    /**
-     * Url of the legacy logo to display.
-     *
-     * @return string
-     */
-    getLogoOld(): string;
-    canShowLogoOld(): boolean;
-    /**
-     * List of study methods.
-     *
-     * @return string[]
-     */
-    getMethods(): string[];
-    getOrganisationValues(): IOrganisationValues;
-    /**
-     * Part time duration in days.
-     *
-     * @return number
-     */
-    getPartTimeDuration(): number;
-    canShowPartTimeDuration(): boolean;
-    getPremiumValues(): IPremiumValues;
-    /**
-     * The programme's probability seed value (previously known as 'entropy').
-     *
-     * Should be a value between 0 and 4095.
-     *
-     * @return number
-     */
-    getProbabilitySeed(): number;
-    /**
-     * List of region IDs where the programme is taught at (through venues).
-     *
-     * Includes both the direct regions as the parent regions.
-     *
-     * @return number[]
-     */
-    getRegions(): number[];
-    /**
-     * List of special programme types (executive, joint, erasmus).
-     *
-     * @return string[]
-     */
-    getSpecialStudy(): string[];
-    /**
-     * List of the start months for the programme.
-     *
-     * @return number[]
-     */
-    getStartDates(): number[];
-    /**
-     * Summary text of the programme (stripped of html tags).
-     *
-     * @return string
-     */
-    getSummary(): string;
-    /**
-     * Title of the programme.
-     *
-     * @return string
-     */
-    getTitle(): string;
-    getTuitionValues(): ITuitionValues;
-    canShowTuitionValues(): boolean;
-    /**
-     * List of json encoded venue descriptions.
-     *
-     * Example of structure:
-     * {
-     *'city': 'Eindhoven',
-     *'country': 'Netherlands',
-     *'area': 'North Brabant',
-     *'display_area': true
-     * }
-     *
-     * @return string[]
-     */
-    getVenues(): string[];
-    /**
-     * Public status of the programme.
-     *
-     * @return boolean
-     */
-    isPublic(): boolean;
-}
+import { IGeoTargetingValues, IOrganisationValues, IPremiumValues, ITuitionValues } from "../../..";
+export interface ISearchProjection {
+    /**
+     * List of area IDs where the programme is taught at (through venues).
+     *
+     * @return number[]
+     */
+    getAreas(): number[];
+    /**
+     * Current boost value for the programme (campaign automation).
+     *
+     * @return number
+     */
+    getBoost(): number;
+    /**
+     * Contents text of the programme (stripped of html tags).
+     *
+     * @return string
+     */
+    getContents(): string;
+    /**
+     * List of country IDs where the programme is taught at (through venues).
+     *
+     * @return number[]
+     */
+    getCountries(): number[];
+    /**
+     * Unformatted degree of the programme.
+     *
+     * @return string
+     */
+    getDegree(): string;
+    /**
+     * Formatted degree of the programme.
+     *
+     * @return string
+     */
+    getDegreeFormatted(): string;
+    /**
+     * List of intensity densities of the programme.
+     *
+     * @return string[]
+     */
+    getDensity(): string[];
+    /**
+     * Description text of the programme (stripped of html tags).
+     *
+     * @return string
+     */
+    getDescription(): string;
+    /**
+     * List of disciplines connected to the programme (includes parent IDs).
+     *
+     * @return number[]
+     */
+    getDisciplines(): number[];
+    /**
+     * List of educational forms.
+     *
+     * @return string[]
+     */
+    getEducationalForms(): string[];
+    /**
+     * Full time duration in days.
+     *
+     * @return number
+     */
+    getFullTimeDuration(): number;
+    canShowFullTimeDuration(): boolean;
+    getGeoTargetingValues(): IGeoTargetingValues;
+    /**
+     * Id of the programme.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * List of language IDs the programme is taught in.
+     *
+     * @return number[]
+     */
+    getLanguages(): number[];
+    /**
+     * Study level of the programme.
+     *
+     * @return string
+     */
+    getLevel(): string;
+    /**
+     * Url of the logo to display (square if available, legacy otherwise).
+     *
+     * @return string
+     */
+    getLogo(): string;
+    canShowLogo(): boolean;
+    /**
+     * Url of the legacy logo to display.
+     *
+     * @return string
+     */
+    getLogoOld(): string;
+    canShowLogoOld(): boolean;
+    /**
+     * List of study methods.
+     *
+     * @return string[]
+     */
+    getMethods(): string[];
+    getOrganisationValues(): IOrganisationValues;
+    /**
+     * Part time duration in days.
+     *
+     * @return number
+     */
+    getPartTimeDuration(): number;
+    canShowPartTimeDuration(): boolean;
+    getPremiumValues(): IPremiumValues;
+    /**
+     * The programme's probability seed value (previously known as 'entropy').
+     *
+     * Should be a value between 0 and 4095.
+     *
+     * @return number
+     */
+    getProbabilitySeed(): number;
+    /**
+     * List of region IDs where the programme is taught at (through venues).
+     *
+     * Includes both the direct regions as the parent regions.
+     *
+     * @return number[]
+     */
+    getRegions(): number[];
+    /**
+     * List of special programme types (executive, joint, erasmus).
+     *
+     * @return string[]
+     */
+    getSpecialStudy(): string[];
+    /**
+     * List of the start months for the programme.
+     *
+     * @return number[]
+     */
+    getStartDates(): number[];
+    /**
+     * Summary text of the programme (stripped of html tags).
+     *
+     * @return string
+     */
+    getSummary(): string;
+    /**
+     * Title of the programme.
+     *
+     * @return string
+     */
+    getTitle(): string;
+    getTuitionValues(): ITuitionValues;
+    canShowTuitionValues(): boolean;
+    /**
+     * List of json encoded venue descriptions.
+     *
+     * Example of structure:
+     * {
+     *'city': 'Eindhoven',
+     *'country': 'Netherlands',
+     *'area': 'North Brabant',
+     *'display_area': true
+     * }
+     *
+     * @return string[]
+     */
+    getVenues(): string[];
+    /**
+     * Public status of the programme.
+     *
+     * @return boolean
+     */
+    isPublic(): boolean;
+}

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

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

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

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

package/src/models/search-projection/search-projection-client.d.ts

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