@studyportals/domain-client 3.16.0 → 3.16.1-beta.0

package/index.d.ts

@@ -61,9 +61,12 @@ import { ISitemapCityInfo } from "./src/models/sitemap-cities-info/i-sitemap-cit
 import { SitemapCitiesInfoClient } from "./src/models/sitemap-cities-info/sitemap-cities-info-client";
 import { IScholarshipCard } from "./src/models/scholarship-card/i-scholarship-card";
 import { PublicScholarshipCardClient } from "./src/models/scholarship-card/public-scholarship-card-client";
+import { IRankingCard } from './src/models/ranking-card/i-ranking-card';
+import { IRanking } from './src/models/ranking-card/i-ranking';
+import { PublicRankingCardClient } from './src/models/ranking-card/public-ranking-card-client';
 import { PortalType } from "./src/types/portal-type";
 import { PortalMap } from "./src/types/portal-map";
 import { ModelClient } from "./src/model-client";
 import { ICompareProgramme } from "./src/models/compare-programme/i-compare-programme";
 import { CompareProgrammeClient } from "./src/models/compare-programme/compare-programme-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, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, IScholarshipCard, PublicScholarshipCardClient, ICompareProgramme, CompareProgrammeClient, PortalType, PortalMap, ModelClient };
+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, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, IScholarshipCard, PublicScholarshipCardClient, IRankingCard, IRanking, PublicRankingCardClient, ICompareProgramme, CompareProgrammeClient, PortalType, PortalMap, ModelClient };

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelClient = exports.PortalType = exports.CompareProgrammeClient = exports.PublicScholarshipCardClient = exports.SitemapCitiesInfoClient = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = 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.ModelClient = exports.PortalType = exports.CompareProgrammeClient = exports.PublicRankingCardClient = exports.PublicScholarshipCardClient = exports.SitemapCitiesInfoClient = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = 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");
@@ -43,6 +43,8 @@ const sitemap_cities_info_client_1 = require("./src/models/sitemap-cities-info/s
 Object.defineProperty(exports, "SitemapCitiesInfoClient", { enumerable: true, get: function () { return sitemap_cities_info_client_1.SitemapCitiesInfoClient; } });
 const public_scholarship_card_client_1 = require("./src/models/scholarship-card/public-scholarship-card-client");
 Object.defineProperty(exports, "PublicScholarshipCardClient", { enumerable: true, get: function () { return public_scholarship_card_client_1.PublicScholarshipCardClient; } });
+const public_ranking_card_client_1 = require("./src/models/ranking-card/public-ranking-card-client");
+Object.defineProperty(exports, "PublicRankingCardClient", { enumerable: true, get: function () { return public_ranking_card_client_1.PublicRankingCardClient; } });
 const portal_type_1 = require("./src/types/portal-type");
 Object.defineProperty(exports, "PortalType", { enumerable: true, get: function () { return portal_type_1.PortalType; } });
 const model_client_1 = require("./src/model-client");

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AAsE3E,oGAtEQ,2CAAmB,OAsER;AArEpB,wEAAmE;AAsElE,gGAtEQ,kCAAe,OAsER;AArEhB,0FAAoF;AAsEnF,wGAtEQ,mDAAuB,OAsER;AArExB,8EAAwE;AAsEvE,kGAtEQ,uCAAiB,OAsER;AArElB,wGAAiG;AAsEhG,8GAtEQ,gEAA6B,OAsER;AAzD9B,6FAAwF;AAsEvF,oGAtEQ,2CAAmB,OAsER;AA/DpB,sGAAiG;AAsEhG,uGAtEQ,iDAAsB,OAsER;AAlEvB,sGAAiG;AAsEhG,uGAtEQ,iDAAsB,OAsER;AAhEvB,+GAA0G;AAsEzG,0GAtEQ,uDAAyB,OAsER;AApE1B,qHAA+G;AAsE9G,2GAtEQ,0DAA0B,OAsER;AApE3B,uHAAgH;AAsE/G,6GAtEQ,+DAA4B,OAsER;AApE7B,qHAA+G;AAsE9G,2GAtEQ,0DAA0B,OAsER;AAnE3B,oIAA6H;AAsE5H,+GAtEQ,mEAA8B,OAsER;AApE/B,oHAA8G;AAsE7G,6GAtEQ,8DAA4B,OAsER;AApE7B,2HAAqH;AAsEpH,6GAtEQ,8DAA4B,OAsER;AAjE7B,wHAAmH;AAsElH,6GAtEQ,6DAA4B,OAsER;AApE7B,iIAA2H;AAsE1H,+GAtEQ,kEAA8B,OAsER;AApE/B,kHAA4G;AAsE3G,0GAtEQ,wDAAyB,OAsER;AApE1B,kHAA4G;AAsE3G,0GAtEQ,wDAAyB,OAsER;AApE1B,4GAAsG;AAsErG,wGAtEQ,oDAAuB,OAsER;AApExB,iHAA2G;AAsE1G,4GAtEQ,4DAA2B,OAsER;AArE5B,yDAAqD;AAwEpD,2FAxEQ,wBAAU,OAwER;AAtEX,qDAAiD;AAwEhD,4FAxEQ,0BAAW,OAwER;AAtEZ,sGAAgG;AAmE/F,uGAnEQ,iDAAsB,OAmER"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AAyE3E,oGAzEQ,2CAAmB,OAyER;AAxEpB,wEAAmE;AAyElE,gGAzEQ,kCAAe,OAyER;AAxEhB,0FAAoF;AAyEnF,wGAzEQ,mDAAuB,OAyER;AAxExB,8EAAwE;AAyEvE,kGAzEQ,uCAAiB,OAyER;AAxElB,wGAAiG;AAyEhG,8GAzEQ,gEAA6B,OAyER;AA5D9B,6FAAwF;AAyEvF,oGAzEQ,2CAAmB,OAyER;AAlEpB,sGAAiG;AAyEhG,uGAzEQ,iDAAsB,OAyER;AArEvB,sGAAiG;AAyEhG,uGAzEQ,iDAAsB,OAyER;AAnEvB,+GAA0G;AAyEzG,0GAzEQ,uDAAyB,OAyER;AAvE1B,qHAA+G;AAyE9G,2GAzEQ,0DAA0B,OAyER;AAvE3B,uHAAgH;AAyE/G,6GAzEQ,+DAA4B,OAyER;AAvE7B,qHAA+G;AAyE9G,2GAzEQ,0DAA0B,OAyER;AAtE3B,oIAA6H;AAyE5H,+GAzEQ,mEAA8B,OAyER;AAvE/B,oHAA8G;AAyE7G,6GAzEQ,8DAA4B,OAyER;AAvE7B,2HAAqH;AAyEpH,6GAzEQ,8DAA4B,OAyER;AApE7B,wHAAmH;AAyElH,6GAzEQ,6DAA4B,OAyER;AAvE7B,iIAA2H;AAyE1H,+GAzEQ,kEAA8B,OAyER;AAvE/B,kHAA4G;AAyE3G,0GAzEQ,wDAAyB,OAyER;AAvE1B,kHAA4G;AAyE3G,0GAzEQ,wDAAyB,OAyER;AAvE1B,4GAAsG;AAyErG,wGAzEQ,oDAAuB,OAyER;AAvExB,iHAA2G;AAyE1G,4GAzEQ,4DAA2B,OAyER;AAtE5B,qGAA+F;AAyE9F,wGAzEQ,oDAAuB,OAyER;AAxExB,yDAAqD;AA2EpD,2FA3EQ,wBAAU,OA2ER;AAzEX,qDAAiD;AA2EhD,4FA3EQ,0BAAW,OA2ER;AAzEZ,sGAAgG;AAsE/F,uGAtEQ,iDAAsB,OAsER"}

