@studyportals/domain-client 7.0.1-beta.9 → 7.1.1-beta.0

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

@@ -0,0 +1,45 @@
+import { IDeadline, IStartDate } from "../../../index.js";
+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/programme-card/i-timing.js

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

package/src/models/programme-card/i-tracked-link.d.ts

@@ -0,0 +1,29 @@
+import { ITracking } from "../../../index.js";
+export interface ITrackedLink {
+    /**
+     * Get an optional text describing the link (typically <a>-tags contents).
+     *
+     * @return string
+     * @throws PropertyNotAvailableException
+     */
+    getDescription(): string;
+    canShowDescription(): boolean;
+    /**
+     * Get an object containing all information needed to properly track a link.
+     *
+     * @return ITracking
+     */
+    getTracking(): ITracking;
+    /**
+     * 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/programme-card/i-tracked-link.js

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

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

@@ -0,0 +1,46 @@
+import { IClickTrackingData } from "../../../index.js";
+export interface ITracking {
+    /**
+     * Get the value of the data-action attribute.
+     *
+     * @return string
+     */
+    getAction(): string;
+    /**
+     * Get all the data that is need to make click tracking possible
+     *
+     * @return IClickTrackingData
+     */
+    getClickTrackingData(): IClickTrackingData;
+    canShowClickTrackingData(): boolean;
+    /**
+     * Get the value of the data-description attribute.
+     *
+     * @return string
+     */
+    getDescription(): string;
+    /**
+     * Get the extra information value.
+     *
+     * @return string
+     */
+    getExtra(): string;
+    /**
+     * Get the value of the data-id attribute.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * Get the value of the data-label attribute.
+     *
+     * @return string
+     */
+    getLabel(): string;
+    /**
+     * Get the value of the data-type attribute.
+     *
+     * @return string
+     */
+    getType(): string;
+}

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

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

package/src/models/programme-card/i-tuition-fee.d.ts

@@ -0,0 +1,50 @@
+export interface ITuitionFee {
+    /**
+     * Get the tuition amount per unit in the provided currency.
+     *
+     * Note: all transformable units will be converted to yearly amounts. This
+     * includes per semester and full programme tuition fees.
+     *
+     * @return number
+     */
+    getAmount(): number;
+    /**
+     * Get the applicable currency.
+     *
+     * @return string
+     */
+    getCurrency(): string;
+    /**
+     * Get the original tuition amount before any transformation step.
+     *
+     * @return number
+     */
+    getOriginalAmount(): number;
+    /**
+     * Get the original tuition unit before any transformation step.
+     *
+     * @return string
+     */
+    getOriginalUnit(): string;
+    /**
+     * Get targeted audience (national, international, eea, etc).
+     *
+     * @return string
+     */
+    getTarget(): string;
+    /**
+     * Get the unit the tuition fee applies for.
+     *
+     * Note: all transformable units will be converted to 'year'. This means
+     * this value will be either 'year', 'module' or 'credit'.
+     *
+     * @return string
+     */
+    getUnit(): string;
+    /**
+     * True if the study is free for this target audience.
+     *
+     * @return boolean
+     */
+    isFree(): boolean;
+}

package/src/models/programme-card/i-tuition-fee.js

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

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

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

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

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

package/src/models/ranking-cards/i-ranking.d.ts

@@ -0,0 +1,18 @@
+export interface IRanking {
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return number | null
+     */
+    getRankingId(): number | null;
+    /**
+     * @return number
+     */
+    getPosition(): number;
+    /**
+     * @return string
+     */
+    getRankingYear(): string;
+}

package/src/models/ranking-cards/i-ranking.js

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

package/src/models/scholarship-card/i-scholarship-card-v2.d.ts

