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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -61,12 +61,13 @@ import { ISitemapCityInfo } from "./src/models/sitemap-cities-info/i-sitemap-cit
61
61
  import { SitemapCitiesInfoClient } from "./src/models/sitemap-cities-info/sitemap-cities-info-client";
62
62
  import { IScholarshipCard } from "./src/models/scholarship-card/i-scholarship-card";
63
63
  import { PublicScholarshipCardClient } from "./src/models/scholarship-card/public-scholarship-card-client";
64
- import { IRankingCard } from './src/models/ranking-card/i-ranking-card';
65
- import { IRanking } from './src/models/ranking-card/i-ranking';
66
- import { PublicRankingCardClient } from './src/models/ranking-card/public-ranking-card-client';
64
+ import { IRankingCards } from './src/models/ranking-cards/i-ranking-cards';
65
+ import { IRankingCard } from './src/models/ranking-cards/i-ranking-card';
66
+ import { IRanking } from './src/models/ranking-cards/i-ranking';
67
+ import { PublicRankingCardsClient } from './src/models/ranking-cards/public-ranking-cards-client';
67
68
  import { PortalType } from "./src/types/portal-type";
68
69
  import { PortalMap } from "./src/types/portal-map";
69
70
  import { ModelClient } from "./src/model-client";
70
71
  import { ICompareProgramme } from "./src/models/compare-programme/i-compare-programme";
71
72
  import { CompareProgrammeClient } from "./src/models/compare-programme/compare-programme-client";
72
- 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 };
73
+ 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, IRankingCards, IRankingCard, IRanking, PublicRankingCardsClient, ICompareProgramme, CompareProgrammeClient, PortalType, PortalMap, ModelClient };
package/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- 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;
3
+ exports.ModelClient = exports.PortalType = exports.CompareProgrammeClient = exports.PublicRankingCardsClient = 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;
4
4
  const bad_request_exception_1 = require("./src/exceptions/bad-request-exception");
5
5
  Object.defineProperty(exports, "BadRequestException", { enumerable: true, get: function () { return bad_request_exception_1.BadRequestException; } });
6
6
  const client_exception_1 = require("./src/exceptions/client-exception");