package/package.json

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

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

@@ -0,0 +1,57 @@
+import { IRanking } from "./i-ranking";
+export interface IRankingCard {
+    /**
+     * Get the organisation city.
+     *
+     * @return string | null
+     */
+    getOrganisationCity(): string | null;
+    /**
+     * Get the organisation country.
+     *
+     * @return string | null
+     */
+    getOrganisationCountry(): string | null;
+    /**
+     * Get the organisation id.
+     *
+     * @return number
+     */
+    getOrganisationId(): number;
+    /**
+     * Get the organisation logo url.
+     *
+     * @return string | null
+     */
+    getOrganisationLogoUrl(): string | null;
+    /**
+     * Get the organisation name.
+     *
+     * @return string | null
+     */
+    getOrganisationName(): string | null;
+    /**
+     * Get the organisation homepage link.
+     *
+     * @return string | null
+     */
+    getOrganisationPageUrl(): string | null;
+    /**
+     * Get the position for the organisation in the Studyportals ranking.
+     *
+     * @return number | null
+     */
+    getPosition(): number | null;
+    /**
+     * Get this organisation's ranked position for each available ranking.
+     *
+     * @return IRanking[]
+     */
+    getRankings(): IRanking[];
+    /**
+     * Verifies if the organisation's logo can be displayed.
+     *
+     * @return boolean
+     */
+    hasOrganisationLogo(): boolean;
+}

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

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

package/src/models/ranking-card/i-ranking-card.js.map

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

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

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

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

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

package/src/models/ranking-card/i-ranking.js.map

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

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

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

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

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

package/src/models/ranking-card/public-ranking-card-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"public-ranking-card-client.js","sourceRoot":"","sources":["../../../../src/models/ranking-card/public-ranking-card-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,uBAAwB,SAAQ,0BAAyB;IAC3D,YAAY;QACrB,OAAO,cAAc,CAAC;IACvB,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AAZD,0DAYC"}