@studyportals/domain-client 3.30.0 → 3.32.0-1

package/src/models/dotdigital-programme/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/dotdigital-programme/i-tuition-fee.js

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

package/src/models/dotdigital-programme/i-tuition-fee.js.map

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

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

@@ -0,0 +1,68 @@
+export interface IOrganisationSearchDocument {
+    /**
+     * Gets the ISO codes of all countries where the organisation has venues
+     *
+     * @return string[]
+     */
+    getCountryIsoCodesOfVenues(): string[];
+    /**
+     * Gets the ID of the organisation.
+     *
+     * @return number
+     */
+    getOrganisationId(): number;
+    /**
+     * Gets the premium type of the organisation
+     *
+     * @return string | null
+     */
+    getPremiumType(): string | null;
+    /**
+     * Cheked whether the organisation has studies taught both online and on campus
+     *
+     * @return boolean
+     */
+    hasDeliveryMethodBlended(): boolean;
+    /**
+     * Cheked whether the organisation has studies taught on campus
+     *
+     * @return boolean
+     */
+    hasDeliveryMethodOnCampus(): boolean;
+    /**
+     * Cheked whether the organisation has studies taught online
+     *
+     * @return boolean
+     */
+    hasDeliveryMethodOnline(): boolean;
+    /**
+     * Gets the IDs of all areas where the organisation has venues
+     *
+     * @return number[]
+     */
+    identifyAreasOfVenues(): number[];
+    /**
+     * Gets the disciplines of Bachelors programmes taught at the organisation
+     *
+     * @return number[]
+     */
+    identifyDisciplinesForBachelors(): number[];
+    /**
+     * Gets the disciplines of Masters programmes taught at the organisation
+     *
+     * @return number[]
+     */
+    identifyDisciplinesForMasters(): number[];
+    /**
+     * Gets the disciplines of PhD programmes taught at the organisation
+     *
+     * @return number[]
+     */
+    identifyDisciplinesForPhd(): number[];
+    /**
+     * Gets the disciplines of short courses programmes taught at the organisation
+     *
+     * @return number[]
+     */
+    identifyDisciplinesForShortCourses(): number[];
+}

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

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

package/src/models/organisation-search-document/i-organisation-search-document.js.map

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

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

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

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

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

package/src/models/organisation-search-document/organisation-search-document-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"organisation-search-document-client.js","sourceRoot":"","sources":["../../../../src/models/organisation-search-document/organisation-search-document-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,gCAAiC,SAAQ,0BAAwC;IACnF,YAAY;QACrB,OAAO,8BAA8B,CAAC;IACvC,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,4EAYC"}

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

@@ -0,0 +1,44 @@
+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 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/programme-card/i-english-requirements.js

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

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

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

package/src/models/programme-card/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/programme-card/i-g-p-a-requirement.js

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

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

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

package/src/models/programme-card/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/programme-card/i-living-cost.js

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

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

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