@studyportals/domain-client 3.32.0-organisations.0 → 3.34.0

package/index.d.ts

@@ -76,4 +76,8 @@ import { ICompareProgramme } from "./src/models/compare-programme/i-compare-prog
 import { CompareProgrammeClient } from "./src/models/compare-programme/compare-programme-client";
 import { IOrganisationForSearch } from "./src/models/organisation-for-search/i-organisation-for-search";
 import { PublicOrganisationForSearchClient } from "./src/models/organisation-for-search/public-organisation-for-search-client";
-export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, ILogo, ITuitionFee, IEnglishRequirements, IInternalLink, IDotDigitalProgramme, DotdigitalProgrammeClient, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISearchCountryFaq, PublicSearchCountryFaqClient, ISitemapCountryInfo, SitemapCountriesInfoClient, IDegreeInfo, ISitemapCountryDegreeInfo, SitemapCountryDegreeInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, IDotDigitalOrganisation, DotdigitalOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, IOrganisationSearchDocument, OrganisationSearchDocumentClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, IScholarshipCard, PublicScholarshipCardClient, IRankingCards, IRankingCard, IRanking, PublicRankingCardsClient, ICompareProgramme, CompareProgrammeClient, PortalType, PortalMap, ModelClient, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, OrganisationCardClient };
+import { ICopilotProgramme } from "./src/models/copilot-programme/i-copilot-programme";
+import { CopilotProgrammeClient } from "./src/models/copilot-programme/copilot-programme-client";
+import { ICopilotCountry } from "./src/models/copilot-country/i-copilot-country";
+import { CopilotCountryClient } from "./src/models/copilot-country/copilot-country-client";
+export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, ILogo, ITuitionFee, IEnglishRequirements, IInternalLink, IDotDigitalProgramme, DotdigitalProgrammeClient, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISearchCountryFaq, PublicSearchCountryFaqClient, ISitemapCountryInfo, SitemapCountriesInfoClient, IDegreeInfo, ISitemapCountryDegreeInfo, SitemapCountryDegreeInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, IDotDigitalOrganisation, DotdigitalOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, IOrganisationSearchDocument, OrganisationSearchDocumentClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, IScholarshipCard, PublicScholarshipCardClient, IRankingCards, IRankingCard, IRanking, PublicRankingCardsClient, ICompareProgramme, CompareProgrammeClient, PortalType, PortalMap, ModelClient, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, OrganisationCardClient, ICopilotProgramme, ICopilotCountry, CopilotProgrammeClient, CopilotCountryClient };

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrganisationCardClient = exports.PublicOrganisationForSearchClient = exports.ModelClient = exports.PortalType = exports.CompareProgrammeClient = exports.PublicRankingCardsClient = exports.PublicScholarshipCardClient = exports.SitemapCitiesInfoClient = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = exports.OrganisationSearchDocumentClient = exports.SitemapOrganisationsInfoClient = exports.DotdigitalOrganisationClient = exports.SitemapDisciplinesInfoClient = exports.PublicSearchDisciplineClient = exports.SitemapCountryDegreeInfoClient = exports.SitemapCountriesInfoClient = exports.PublicSearchCountryFaqClient = exports.SitemapProgrammeInfoClient = exports.DotdigitalProgrammeClient = exports.BestfitProgrammeClient = exports.SearchProjectionClient = exports.ProgrammeCardClient = exports.PropertyNotAvailableException = exports.NotFoundException = exports.InternalServerException = exports.ClientException = exports.BadRequestException = void 0;
+exports.CopilotCountryClient = exports.CopilotProgrammeClient = exports.OrganisationCardClient = exports.PublicOrganisationForSearchClient = exports.ModelClient = exports.PortalType = exports.CompareProgrammeClient = exports.PublicRankingCardsClient = exports.PublicScholarshipCardClient = exports.SitemapCitiesInfoClient = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = exports.OrganisationSearchDocumentClient = exports.SitemapOrganisationsInfoClient = exports.DotdigitalOrganisationClient = exports.SitemapDisciplinesInfoClient = exports.PublicSearchDisciplineClient = exports.SitemapCountryDegreeInfoClient = exports.SitemapCountriesInfoClient = exports.PublicSearchCountryFaqClient = exports.SitemapProgrammeInfoClient = exports.DotdigitalProgrammeClient = exports.BestfitProgrammeClient = exports.SearchProjectionClient = exports.ProgrammeCardClient = exports.PropertyNotAvailableException = exports.NotFoundException = exports.InternalServerException = exports.ClientException = exports.BadRequestException = void 0;
 const bad_request_exception_1 = require("./src/exceptions/bad-request-exception");
 Object.defineProperty(exports, "BadRequestException", { enumerable: true, get: function () { return bad_request_exception_1.BadRequestException; } });
 const client_exception_1 = require("./src/exceptions/client-exception");