@@ -43,8 +43,8 @@ const sitemap_cities_info_client_1 = require("./src/models/sitemap-cities-info/s
43
43
  Object.defineProperty(exports, "SitemapCitiesInfoClient", { enumerable: true, get: function () { return sitemap_cities_info_client_1.SitemapCitiesInfoClient; } });
44
44
  const public_scholarship_card_client_1 = require("./src/models/scholarship-card/public-scholarship-card-client");
45
45
  Object.defineProperty(exports, "PublicScholarshipCardClient", { enumerable: true, get: function () { return public_scholarship_card_client_1.PublicScholarshipCardClient; } });
46
- const public_ranking_card_client_1 = require("./src/models/ranking-card/public-ranking-card-client");
47
- Object.defineProperty(exports, "PublicRankingCardClient", { enumerable: true, get: function () { return public_ranking_card_client_1.PublicRankingCardClient; } });
46
+ const public_ranking_cards_client_1 = require("./src/models/ranking-cards/public-ranking-cards-client");
47
+ Object.defineProperty(exports, "PublicRankingCardsClient", { enumerable: true, get: function () { return public_ranking_cards_client_1.PublicRankingCardsClient; } });
48
48
  const portal_type_1 = require("./src/types/portal-type");
49
49
  Object.defineProperty(exports, "PortalType", { enumerable: true, get: function () { return portal_type_1.PortalType; } });
50
50
  const model_client_1 = require("./src/model-client");
package/index.js.map CHANGED
@@ -1 +1 @@
1
- {"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"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AA0E3E,oGA1EQ,2CAAmB,OA0ER;AAzEpB,wEAAmE;AA0ElE,gGA1EQ,kCAAe,OA0ER;AAzEhB,0FAAoF;AA0EnF,wGA1EQ,mDAAuB,OA0ER;AAzExB,8EAAwE;AA0EvE,kGA1EQ,uCAAiB,OA0ER;AAzElB,wGAAiG;AA0EhG,8GA1EQ,gEAA6B,OA0ER;AA7D9B,6FAAwF;AA0EvF,oGA1EQ,2CAAmB,OA0ER;AAnEpB,sGAAiG;AA0EhG,uGA1EQ,iDAAsB,OA0ER;AAtEvB,sGAAiG;AA0EhG,uGA1EQ,iDAAsB,OA0ER;AApEvB,+GAA0G;AA0EzG,0GA1EQ,uDAAyB,OA0ER;AAxE1B,qHAA+G;AA0E9G,2GA1EQ,0DAA0B,OA0ER;AAxE3B,uHAAgH;AA0E/G,6GA1EQ,+DAA4B,OA0ER;AAxE7B,qHAA+G;AA0E9G,2GA1EQ,0DAA0B,OA0ER;AAvE3B,oIAA6H;AA0E5H,+GA1EQ,mEAA8B,OA0ER;AAxE/B,oHAA8G;AA0E7G,6GA1EQ,8DAA4B,OA0ER;AAxE7B,2HAAqH;AA0EpH,6GA1EQ,8DAA4B,OA0ER;AArE7B,wHAAmH;AA0ElH,6GA1EQ,6DAA4B,OA0ER;AAxE7B,iIAA2H;AA0E1H,+GA1EQ,kEAA8B,OA0ER;AAxE/B,kHAA4G;AA0E3G,0GA1EQ,wDAAyB,OA0ER;AAxE1B,kHAA4G;AA0E3G,0GA1EQ,wDAAyB,OA0ER;AAxE1B,4GAAsG;AA0ErG,wGA1EQ,oDAAuB,OA0ER;AAxExB,iHAA2G;AA0E1G,4GA1EQ,4DAA2B,OA0ER;AAtE5B,wGAAkG;AA0EjG,yGA1EQ,sDAAwB,OA0ER;AAzEzB,yDAAqD;AA4EpD,2FA5EQ,wBAAU,OA4ER;AA1EX,qDAAiD;AA4EhD,4FA5EQ,0BAAW,OA4ER;AA1EZ,sGAAgG;AAuE/F,uGAvEQ,iDAAsB,OAuER"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@studyportals/domain-client",
3
- "version": "3.16.1-beta.0",
3
+ "version": "3.16.1-beta.2",
4
4
  "description": "Responsible for fetching data from the Domain API",
5
5
  "main": "bin/index.js",
6
6
  "author": "StudyPortals B.V.",
@@ -1,4 +1,4 @@
1
- import { IRanking } from "./i-ranking";
1
+ import { IRanking } from "../../..";
2
2
  export interface IRankingCard {
3
3
  /**
4
4
  * Get the organisation city.
@@ -42,6 +42,12 @@ export interface IRankingCard {
42
42
  * @return number | null
43
43
  */
44
44
  getPosition(): number | null;
45
+ /**
46
+ * Get the year the organisation was ranked.
47
+ *
48
+ * @return string | null
49
+ */
50
+ getRankingYear(): string | null;
45
51
  /**
46
52
  * Get this organisation's ranked position for each available ranking.
47
53
  *
@@ -0,0 +1 @@
1
+ {"version":3,"file":"i-ranking-card.js","sourceRoot":"","sources":["../../../../src/models/ranking-cards/i-ranking-card.ts"],"names":[],"mappings":""}
@@ -0,0 +1,15 @@
1
+ import { IRankingCard } from "../../..";
2
+ export interface IRankingCards {
3
+ /**
4
+ * Retrieves the id of the collection.
5
+ *
6
+ * @return number
7
+ */
8
+ getId(): number;
9
+ /**
10
+ * Retrieves the collection of ranking cards.
11
+ *
12
+ * @return IRankingCard[]
13
+ */
14
+ getRankingCards(): IRankingCard[];
15
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=i-ranking-cards.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"i-ranking-cards.js","sourceRoot":"","sources":["../../../../src/models/ranking-cards/i-ranking-cards.ts"],"names":[],"mappings":""}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"i-ranking.js","sourceRoot":"","sources":["../../../../src/models/ranking-cards/i-ranking.ts"],"names":[],"mappings":""}
@@ -1,6 +1,6 @@
1
- import { IRankingCard } from "./i-ranking-card";
1
+ import { IRankingCards } from "../../..";
2
2
  import { ModelClient } from "../../model-client";
3
- export declare class PublicRankingCardClient extends ModelClient<IRankingCard> {
3
+ export declare class PublicRankingCardsClient extends ModelClient<IRankingCards> {
4
4
  protected getModelName(): string;
5
5
  protected getVersion(): string;
6
6
  isPublic(): boolean;
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PublicRankingCardsClient = void 0;
4
+ const model_client_1 = require("../../model-client");
5
+ class PublicRankingCardsClient extends model_client_1.ModelClient {
6
+ getModelName() {
7
+ return 'ranking-cards';
8
+ }
9
+ getVersion() {
10
+ return 'v1';
11
+ }
12
+ isPublic() {
13
+ return true;
14
+ }
15
+ }
16
+ exports.PublicRankingCardsClient = PublicRankingCardsClient;
17
+ //# sourceMappingURL=public-ranking-cards-client.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"public-ranking-cards-client.js","sourceRoot":"","sources":["../../../../src/models/ranking-cards/public-ranking-cards-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,wBAAyB,SAAQ,0BAA0B;IAC7D,YAAY;QACrB,OAAO,eAAe,CAAC;IACxB,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AAZD,4DAYC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"i-ranking-card.js","sourceRoot":"","sources":["../../../../src/models/ranking-card/i-ranking-card.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
1
- {"version":3,"file":"i-ranking.js","sourceRoot":"","sources":["../../../../src/models/ranking-card/i-ranking.ts"],"names":[],"mappings":""}
@@ -1,17 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PublicRankingCardClient = void 0;
4
- const model_client_1 = require("../../model-client");
5
- class PublicRankingCardClient extends model_client_1.ModelClient {
6
- getModelName() {
7
- return 'ranking-card';
8
- }
9
- getVersion() {
10
- return 'v1';
11
- }
12
- isPublic() {
13
- return true;
14
- }
15
- }
16
- exports.PublicRankingCardClient = PublicRankingCardClient;
17
- //# sourceMappingURL=public-ranking-card-client.js.map
@@ -1 +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"}