@@ -0,0 +1,20 @@
+export interface IScholarshipCardV2 {
+    getDescriptionOfApplicationBasis(): string | null;
+    getDescriptionOfBenefits(): string | null;
+    getDescriptionOfDeadline(): string;
+    getDescriptionOfDestinationCountryRestrictions(): string;
+    getDescriptionOfProviderLocation(): string | null;
+    getIsNotSpecifiedDeadline(): boolean;
+    getProviderId(): string | null;
+    getProviderIsUniversity(): boolean;
+    getProviderLogoSquareCdn(): string | null;
+    getProviderName(): string;
+    getScholarshipId(): string;
+    getScholarshipTitle(): string;
+    getScholarshipVirtualName(): string;
+    getDisciplineIds(): number[] | null;
+    getOriginCountryIds(): string[] | null;
+    getGrantCurrencyIso(): string | null;
+    getGrantAmount(): number | null;
+    getGrantDescription(): string | null;
+}

package/src/models/scholarship-card/i-scholarship-card-v2.js

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

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

@@ -0,0 +1,15 @@
+export interface IScholarshipCard {
+    getDescriptionOfApplicationBasis(): string | null;
+    getDescriptionOfBenefits(): string | null;
+    getDescriptionOfDeadline(): string;
+    getDescriptionOfDestinationCountryRestrictions(): string;
+    getDescriptionOfProviderLocation(): string | null;
+    getIsNotSpecifiedDeadline(): boolean;
+    getProviderId(): string | null;
+    getProviderIsUniversity(): boolean;
+    getProviderLogoSquareCdn(): string | null;
+    getProviderName(): string;
+    getScholarshipId(): string;
+    getScholarshipTitle(): string;
+    getScholarshipVirtualName(): string;
+}

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

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

package/src/models/scholarship-card/public-scholarship-card-client.d.ts

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

package/src/models/scholarship-card/public-scholarship-card-client.js

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

package/src/models/scholarship-card/scholarship-card-v2-client.d.ts

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

package/src/models/scholarship-card/scholarship-card-v2-client.js

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

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

@@ -0,0 +1,38 @@
+export interface IScholarshipSearchDocument {
+    /**
+     * @return number[]
+     */
+    getDegrees(): number[];
+    /**
+     * @return string[]
+     */
+    getDestinationCountryIsoCodes(): string[];
+    /**
+     * @return number[]
+     */
+    getDestinationRegionIds(): number[];
+    /**
+     * @return number[]
+     */
+    getDisciplineIds(): number[];
+    /**
+     * @return number[]
+     */
+    getFormats(): number[];
+    getId(): number;
+    /**
+     * @return string[]
+     */
+    getOriginCountryIsoCodes(): string[];
+    getPresence(): number;
+    getTitle(): string;
+    /**
+     * @return number[]
+     */
+    getTypes(): number[];
+    getUniversityProviderId(): number | null;
+    isEligibleForAllDestinationCountries(): boolean;
+    isEligibleForAllDestinationRegions(): boolean;
+    isEligibleForAllDisciplines(): boolean;
+    isEligibleForAllOriginCountries(): boolean;
+}

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

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

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

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

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

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

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

@@ -0,0 +1,26 @@
+export interface ISearchDiscipline {
+    /**
+     * @return string | null
+     */
+    getIcon(): string | null;
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getName(): string;
+    /**
+     * @return string | null
+     */
+    getOldVirtualPath(): string | null;
+    /**
+     * @return number | null
+     */
+    getParentId(): number | null;
+    /**
+     * @return string
+     */
+    getVirtualPath(): string;
+}

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

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

package/src/models/search-discipline/public-search-discipline-client.d.ts

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

package/src/models/search-discipline/public-search-discipline-client.js

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

package/src/models/search-projection/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/search-projection/i-geo-targeting-configuration.js

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

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

@@ -0,0 +1,30 @@
+import { IGeoTargetingConfiguration } from "../../../index.js";
+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/search-projection/i-geo-targeting-values.js

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

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

@@ -0,0 +1,46 @@
+export interface IOrganisationValues {
+    /**
+     * Country ID of the top level organisation.
+     *
+     * @return number
+     */
+    getCountryId(): number;
+    /**
+     * Country iso code of the top level organisation.
+     *
+     * @return string
+     */
+    getCountryIsoCode(): string;
+    /**
+     * 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

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

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

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

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

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