@@ -57,4 +57,8 @@ const compare_programme_client_1 = require("./src/models/compare-programme/compa
 Object.defineProperty(exports, "CompareProgrammeClient", { enumerable: true, get: function () { return compare_programme_client_1.CompareProgrammeClient; } });
 const public_organisation_for_search_client_1 = require("./src/models/organisation-for-search/public-organisation-for-search-client");
 Object.defineProperty(exports, "PublicOrganisationForSearchClient", { enumerable: true, get: function () { return public_organisation_for_search_client_1.PublicOrganisationForSearchClient; } });
+const copilot_programme_client_1 = require("./src/models/copilot-programme/copilot-programme-client");
+Object.defineProperty(exports, "CopilotProgrammeClient", { enumerable: true, get: function () { return copilot_programme_client_1.CopilotProgrammeClient; } });
+const copilot_country_client_1 = require("./src/models/copilot-country/copilot-country-client");
+Object.defineProperty(exports, "CopilotCountryClient", { enumerable: true, get: function () { return copilot_country_client_1.CopilotCountryClient; } });
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AAgF3E,oGAhFQ,2CAAmB,OAgFR;AA/EpB,wEAAmE;AAgFlE,gGAhFQ,kCAAe,OAgFR;AA/EhB,0FAAoF;AAgFnF,wGAhFQ,mDAAuB,OAgFR;AA/ExB,8EAAwE;AAgFvE,kGAhFQ,uCAAiB,OAgFR;AA/ElB,wGAAiG;AAgFhG,8GAhFQ,gEAA6B,OAgFR;AAnE9B,6FAAwF;AAgFvF,oGAhFQ,2CAAmB,OAgFR;AAzEpB,sGAAiG;AAgFhG,uGAhFQ,iDAAsB,OAgFR;AA5EvB,sGAAiG;AAgFhG,uGAhFQ,iDAAsB,OAgFR;AA1EvB,+GAA0G;AAgFzG,0GAhFQ,uDAAyB,OAgFR;AA9E1B,qHAA+G;AAgF9G,2GAhFQ,0DAA0B,OAgFR;AA9E3B,uHAAgH;AAgF/G,6GAhFQ,+DAA4B,OAgFR;AA9E7B,qHAA+G;AAgF9G,2GAhFQ,0DAA0B,OAgFR;AA7E3B,oIAA6H;AAgF5H,+GAhFQ,mEAA8B,OAgFR;AA9E/B,oHAA8G;AAgF7G,6GAhFQ,8DAA4B,OAgFR;AA9E7B,2HAAqH;AAgFpH,6GAhFQ,8DAA4B,OAgFR;AA3E7B,wHAAmH;AAgFlH,6GAhFQ,6DAA4B,OAgFR;AA9E7B,iIAA2H;AAgF1H,+GAhFQ,kEAA8B,OAgFR;AA9E/B,sGAAiG;AAqGhG,uGArGQ,iDAAsB,OAqGR;AAnGvB,uIAAiI;AA8EhI,iHA9EQ,sEAAgC,OA8ER;AA5EjC,kHAA4G;AA8E3G,0GA9EQ,wDAAyB,OA8ER;AA5E1B,kHAA4G;AA8E3G,0GA9EQ,wDAAyB,OA8ER;AA5E1B,4GAAsG;AA8ErG,wGA9EQ,oDAAuB,OA8ER;AA5ExB,iHAA2G;AA8E1G,4GA9EQ,4DAA2B,OA8ER;AA1E5B,wGAAkG;AA8EjG,yGA9EQ,sDAAwB,OA8ER;AA7EzB,yDAAqD;AAgFpD,2FAhFQ,wBAAU,OAgFR;AA9EX,qDAAiD;AAgFhD,4FAhFQ,0BAAW,OAgFR;AA9EZ,sGAAgG;AA2E/F,uGA3EQ,iDAAsB,OA2ER;AAzEvB,sIAA8H;AA8E7H,kHA9EQ,yEAAiC,OA8ER"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AAoF3E,oGApFQ,2CAAmB,OAoFR;AAnFpB,wEAAmE;AAoFlE,gGApFQ,kCAAe,OAoFR;AAnFhB,0FAAoF;AAoFnF,wGApFQ,mDAAuB,OAoFR;AAnFxB,8EAAwE;AAoFvE,kGApFQ,uCAAiB,OAoFR;AAnFlB,wGAAiG;AAoFhG,8GApFQ,gEAA6B,OAoFR;AAvE9B,6FAAwF;AAoFvF,oGApFQ,2CAAmB,OAoFR;AA7EpB,sGAAiG;AAoFhG,uGApFQ,iDAAsB,OAoFR;AAhFvB,sGAAiG;AAoFhG,uGApFQ,iDAAsB,OAoFR;AA9EvB,+GAA0G;AAoFzG,0GApFQ,uDAAyB,OAoFR;AAlF1B,qHAA+G;AAoF9G,2GApFQ,0DAA0B,OAoFR;AAlF3B,uHAAgH;AAoF/G,6GApFQ,+DAA4B,OAoFR;AAlF7B,qHAA+G;AAoF9G,2GApFQ,0DAA0B,OAoFR;AAjF3B,oIAA6H;AAoF5H,+GApFQ,mEAA8B,OAoFR;AAlF/B,oHAA8G;AAoF7G,6GApFQ,8DAA4B,OAoFR;AAlF7B,2HAAqH;AAoFpH,6GApFQ,8DAA4B,OAoFR;AA/E7B,wHAAmH;AAoFlH,6GApFQ,6DAA4B,OAoFR;AAlF7B,iIAA2H;AAoF1H,+GApFQ,kEAA8B,OAoFR;AAlF/B,sGAAiG;AAyGhG,uGAzGQ,iDAAsB,OAyGR;AAvGvB,uIAAiI;AAkFhI,iHAlFQ,sEAAgC,OAkFR;AAhFjC,kHAA4G;AAkF3G,0GAlFQ,wDAAyB,OAkFR;AAhF1B,kHAA4G;AAkF3G,0GAlFQ,wDAAyB,OAkFR;AAhF1B,4GAAsG;AAkFrG,wGAlFQ,oDAAuB,OAkFR;AAhFxB,iHAA2G;AAkF1G,4GAlFQ,4DAA2B,OAkFR;AA9E5B,wGAAkG;AAkFjG,yGAlFQ,sDAAwB,OAkFR;AAjFzB,yDAAqD;AAoFpD,2FApFQ,wBAAU,OAoFR;AAlFX,qDAAiD;AAoFhD,4FApFQ,0BAAW,OAoFR;AAlFZ,sGAAgG;AA+E/F,uGA/EQ,iDAAsB,OA+ER;AA7EvB,sIAA8H;AAkF7H,kHAlFQ,yEAAiC,OAkFR;AAhFlC,sGAAgG;AAqF/F,uGArFQ,iDAAsB,OAqFR;AAnFvB,gGAA0F;AAoFzF,qGApFQ,6CAAoB,OAoFR"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studyportals/domain-client",
-  "version": "3.32.0-organisations.0",
+  "version": "3.34.0",
   "description": "Responsible for fetching data from the Domain API",
   "main": "index.js",
   "author": "StudyPortals B.V.",

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"copilot-country-client.js","sourceRoot":"","sources":["../../../../src/models/copilot-country/copilot-country-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,oBAAqB,SAAQ,0BAA4B;IAC3D,YAAY;QACrB,OAAO,iBAAiB,CAAC;IAC1B,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,oDAYC"}

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

@@ -0,0 +1,32 @@
+export interface ICopilotCountry {
+    /**
+     * How to apply in country x text
+     *
+     * @return string | null
+     */
+    getHowToApplyText(): string | null;
+    /**
+     * Id of the country.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * ISO code ALPHA-2
+     *
+     * @return string
+     */
+    getIsoCode(): string;
+    /**
+     * Country title
+     *
+     * @return string
+     */
+    getTitle(): string;
+    /**
+     * Why study in country x text
+     *
+     * @return string | null
+     */
+    getWhyText(): string | null;
+}

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

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

package/src/models/copilot-country/i-copilot-country.js.map

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

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

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

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

@@ -0,0 +1,17 @@
+"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;
+//# sourceMappingURL=copilot-programme-client.js.map

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

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

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

@@ -0,0 +1,92 @@
+import { IEnglishRequirements, IGeoTargetingValues, IInternalLink, ITiming, ITuitionValues } from "../../..";
+export interface ICopilotProgramme {
+    /**
+     * Get country the programme is teached in
+     *
+     * @return number[]
+     */
+    getCountryIds(): number[];
+    /**
+     * Get discipline ids attached to this programme
+     *
+     * @return number[]
+     */
+    getDisciplineIds(): number[];
+    /**
+     * Education level
+     *
+     * @return string
+     */
+    getEducationalLevel(): string;
+    /**
+     * English level requirements.
+     *
+     * @return IEnglishRequirements
+     */
+    getEnglishRequirements(): IEnglishRequirements;
+    getGeneralRequirements(): string | null;
+    /**
+     * Get geotargetting settings for the programme
+     *
+     * @return IGeoTargetingValues
+     */
+    getGeoTargetingValues(): IGeoTargetingValues;
+    getGlobalUniversityRanking(): string | null;
+    /**
+     * Id of the programme.
+     *
+     * @return number
+     */
+    getId(): number;
+    /**
+     * 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;
+    /**
+     * University title
+     *
+     * @return string
+     */
+    getUniversityTitle(): string;
+    /**
+     * Is programme public
+     *
+     * @return boolean
+     */
+    isPublic(): boolean;
+}

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

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

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

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

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

@@ -13,6 +13,7 @@ export interface IOrganisationSearchDocument {
     getOrganisationId(): number;
     /**
      * Gets the premium type of the organisation
+     *
      * @return string | null
      */
     getPremiumType(): string | null;
@@ -42,24 +43,34 @@ export interface IOrganisationSearchDocument {
     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[];
+    /**
+     * Returns true when the organisation does not have a parent organisation
+     *
+     * @return boolean
+     */
+    isMainOrganisation(): boolean;
     /**
      * Indicates whether the organisation is published or not
      *